on develop help sign in
.github/workflows/haskell.ymlnew file+41
since splitsnapshots
unifiedsplit
@@ -0,0 +1,41 @@
1+name: github-action
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+ strategy:
8+ matrix:
9+ ghc: ['8.4.4', '8.6.5', '8.8.4', '8.10.2']
10+ os: ['ubuntu-latest', 'macos-latest']
11+ runs-on: ${{ matrix.os }}
12+
13+ name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
14+ steps:
15+ - uses: actions/checkout@v2
16+ - uses: actions/setup-haskell@v1
17+ with:
18+ ghc-version: ${{ matrix.ghc }}
19+ - name: Cache
20+ uses: actions/cache@v1
21+ env:
22+ cache-name: cache-cabal
23+ with:
24+ path: ~/.cabal
25+ key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
26+ restore-keys: |
27+ ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
28+ ${{ runner.os }}-${{ matrix.ghc }}-build-
29+ ${{ runner.os }}-${{ matrix.ghc }}-
30+ ${{ runner.os }}
31+
32+ - name: Install dependencies
33+ run: |
34+ cabal update
35+ cabal build --only-dependencies --enable-tests --enable-benchmarks
36+ - name: Build
37+ run: cabal build --enable-tests --enable-benchmarks all
38+ - name: Run tests
39+ run: cabal test all
40+ - name: Build Docs
41+ run: cabal haddock
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+31−10
@@ -54,18 +54,19 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
54[ ] difference :: Event a -> Event b -> Event a
54[ ] difference :: Event a -> Event b -> Event a
55[ ] align :: Event a -> Event b -> Event (These a b)
55[ ] align :: Event a -> Event b -> Event (These a b)
56[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
56[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
57+ -- Note align functions from Data.Align in semialign package
57[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
58[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
58[ ] leftmost :: [Event a] -> Event a
59[ ] leftmost :: [Event a] -> Event a
59[ ] mergeList :: [Event a] -> Event (NonEmpty a)
60[ ] 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)
61[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
62[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
62
63
63-- Efficient one-to-many fanout
64-- Efficient one-to-many fanout
64−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
65+[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
65−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
66+[ ] fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
66−[ ] select :: EventSelector k -> k a -> Event a
67+[ ] select :: EventSelector k -> k a -> Event a
67−[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
68+[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
68−[ ] fanThese :: Event (These a b) -> (Event a, Event b)
69+[ ] fanThese :: Event (These a b) -> (Event a, Event b)
69
70
70-- Event to Event via function that can sample current values
71-- Event to Event via function that can sample current values
71[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
72[ ] 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
166-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
167[ ] switch :: Behavior (Event a) -> Event a
168[ ] switch :: Behavior (Event a) -> Event a
168
169
169−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
170[ ] switchDyn :: Dynamic (Event a) -> Event a
171[ ] switchDyn :: Dynamic (Event a) -> Event a
171
172
172-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
@@ -198,7 +199,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
198The functions mentioned above are used to create a static FRP network.
199The functions mentioned above are used to create a static FRP network.
199There 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.
200There 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.
200
201
201−Th typeclasses and their associated annotations include:
202+The typeclasses and their associated annotations include:
202
203
203- `PostBuild`
204- `PostBuild`
204 Fire an Event when an FRP network has been set up.
205 Fire an Event when an FRP network has been set up.
@@ -206,7 +207,7 @@ Th typeclasses and their associated annotations include:
206 [B] -- Function runs in any monad supporting PostBuild
207 [B] -- Function runs in any monad supporting PostBuild
207 ```
208 ```
208
209
209−- `Adjustable`
210+- `Adjustable`
210 Use Events to add or remove pieces of an FRP network.
211 Use Events to add or remove pieces of an FRP network.
211 ```haskell
212 ```haskell
212 [A] -- Function runs in any monad supporting Adjustable
213 [A] -- Function runs in any monad supporting Adjustable
@@ -271,7 +272,7 @@ Th typeclasses and their associated annotations include:
271```haskell
272```haskell
272-- Run side-effecting actions in Event when it occurs; returned Event contains
273-- Run side-effecting actions in Event when it occurs; returned Event contains
273-- results. Side effects run in the (Performable m) monad which is associated with
274-- 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.
275-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
276-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
276[P] performEvent :: Event (Performable m a ) -> m (Event a)
277[P] performEvent :: Event (Performable m a ) -> m (Event a)
277
278
@@ -292,3 +293,23 @@ Th typeclasses and their associated annotations include:
292[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
293[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
293```
294```
294
295
296+## Networks
297+
298+```haskell
299+-- Functions from Reflex.Adjustable / Reflex.Network used to deal with Dynamics/Events carrying (m a)
300+
301+[A] runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
302+
303+-- Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
304+-- The returned Event of network results occurs when the Dynamic does. Note: Often, the type a is an Event,
305+-- in which case the return value is an Event-of-Events that would typically be flattened (via switchHold).
306+[P,A] networkView :: Dynamic (m a) -> m (Event a)
307+
308+-- Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the
309+-- Event fires. The returned Dynamic of network results occurs when the Event does. Note: Often, the type a is an
310+-- Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
311+[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
312+
313+-- Render a placeholder network to be shown while another network is not yet done building
314+[P,A] untilReady :: m a -> m b -> m (a, Event b)
315+```
README.md+15−11
@@ -1,19 +1,23 @@
1−## Reflex
1+# [Reflex](https://reflex-frp.org/)
2−### Practical Functional Reactive Programming
3
2
4−Reflex is an fully-deterministic, higher-order Functional Reactive Programming (FRP) interface and an engine that efficiently implements that interface.
3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/reflex.svg)](https://hackage.haskell.org/package/reflex) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/reflex/badge)](https://matrix.hackage.haskell.org/#/package/reflex) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/reflex/blob/master/LICENSE)
5
4
6−[Reflex-DOM](https://github.com/reflex-frp/reflex-dom) is a framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
5+Interactive programs without callbacks or side-effects. Functional Reactive Programming (FRP) uses composable events and time-varying values to describe interactive systems as pure functions. Just like other pure functional code, functional reactive code is easier to get right on the first try, maintain, and reuse.
7
6
8−Comprehensive documentation is still a work in progress, but a tutorial for Reflex and Reflex-DOM is available at https://github.com/reflex-frp/reflex-platform and an introductory talk given at the New York Haskell Meetup is available here: [Part 1](https://www.youtube.com/watch?v=mYvkcskJbc4) / [Part 2](https://www.youtube.com/watch?v=3qfc9XFVo2c).
7+Reflex is a fully-deterministic, higher-order Functional Reactive Programming interface and an engine that efficiently implements that interface.
9
8
10−A summary of Reflex functions is available in the [quick reference](Quickref.md).
9+**Visit https://reflex-frp.org for more information, tutorials, documentation and [examples](https://examples.reflex-frp.org/).**
11
10
12−### Additional resources
11+## Resources
13−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
14
12
13+* [Official Website](https://reflex-frp.org)
14+* [Quick Reference](Quickref.md)
15+* [Reflex-DOM](https://github.com/reflex-frp/reflex-dom): A framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
16+* [Obelisk](https://github.com/obsidiansystems/obelisk#obelisk): A framework built on Reflex and Reflex-DOM for functional reactive web and mobile applications, with batteries included.
17+* [Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
15−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
18+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
19+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
16
20
17−[hackage](https://hackage.haskell.org/package/reflex)
21+## Hacking
18
22
19−[irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
23+From the root of a [Reflex Platform](https://github.com/reflex-frp/reflex-platform) checkout, run `./scripts/hack-on haskell-overlays/reflex-packages/dep/reflex`. This will check out the reflex source code into the `haskell-overlays/reflex-packages/dep/reflex` directory. You can then point that checkout at your fork, make changes, etc. Use the `./try-reflex` or `./scripts/work-on` scripts to start a shell in which you can test your changes.
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.jsondeleted−70
@@ -1,70 +0,0 @@
1−{ prs }:
2−
3−let
4− pkgs = import ./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.cabal+195−56
@@ -1,7 +1,17 @@
1Name: reflex
1Name: reflex
2−Version: 0.5
2+Version: 0.8.2.0
3Synopsis: Higher-order Functional Reactive Programming
3Synopsis: Higher-order Functional Reactive Programming
4+Description:
5+ Interactive programs without callbacks or side-effects.
6+ Functional Reactive Programming (FRP) uses composable events and time-varying
7+ values to describe interactive systems as pure functions.
8+ Just like other pure functional code, functional reactive code is easier
9+ to get right on the first try, maintain, and reuse.
10+ .
4−Description: Reflex is a high-performance, deterministic, higher-order Functional Reactive Programming system
11+ Reflex is a fully-deterministic, higher-order Functional Reactive Programming
12+ interface and an engine that efficiently implements that interface.
13+ .
14+ <https://reflex-frp.org>
5License: BSD3
15License: BSD3
6License-file: LICENSE
16License-file: LICENSE
7Author: Ryan Trinkle
17Author: Ryan Trinkle
@@ -9,9 +19,17 @@ Maintainer: ryan.trinkle@gmail.com
9Stability: Experimental
19Stability: Experimental
10Category: FRP
20Category: FRP
11Build-type: Simple
21Build-type: Simple
12−Cabal-version: >=1.9.2
22+Cabal-version: 1.22
13homepage: https://reflex-frp.org
23homepage: https://reflex-frp.org
14bug-reports: https://github.com/reflex-frp/reflex/issues
24bug-reports: https://github.com/reflex-frp/reflex/issues
25+extra-source-files:
26+ README.md
27+ Quickref.md
28+ ChangeLog.md
29+
30+tested-with:
31+ GHC ==8.4.4 || ==8.6.5 || ==8.8.1 || ==8.10.2,
32+ GHCJS ==8.6
15
33
16flag use-reflex-optimizer
34flag use-reflex-optimizer
17 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
35 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
@@ -33,41 +51,67 @@ flag fast-weak
33 default: False
51 default: False
34 manual: True
52 manual: True
35
53
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+
36library
69library
70+ default-language: Haskell2010
37 hs-source-dirs: src
71 hs-source-dirs: src
38 build-depends:
72 build-depends:
39 MemoTrie == 0.6.*,
73 MemoTrie == 0.6.*,
40− base >= 4.7 && < 4.13,
74+ base >= 4.11 && < 4.15,
41 bifunctors >= 5.2 && < 5.6,
75 bifunctors >= 5.2 && < 5.6,
42− comonad,
76+ comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
78+ constraints-extras >= 0.3 && < 0.4,
43− containers >= 0.5 && < 0.7,
79+ containers >= 0.6 && < 0.7,
44 data-default >= 0.5 && < 0.8,
80 data-default >= 0.5 && < 0.8,
45− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
46 exception-transformers == 0.4.*,
82 exception-transformers == 0.4.*,
47 lens >= 4.7 && < 5,
83 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
48 monad-control >= 1.0.1 && < 1.1,
85 monad-control >= 1.0.1 && < 1.1,
49− monoidal-containers == 0.4.*,
50 mtl >= 2.1 && < 2.3,
86 mtl >= 2.1 && < 2.3,
87+ patch >= 0.0.1 && < 0.1,
51− prim-uniq >= 0.1.0.1 && < 0.2,
88+ prim-uniq >= 0.1.0.1 && < 0.3,
52− primitive >= 0.5 && < 0.7,
89+ primitive >= 0.5 && < 0.8,
90+ profunctors >= 5.3 && < 5.7,
53 random == 1.1.*,
91 random == 1.1.*,
54 ref-tf == 0.4.*,
92 ref-tf == 0.4.*,
55 reflection == 2.1.*,
93 reflection == 2.1.*,
56 semigroupoids >= 4.0 && < 6,
94 semigroupoids >= 4.0 && < 6,
57− semigroups >= 0.16 && < 0.19,
58 stm >= 2.4 && < 2.6,
95 stm >= 2.4 && < 2.6,
59 syb >= 0.5 && < 0.8,
96 syb >= 0.5 && < 0.8,
60− these >= 0.4 && < 0.8,
61− time >= 1.4 && < 1.9,
97+ time >= 1.4 && < 1.10,
62− transformers >= 0.2,
98+ transformers >= 0.5.6.0 && < 0.6,
63− transformers-compat >= 0.3,
64− unbounded-delays >= 0.1.0.0 && < 0.2
99+ unbounded-delays >= 0.1.0.0 && < 0.2,
100+ witherable >= 0.3 && < 0.5
101+
102+ if flag(split-these)
103+ build-depends: these >= 1 && <1.2,
104+ semialign >=1 && <1.2,
105+ monoidal-containers >= 0.6 && < 0.7
106+ else
107+ build-depends: these >= 0.4 && <0.9,
108+ monoidal-containers == 0.4.0.0
65
109
66 exposed-modules:
110 exposed-modules:
111+ Control.Monad.ReaderIO
67 Data.AppendMap,
112 Data.AppendMap,
68 Data.FastMutableIntMap,
113 Data.FastMutableIntMap,
69 Data.FastWeakBag,
114 Data.FastWeakBag,
70− Data.Functor.Misc,
71 Data.Map.Misc,
115 Data.Map.Misc,
72 Data.WeakBag,
116 Data.WeakBag,
73 Reflex,
117 Reflex,
@@ -87,15 +131,9 @@ library
87 Reflex.FastWeak,
131 Reflex.FastWeak,
88 Reflex.FunctorMaybe,
132 Reflex.FunctorMaybe,
89 Reflex.Host.Class,
133 Reflex.Host.Class,
134+ Reflex.Host.Headless,
90 Reflex.Network,
135 Reflex.Network,
91 Reflex.NotReady.Class,
136 Reflex.NotReady.Class,
92− Reflex.Patch,
93− Reflex.Patch.Class,
94− Reflex.Patch.DMap,
95− Reflex.Patch.DMapWithMove,
96− Reflex.Patch.IntMap,
97− Reflex.Patch.Map,
98− Reflex.Patch.MapWithMove,
99 Reflex.PerformEvent.Base,
137 Reflex.PerformEvent.Base,
100 Reflex.PerformEvent.Class,
138 Reflex.PerformEvent.Class,
101 Reflex.PostBuild.Base,
139 Reflex.PostBuild.Base,
@@ -114,38 +152,57 @@ library
114 Reflex.Widget.Basic,
152 Reflex.Widget.Basic,
115 Reflex.Workflow
153 Reflex.Workflow
116
154
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+
117 ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
165 ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
118
166
119 if flag(debug-trace-events)
167 if flag(debug-trace-events)
120 cpp-options: -DDEBUG_TRACE_EVENTS
168 cpp-options: -DDEBUG_TRACE_EVENTS
121− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
122
171
123 if flag(use-reflex-optimizer)
172 if flag(use-reflex-optimizer)
124 cpp-options: -DUSE_REFLEX_OPTIMIZER
173 cpp-options: -DUSE_REFLEX_OPTIMIZER
125 build-depends: ghc
174 build-depends: ghc
126 exposed-modules: Reflex.Optimizer
175 exposed-modules: Reflex.Optimizer
127
176
177+ if flag(debug-propagation)
178+ cpp-options: -DDEBUG -DDEBUG_TRACE_PROPAGATION -DDEBUG_TRACE_INVALIDATION
179+
180+ if flag(debug-cycles)
181+ cpp-options: -DDEBUG_CYCLES
182+
128 if flag(use-template-haskell)
183 if flag(use-template-haskell)
129 cpp-options: -DUSE_TEMPLATE_HASKELL
184 cpp-options: -DUSE_TEMPLATE_HASKELL
130 build-depends:
185 build-depends:
131− dependent-sum >= 0.3 && < 0.5,
186+ dependent-sum >= 0.6 && < 0.8,
132− haskell-src-exts >= 1.16 && < 1.21,
187+ haskell-src-exts >= 1.16 && < 1.24,
133 haskell-src-meta >= 0.6 && < 0.9,
188 haskell-src-meta >= 0.6 && < 0.9,
134− template-haskell >= 2.9 && < 2.15
189+ template-haskell >= 2.9 && < 2.17
135 exposed-modules:
190 exposed-modules:
136 Reflex.Dynamic.TH
191 Reflex.Dynamic.TH
137 other-extensions: TemplateHaskell
192 other-extensions: TemplateHaskell
138 else
193 else
139 build-depends:
194 build-depends:
140− dependent-sum == 0.4.*
195+ dependent-sum >= 0.6 && < 0.8
141
196
142 if flag(fast-weak) && impl(ghcjs)
197 if flag(fast-weak) && impl(ghcjs)
143 cpp-options: -DGHCJS_FAST_WEAK
198 cpp-options: -DGHCJS_FAST_WEAK
144
199
145 if impl(ghcjs)
200 if impl(ghcjs)
146− build-depends: ghcjs-base
201+ build-depends:
202+ ghcjs-base == 0.2.*
147
203
148test-suite semantics
204test-suite semantics
205+ default-language: Haskell2010
149 type: exitcode-stdio-1.0
206 type: exitcode-stdio-1.0
150 main-is: semantics.hs
207 main-is: semantics.hs
151 hs-source-dirs: test
208 hs-source-dirs: test
@@ -154,14 +211,14 @@ test-suite semantics
154 base,
211 base,
155 bifunctors,
212 bifunctors,
156 containers,
213 containers,
157− deepseq >= 1.3 && < 1.5,
214+ deepseq,
158 dependent-map,
215 dependent-map,
159 dependent-sum,
216 dependent-sum,
160 mtl,
217 mtl,
161 ref-tf,
218 ref-tf,
162 reflex,
219 reflex,
163 split,
220 split,
164− transformers >= 0.3
221+ transformers
165 other-modules:
222 other-modules:
166 Reflex.Bench.Focused
223 Reflex.Bench.Focused
167 Reflex.Plan.Pure
224 Reflex.Plan.Pure
@@ -171,6 +228,7 @@ test-suite semantics
171 Reflex.TestPlan
228 Reflex.TestPlan
172
229
173test-suite CrossImpl
230test-suite CrossImpl
231+ default-language: Haskell2010
174 type: exitcode-stdio-1.0
232 type: exitcode-stdio-1.0
175 main-is: Reflex/Test/CrossImpl.hs
233 main-is: Reflex/Test/CrossImpl.hs
176 hs-source-dirs: test
234 hs-source-dirs: test
@@ -180,7 +238,7 @@ test-suite CrossImpl
180 containers,
238 containers,
181 dependent-map,
239 dependent-map,
182 dependent-sum,
240 dependent-sum,
183− deepseq >= 1.3 && < 1.5,
241+ deepseq,
184 mtl,
242 mtl,
185 transformers,
243 transformers,
186 ref-tf,
244 ref-tf,
@@ -192,6 +250,7 @@ test-suite CrossImpl
192 Reflex.Plan.Pure
250 Reflex.Plan.Pure
193
251
194test-suite hlint
252test-suite hlint
253+ default-language: Haskell2010
195 type: exitcode-stdio-1.0
254 type: exitcode-stdio-1.0
196 main-is: hlint.hs
255 main-is: hlint.hs
197 hs-source-dirs: test
256 hs-source-dirs: test
@@ -199,17 +258,21 @@ test-suite hlint
199 , directory
258 , directory
200 , filepath
259 , filepath
201 , filemanip
260 , filemanip
202− , 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
203 if impl(ghcjs)
265 if impl(ghcjs)
204 buildable: False
266 buildable: False
205
267
206test-suite EventWriterT
268test-suite EventWriterT
269+ default-language: Haskell2010
207 type: exitcode-stdio-1.0
270 type: exitcode-stdio-1.0
208 main-is: EventWriterT.hs
271 main-is: EventWriterT.hs
209 hs-source-dirs: test
272 hs-source-dirs: test
210 build-depends: base
273 build-depends: base
211 , containers
274 , containers
212− , deepseq >= 1.3 && < 1.5
275+ , deepseq
213 , dependent-map
276 , dependent-map
214 , dependent-sum
277 , dependent-sum
215 , lens
278 , lens
@@ -218,31 +281,96 @@ test-suite EventWriterT
218 , transformers
281 , transformers
219 , reflex
282 , reflex
220 , ref-tf
283 , ref-tf
284+
285+ if flag(split-these)
286+ build-depends: these-lens
287+
221 other-modules:
288 other-modules:
222− Reflex.Test
223− Reflex.TestPlan
224− Reflex.Plan.Reflex
225− Reflex.Plan.Pure
226 Test.Run
289 Test.Run
227
290
291+
228−test-suite RequesterT
292+test-suite DebugCycles
293+ default-language: Haskell2010
229 type: exitcode-stdio-1.0
294 type: exitcode-stdio-1.0
230− main-is: RequesterT.hs
295+ main-is: DebugCycles.hs
231 hs-source-dirs: test
296 hs-source-dirs: test
297+ ghc-options: -threaded
232 build-depends: base
298 build-depends: base
233− , dependent-sum
299+ , containers
300+ , deepseq
234 , dependent-map
301 , dependent-map
302+ , dependent-sum
303+ , hspec
235 , lens
304 , lens
305+ , mtl
236 , these
306 , these
237 , transformers
307 , transformers
238 , reflex
308 , reflex
239 , ref-tf
309 , ref-tf
240− 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+
241 other-modules:
344 other-modules:
242 Reflex.TestPlan
345 Reflex.TestPlan
243 Reflex.Plan.Pure
346 Reflex.Plan.Pure
347+ Test.Run
348+
349+test-suite Headless
350+ default-language: Haskell2010
351+ type: exitcode-stdio-1.0
352+ main-is: Headless.hs
353+ hs-source-dirs: test
354+ build-depends: base
355+ , reflex
356+
357+test-suite Adjustable
358+ default-language: Haskell2010
359+ type: exitcode-stdio-1.0
360+ main-is: Adjustable.hs
361+ hs-source-dirs: test
362+ build-depends: base
363+ , containers
364+ , dependent-sum
365+ , reflex
366+ , ref-tf
367+ , these
368+
369+ other-modules:
370+ Test.Run
244
371
245test-suite QueryT
372test-suite QueryT
373+ default-language: Haskell2010
246 type: exitcode-stdio-1.0
374 type: exitcode-stdio-1.0
247 main-is: QueryT.hs
375 main-is: QueryT.hs
248 hs-source-dirs: test
376 hs-source-dirs: test
@@ -250,15 +378,19 @@ test-suite QueryT
250 , containers
378 , containers
251 , dependent-map
379 , dependent-map
252 , dependent-sum
380 , dependent-sum
253− , deepseq >= 1.3 && < 1.5
381+ , deepseq
254 , lens
382 , lens
255 , monoidal-containers
383 , monoidal-containers
256 , mtl
384 , mtl
385+ , patch
257 , ref-tf
386 , ref-tf
258 , reflex
387 , reflex
259− , semigroups
260 , these
388 , these
261 , transformers
389 , transformers
390+
391+ if flag(split-these)
392+ build-depends: semialign, these-lens
393+
262 other-modules:
394 other-modules:
263 Test.Run
395 Test.Run
264 Reflex.TestPlan
396 Reflex.TestPlan
@@ -266,6 +398,7 @@ test-suite QueryT
266 Reflex.Plan.Pure
398 Reflex.Plan.Pure
267
399
268test-suite GC-Semantics
400test-suite GC-Semantics
401+ default-language: Haskell2010
269 type: exitcode-stdio-1.0
402 type: exitcode-stdio-1.0
270 main-is: GC.hs
403 main-is: GC.hs
271 hs-source-dirs: test
404 hs-source-dirs: test
@@ -273,14 +406,17 @@ test-suite GC-Semantics
273 , containers
406 , containers
274 , dependent-sum
407 , dependent-sum
275 , dependent-map
408 , dependent-map
276− , deepseq >= 1.3 && < 1.5
409+ , deepseq
277 , mtl
410 , mtl
411+ , patch
278 , these
412 , these
279 , transformers
413 , transformers
280 , reflex
414 , reflex
281 , ref-tf
415 , ref-tf
282− if impl(ghc < 8)
416+
417+ if flag(split-these)
283− build-depends: semigroups
418+ build-depends: semialign
419+
284 other-modules:
420 other-modules:
285 Reflex.Plan.Pure
421 Reflex.Plan.Pure
286 Reflex.Plan.Reflex
422 Reflex.Plan.Reflex
@@ -288,12 +424,13 @@ test-suite GC-Semantics
288 Test.Run
424 Test.Run
289
425
290test-suite rootCleanup
426test-suite rootCleanup
427+ default-language: Haskell2010
291 type: exitcode-stdio-1.0
428 type: exitcode-stdio-1.0
292 main-is: rootCleanup.hs
429 main-is: rootCleanup.hs
293 hs-source-dirs: test
430 hs-source-dirs: test
294 build-depends: base
431 build-depends: base
295 , containers
432 , containers
296− , deepseq >= 1.3 && < 1.5
433+ , deepseq
297 , dependent-sum
434 , dependent-sum
298 , mtl
435 , mtl
299 , reflex
436 , reflex
@@ -305,6 +442,7 @@ test-suite rootCleanup
305 Test.Run
442 Test.Run
306
443
307benchmark spider-bench
444benchmark spider-bench
445+ default-language: Haskell2010
308 type: exitcode-stdio-1.0
446 type: exitcode-stdio-1.0
309 hs-source-dirs: bench test
447 hs-source-dirs: bench test
310 main-is: Main.hs
448 main-is: Main.hs
@@ -312,8 +450,8 @@ benchmark spider-bench
312 build-depends:
450 build-depends:
313 base,
451 base,
314 containers,
452 containers,
315− criterion >= 1.1 && < 1.6,
453+ criterion,
316− deepseq >= 1.3 && < 1.5,
454+ deepseq,
317 dependent-map,
455 dependent-map,
318 dependent-sum,
456 dependent-sum,
319 ref-tf,
457 ref-tf,
@@ -322,13 +460,14 @@ benchmark spider-bench
322 reflex,
460 reflex,
323 split,
461 split,
324 stm,
462 stm,
325− transformers >= 0.3
463+ transformers
326 other-modules:
464 other-modules:
327 Reflex.TestPlan
465 Reflex.TestPlan
328 Reflex.Plan.Reflex
466 Reflex.Plan.Reflex
329 Reflex.Bench.Focused
467 Reflex.Bench.Focused
330
468
331benchmark saulzar-bench
469benchmark saulzar-bench
470+ default-language: Haskell2010
332 type: exitcode-stdio-1.0
471 type: exitcode-stdio-1.0
333 hs-source-dirs: bench test
472 hs-source-dirs: bench test
334 c-sources: bench-cbits/checkCapability.c
473 c-sources: bench-cbits/checkCapability.c
@@ -336,9 +475,9 @@ benchmark saulzar-bench
336 ghc-options: -Wall -O2 -rtsopts -threaded
475 ghc-options: -Wall -O2 -rtsopts -threaded
337 build-depends:
476 build-depends:
338 base,
477 base,
339− containers >= 0.5 && < 0.7,
478+ containers,
340− criterion >= 1.1 && < 1.6,
479+ criterion,
341− deepseq >= 1.3 && < 1.5,
480+ deepseq,
342 dependent-map,
481 dependent-map,
343 dependent-sum,
482 dependent-sum,
344 loch-th,
483 loch-th,
@@ -350,7 +489,7 @@ benchmark saulzar-bench
350 split,
489 split,
351 stm,
490 stm,
352 time,
491 time,
353− transformers >= 0.3
492+ transformers
354 other-modules:
493 other-modules:
355 Reflex.TestPlan
494 Reflex.TestPlan
356 Reflex.Plan.Reflex
495 Reflex.Plan.Reflex
release.nix+56−13
@@ -1,15 +1,58 @@
1−{ rp-src ? (import <nixpkgs> {}).fetchFromGitHub {
1+{ reflex-platform-fun ? import ./dep/reflex-platform
2− owner = "reflex-frp";
2+, supportedSystems ? ["x86_64-linux" "x86_64-darwin"]
3− repo = "reflex-platform";
4− rev = "384cd850f3adf1d404bced2424b5f6efb0f415f2";
5− sha256 = "1ws77prqx8khmp8j6br1ij4k2v4dlgv170r9fmg0p1jivfbn8y9d";
6− }
7}:
3}:
4+
8let
5let
9− rp = import rp-src {};
6+ native-reflex-platform = reflex-platform-fun {};
10− inherit (rp.nixpkgs) lib;
7+ inherit (native-reflex-platform.nixpkgs) lib;
11− compilers = ["ghc8_4" "ghc8_0" "ghcjs8_4" "ghcjs8_0"];
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+ ];
12−in lib.genAttrs compilers (ghc: {
24+ compilerPkgs = lib.genAttrs compilers (ghc: let
13− reflex-useTemplateHaskell = rp.${ghc}.callPackage ./. { useTemplateHaskell = true; };
25+ variationPkgs = lib.genAttrs variations (variation: let
14− reflex = rp.${ghc}.callPackage ./. { useTemplateHaskell = false; };
26+ reflex-platform = reflex-platform-fun {
15−})
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 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveGeneric #-}
4−{-# LANGUAGE DeriveTraversable #-}
5{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8{-# LANGUAGE MultiParamTypeClasses #-}
4{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE PatternSynonyms #-}
5{-# LANGUAGE PatternSynonyms #-}
10{-# LANGUAGE RoleAnnotations #-}
6{-# LANGUAGE RoleAnnotations #-}
11{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE StandaloneDeriving #-}
13{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
14{-# OPTIONS_GHC -fno-warn-orphans #-}
9{-# OPTIONS_GHC -fno-warn-orphans #-}
15−-- | 'Data.Map' with a better 'Monoid' instance
10+-- |
16−--
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.
17−-- 'Data.Map' has @mappend = union@, which is left-biased. AppendMap has
16+-- 'Data.Map' has @mappend = union@, which is left-biased. 'MonoidalMap'
18−-- @mappend = unionWith mappend@ instead.
17+-- has @mappend = unionWith mappend@ instead.
19module Data.AppendMap
18module Data.AppendMap
20 ( module Data.AppendMap
19 ( module Data.AppendMap
21 , module Data.Map.Monoidal
20 , module Data.Map.Monoidal
22 ) where
21 ) where
23
22
24−import Prelude hiding (map, null)
23+import Prelude hiding (null)
25
24
26import Data.Coerce
25import Data.Coerce
27import Data.Default
26import Data.Default
@@ -31,22 +30,28 @@ import qualified Data.Map.Internal.Debug as Map (showTree, showTreeWith)
31#else
30#else
32import qualified Data.Map as Map (showTree, showTreeWith)
31import qualified Data.Map as Map (showTree, showTreeWith)
33#endif
32#endif
33+import qualified Data.Witherable as W
34import Data.Map.Monoidal
34import Data.Map.Monoidal
35−import Reflex.Class (FunctorMaybe (..))
35+import qualified Data.Map.Monoidal as MonoidalMap
36−import Reflex.Patch (Additive, Group (..))
36+
37
37
38{-# DEPRECATED AppendMap "Use 'MonoidalMap' instead" #-}
38{-# DEPRECATED AppendMap "Use 'MonoidalMap' instead" #-}
39+-- | AppendMap is a synonym for 'Data.Map.Monoidal.MonoidalMap'
39type AppendMap = MonoidalMap
40type AppendMap = MonoidalMap
40
41
41{-# DEPRECATED _unAppendMap "Use 'getMonoidalMap' instead" #-}
42{-# DEPRECATED _unAppendMap "Use 'getMonoidalMap' instead" #-}
43+-- | A synonym for 'getMonoidalMap'
42_unAppendMap :: MonoidalMap k v -> Map k v
44_unAppendMap :: MonoidalMap k v -> Map k v
43_unAppendMap = getMonoidalMap
45_unAppendMap = getMonoidalMap
44
46
47+-- | Pattern synonym for 'MonoidalMap'
45pattern AppendMap :: Map k v -> MonoidalMap k v
48pattern AppendMap :: Map k v -> MonoidalMap k v
46pattern AppendMap m = MonoidalMap m
49pattern AppendMap m = MonoidalMap m
47
50
51+#if !MIN_VERSION_witherable(0,3,2)
48−instance FunctorMaybe (MonoidalMap k) where
52+instance W.Filterable (MonoidalMap k) where
49− fmapMaybe = mapMaybe
53+ mapMaybe = MonoidalMap.mapMaybe
54+#endif
50
55
51-- | Deletes a key, returning 'Nothing' if the result is empty.
56-- | Deletes a key, returning 'Nothing' if the result is empty.
52nonEmptyDelete :: Ord k => k -> MonoidalMap k a -> Maybe (MonoidalMap k a)
57nonEmptyDelete :: Ord k => k -> MonoidalMap k a -> Maybe (MonoidalMap k a)
@@ -56,24 +61,22 @@ nonEmptyDelete k vs =
56 then Nothing
61 then Nothing
57 else Just deleted
62 else Just deleted
58
63
64+-- | Like 'mapMaybe' but indicates whether the resulting container is empty
59mapMaybeNoNull :: (a -> Maybe b)
65mapMaybeNoNull :: (a -> Maybe b)
60 -> MonoidalMap token a
66 -> MonoidalMap token a
61 -> Maybe (MonoidalMap token b)
67 -> Maybe (MonoidalMap token b)
62mapMaybeNoNull f as =
68mapMaybeNoNull f as =
63− let bs = fmapMaybe f as
69+ let bs = mapMaybe f as
64 in if null bs
70 in if null bs
65 then Nothing
71 then Nothing
66 else Just bs
72 else Just bs
67
73
68−-- TODO: Move instances to `Reflex.Patch`
74+-- TODO: Move instances to `Data.Patch`
69−instance (Ord k, Group q) => Group (MonoidalMap k q) where
75+-- | Displays a 'MonoidalMap' as a tree. See 'Data.Map.Lazy.showTree' for details.
70− negateG = map negateG
71−
72−instance (Ord k, Additive q) => Additive (MonoidalMap k q)
73−
74showTree :: forall k a. (Show k, Show a) => MonoidalMap k a -> String
76showTree :: forall k a. (Show k, Show a) => MonoidalMap k a -> String
75showTree = coerce (Map.showTree :: Map k a -> String)
77showTree = coerce (Map.showTree :: Map k a -> String)
76
78
79+-- | Displays a 'MonoidalMap' as a tree, using the supplied function to convert nodes to string.
77showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> MonoidalMap k a -> String
80showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> MonoidalMap k a -> String
78showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
81showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
79
82
src/Data/FastMutableIntMap.hs+23−2
@@ -1,4 +1,9 @@
1{-# LANGUAGE TypeFamilies #-}
1{-# LANGUAGE TypeFamilies #-}
2+-- |
3+-- Module:
4+-- Data.FastMutableIntMap
5+-- Description:
6+-- A mutable version of 'IntMap'
2module Data.FastMutableIntMap
7module Data.FastMutableIntMap
3 ( FastMutableIntMap
8 ( FastMutableIntMap
4 , new
9 , new
@@ -16,6 +21,7 @@ module Data.FastMutableIntMap
16 , patchIntMapNewElements
21 , patchIntMapNewElements
17 , patchIntMapNewElementsMap
22 , patchIntMapNewElementsMap
18 , getDeletions
23 , getDeletions
24+ , toList
19 ) where
25 ) where
20
26
21--TODO: Pure JS version
27--TODO: Pure JS version
@@ -29,36 +35,46 @@ import Data.Foldable (traverse_)
29import Data.IntMap.Strict (IntMap)
35import Data.IntMap.Strict (IntMap)
30import qualified Data.IntMap.Strict as IntMap
36import qualified Data.IntMap.Strict as IntMap
31import Data.IORef
37import Data.IORef
32−import Reflex.Patch.Class
38+import Data.Patch.Class
33−import Reflex.Patch.IntMap
39+import Data.Patch.IntMap
34
40
41+-- | A 'FastMutableIntMap' holds a map of values of type @a@ and allows low-overhead modifications via IO.
42+-- Operations on 'FastMutableIntMap' run in IO.
35newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
43newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
36
44
45+-- | Create a new 'FastMutableIntMap' out of an 'IntMap'
37new :: IntMap a -> IO (FastMutableIntMap a)
46new :: IntMap a -> IO (FastMutableIntMap a)
38new m = FastMutableIntMap <$> newIORef m
47new m = FastMutableIntMap <$> newIORef m
39
48
49+-- | Create a new empty 'FastMutableIntMap'
40newEmpty :: IO (FastMutableIntMap a)
50newEmpty :: IO (FastMutableIntMap a)
41newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
51newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
42
52
53+-- | Insert an element into a 'FastMutableIntMap' at the given key
43insert :: FastMutableIntMap a -> Int -> a -> IO ()
54insert :: FastMutableIntMap a -> Int -> a -> IO ()
44insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
55insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
45
56
57+-- | Attempt to lookup an element by key in a 'FastMutableIntMap'
46lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
58lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
47lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
59lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
48
60
61+-- | Runs the provided action over the intersection of a 'FastMutableIntMap' and an 'IntMap'
49forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
62forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
50forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
63forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
51 a <- liftIO $ readIORef r
64 a <- liftIO $ readIORef r
52 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
65 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
53
66
67+-- | Runs the provided action over the values of a 'FastMutableIntMap'
54for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
68for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
55for_ (FastMutableIntMap r) f = do
69for_ (FastMutableIntMap r) f = do
56 a <- liftIO $ readIORef r
70 a <- liftIO $ readIORef r
57 traverse_ f a
71 traverse_ f a
58
72
73+-- | Checks whether a 'FastMutableIntMap' is empty
59isEmpty :: FastMutableIntMap a -> IO Bool
74isEmpty :: FastMutableIntMap a -> IO Bool
60isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
75isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
61
76
77+-- | Retrieves the size of a 'FastMutableIntMap'
62size :: FastMutableIntMap a -> IO Int
78size :: FastMutableIntMap a -> IO Int
63size (FastMutableIntMap r) = IntMap.size <$> readIORef r
79size (FastMutableIntMap r) = IntMap.size <$> readIORef r
64
80
@@ -69,8 +85,13 @@ getFrozenAndClear (FastMutableIntMap r) = do
69 writeIORef r IntMap.empty
85 writeIORef r IntMap.empty
70 return result
86 return result
71
87
88+-- | Updates the value of a 'FastMutableIntMap' with the given patch (see 'Data.Patch.IntMap'),
89+-- and returns an 'IntMap' with the modified keys and values.
72applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
90applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
73applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
91applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
74 v <- readIORef r
92 v <- readIORef r
75 writeIORef r $! applyAlways p v
93 writeIORef r $! applyAlways p v
76 return $ IntMap.intersection v m
94 return $ IntMap.intersection v m
95+
96+toList :: FastMutableIntMap a -> IO [(Int, a)]
97+toList (FastMutableIntMap r) = IntMap.toList <$> readIORef r
src/Data/FastWeakBag.hs+12−7
@@ -18,6 +18,7 @@ module Data.FastWeakBag
18 , isEmpty
18 , isEmpty
19 , insert
19 , insert
20 , traverse
20 , traverse
21+ , traverse_
21 , remove
22 , remove
22 -- * Internal functions
23 -- * Internal functions
23 -- These will not always be available.
24 -- These will not always be available.
@@ -42,15 +43,15 @@ import Data.IORef
42import System.Mem.Weak
43import System.Mem.Weak
43#endif
44#endif
44
45
45−-- | A @FastWeakBag a@ holds a set of values of type @a@, but does not retain them -
46+-- | A 'FastWeakBag' holds a set of values of type @/a/@, but does not retain them -
46−-- that is, they can still be garbage-collected. As long as the @a@s remain
47+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
47-- alive, the 'FastWeakBag' will continue to refer to them.
48-- alive, the 'FastWeakBag' will continue to refer to them.
48#ifdef GHCJS_FAST_WEAK
49#ifdef GHCJS_FAST_WEAK
49newtype FastWeakBag a = FastWeakBag JSVal
50newtype FastWeakBag a = FastWeakBag JSVal
50#else
51#else
51data FastWeakBag a = FastWeakBag
52data FastWeakBag a = FastWeakBag
52 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
53 { _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'
54 }
55 }
55#endif
56#endif
56
57
@@ -116,14 +117,14 @@ foreign import javascript unsafe "(function(){ for(var i = 0; i < $1.tickets.len
116isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
117isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
117#endif
118#endif
118
119
119−{-# INLINE traverse #-}
120+{-# INLINE traverse_ #-}
120-- | Visit every node in the given list. If new nodes are appended during the
121-- | Visit every node in the given list. If new nodes are appended during the
121-- traversal, they will not be visited. Every live node that was in the list
122-- traversal, they will not be visited. Every live node that was in the list
122-- when the traversal began will be visited exactly once; however, no guarantee
123-- when the traversal began will be visited exactly once; however, no guarantee
123-- is made about the order of the traversal.
124-- 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 ()
125#ifdef GHCJS_FAST_WEAK
126#ifdef GHCJS_FAST_WEAK
126−traverse wb f = do
127+traverse_ wb f = do
127 let go cursor = when (not $ js_isNull cursor) $ do
128 let go cursor = when (not $ js_isNull cursor) $ do
128 val <- liftIO $ js_getTicketValue cursor
129 val <- liftIO $ js_getTicketValue cursor
129 f $ unsafeFromRawJSVal val
130 f $ unsafeFromRawJSVal val
@@ -134,13 +135,17 @@ foreign import javascript unsafe "$r = $1.val;" js_getTicketValue :: JSVal -> IO
134--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
135--TODO: Fix the race condition where if a cursor is deleted (presumably using 'remove', below) while we're holding it, it can't find its way back to the correct bag
135foreign 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
136foreign 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
136#else
137#else
137−traverse (FastWeakBag _ children) f = {-# SCC "traverse" #-} do
138+traverse_ (FastWeakBag _ children) f = {-# SCC "traverse_" #-} do
138 cs <- liftIO $ readIORef children
139 cs <- liftIO $ readIORef children
139 forM_ cs $ \c -> do
140 forM_ cs $ \c -> do
140 ma <- liftIO $ deRefWeak c
141 ma <- liftIO $ deRefWeak c
141 mapM_ f ma
142 mapM_ f ma
142#endif
143#endif
143
144
145+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
146+traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
147+traverse = traverse_
148+
144-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
149-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
145-- on the same 'FastWeakBagTicket'.
150-- on the same 'FastWeakBagTicket'.
146{-# INLINE remove #-}
151{-# INLINE remove #-}
src/Data/Functor/Misc.hsdeleted−287
@@ -1,287 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE KindSignatures #-}
8−{-# LANGUAGE LambdaCase #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10−{-# LANGUAGE PatternSynonyms #-}
11−{-# LANGUAGE PolyKinds #-}
12−{-# LANGUAGE RankNTypes #-}
13−{-# LANGUAGE ScopedTypeVariables #-}
14−{-# LANGUAGE StandaloneDeriving #-}
15−#ifdef USE_REFLEX_OPTIMIZER
16−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
17−#endif
18−-- | This module provides types and functions with no particular theme, but
19−-- which are relevant to the use of 'Functor'-based datastructures like
20−-- 'Data.Dependent.Map.DMap'.
21−module Data.Functor.Misc
22− ( -- * Const2
23− Const2 (..)
24− , unConst2
25− , dmapToMap
26− , dmapToIntMap
27− , dmapToMapWith
28− , mapToDMap
29− , weakenDMapWith
30− -- * WrapArg
31− , WrapArg (..)
32− -- * Convenience functions for DMap
33− , mapWithFunctorToDMap
34− , intMapWithFunctorToDMap
35− , mapKeyValuePairsMonotonic
36− , combineDMapsWithKey
37− , EitherTag (..)
38− , dmapToThese
39− , eitherToDSum
40− , dsumToEither
41− -- * Deprecated functions
42− , sequenceDmap
43− , wrapDMap
44− , rewrapDMap
45− , unwrapDMap
46− , unwrapDMapMaybe
47− , extractFunctorDMap
48− , ComposeMaybe (..)
49− ) where
50−
51−import Control.Applicative (Applicative, (<$>))
52−import Control.Monad.Identity
53−import Data.Dependent.Map (DMap)
54−import qualified Data.Dependent.Map as DMap
55−import Data.Dependent.Sum
56−import Data.GADT.Compare
57−import Data.GADT.Show
58−import Data.IntMap (IntMap)
59−import qualified Data.IntMap as IntMap
60−import Data.Map (Map)
61−import qualified Data.Map as Map
62−import Data.Some (Some)
63−import qualified Data.Some as Some
64−import Data.These
65−import Data.Typeable hiding (Refl)
66−
67−--------------------------------------------------------------------------------
68−-- Const2
69−--------------------------------------------------------------------------------
70−
71−-- | 'Const2' stores a value of a given type 'k' and ensures that a particular
72−-- type 'v' is always given for the last type parameter
73−data Const2 :: * -> x -> x -> * where
74− Const2 :: k -> Const2 k v v
75− deriving (Typeable)
76−
77−-- | Extract the value from a Const2
78−unConst2 :: Const2 k v v' -> k
79−unConst2 (Const2 k) = k
80−
81−deriving instance Eq k => Eq (Const2 k v v')
82−deriving instance Ord k => Ord (Const2 k v v')
83−deriving instance Show k => Show (Const2 k v v')
84−deriving instance Read k => Read (Const2 k v v)
85−
86−instance Show k => GShow (Const2 k v) where
87− gshowsPrec n x@(Const2 _) = showsPrec n x
88−
89−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
90− showTaggedPrec (Const2 _) = showsPrec
91−
92−instance Eq k => GEq (Const2 k v) where
93− geq (Const2 a) (Const2 b) =
94− if a == b
95− then Just Refl
96− else Nothing
97−
98−instance Ord k => GCompare (Const2 k v) where
99− gcompare (Const2 a) (Const2 b) = case compare a b of
100− LT -> GLT
101− EQ -> GEQ
102− GT -> GGT
103−
104−-- | Convert a 'DMap' to a regular 'Map'
105−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
106−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
107−
108−-- | Convert a 'DMap' to an 'IntMap'
109−dmapToIntMap :: DMap (Const2 IntMap.Key v) Identity -> IntMap v
110−dmapToIntMap = IntMap.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
111−
112−-- | Convert a 'DMap' to a regular 'Map', applying the given function to remove
113−-- the wrapping 'Functor'
114−dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
115−dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
116−
117−-- | Convert a regular 'Map' to a 'DMap'
118−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
119−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
120−
121−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
122−-- to a 'DMap'
123−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
124−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
125−
126−-- | Convert a regular 'IntMap', where the values are already wrapped in a
127−-- functor, to a 'DMap'
128−intMapWithFunctorToDMap :: IntMap (f v) -> DMap (Const2 IntMap.Key v) f
129−intMapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . IntMap.toAscList
130−
131−-- | Convert a 'DMap' to a regular 'Map' by forgetting the types associated with
132−-- the keys, using a function to remove the wrapping 'Functor'
133−weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
134−weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (Some.This k, f v)) . DMap.toAscList
135−
136−--------------------------------------------------------------------------------
137−-- WrapArg
138−--------------------------------------------------------------------------------
139−
140−-- | 'WrapArg' can be used to tag a value in one functor with a type
141−-- representing another functor. This was primarily used with dependent-map <
142−-- 0.2, in which the value type was not wrapped in a separate functor.
143−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
144− WrapArg :: f a -> WrapArg g f (g a)
145−
146−deriving instance Eq (f a) => Eq (WrapArg g f (g' a))
147−deriving instance Ord (f a) => Ord (WrapArg g f (g' a))
148−deriving instance Show (f a) => Show (WrapArg g f (g' a))
149−deriving instance Read (f a) => Read (WrapArg g f (g a))
150−
151−instance GEq f => GEq (WrapArg g f) where
152− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
153−
154−instance GCompare f => GCompare (WrapArg g f) where
155− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
156− GLT -> GLT
157− GEQ -> GEQ
158− GGT -> GGT
159−
160−--------------------------------------------------------------------------------
161−-- Convenience functions for DMap
162−--------------------------------------------------------------------------------
163−
164−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
165−-- well as the value. The provided function MUST preserve the ordering of the
166−-- keys, or the resulting 'DMap' will be malformed.
167−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
168−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
169−
170−{-# INLINE combineDMapsWithKey #-}
171−-- | Union two 'DMap's of different types, yielding another type. Each key that
172−-- is present in either input map will be present in the output.
173−combineDMapsWithKey :: forall f g h i.
174− GCompare f
175− => (forall a. f a -> These (g a) (h a) -> i a)
176− -> DMap f g
177− -> DMap f h
178− -> DMap f i
179−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
180− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
181− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
182− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
183− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
184− GLT -> (gk :=> f gk (This gv)) : go gs' hs
185− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
186− GGT -> (hk :=> f hk (That hv)) : go gs hs'
187−
188−-- | Extract the values of a 'DMap' of 'EitherTag's.
189−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
190−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
191− (Nothing, Nothing) -> Nothing
192− (Just (Identity a), Nothing) -> Just $ This a
193− (Nothing, Just (Identity b)) -> Just $ That b
194− (Just (Identity a), Just (Identity b)) -> Just $ These a b
195−
196−-- | Tag type for 'Either' to use it as a 'DSum'.
197−data EitherTag l r a where
198− LeftTag :: EitherTag l r l
199− RightTag :: EitherTag l r r
200− deriving (Typeable)
201−
202−deriving instance Show (EitherTag l r a)
203−deriving instance Eq (EitherTag l r a)
204−deriving instance Ord (EitherTag l r a)
205−
206−instance GEq (EitherTag l r) where
207− geq a b = case (a, b) of
208− (LeftTag, LeftTag) -> Just Refl
209− (RightTag, RightTag) -> Just Refl
210− _ -> Nothing
211−
212−instance GCompare (EitherTag l r) where
213− gcompare a b = case (a, b) of
214− (LeftTag, LeftTag) -> GEQ
215− (LeftTag, RightTag) -> GLT
216− (RightTag, LeftTag) -> GGT
217− (RightTag, RightTag) -> GEQ
218−
219−instance GShow (EitherTag l r) where
220− gshowsPrec _ a = case a of
221− LeftTag -> showString "LeftTag"
222− RightTag -> showString "RightTag"
223−
224−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
225− showTaggedPrec t n (Identity a) = case t of
226− LeftTag -> showsPrec n a
227− RightTag -> showsPrec n a
228−
229−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
230−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
231−eitherToDSum = \case
232− Left a -> (LeftTag :=> Identity a)
233− Right b -> (RightTag :=> Identity b)
234−
235−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
236−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
237−dsumToEither = \case
238− (LeftTag :=> Identity a) -> Left a
239− (RightTag :=> Identity b) -> Right b
240−
241−--------------------------------------------------------------------------------
242−-- ComposeMaybe
243−--------------------------------------------------------------------------------
244−
245−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
246−-- make the 'f' parameter have a nominal type role. We need f to be
247−-- representational so that we can use safe 'coerce'.
248−newtype ComposeMaybe f a =
249− ComposeMaybe { getComposeMaybe :: Maybe (f a) } deriving (Show, Eq, Ord)
250−
251−deriving instance Functor f => Functor (ComposeMaybe f)
252−
253−--------------------------------------------------------------------------------
254−-- Deprecated functions
255−--------------------------------------------------------------------------------
256−
257−{-# INLINE sequenceDmap #-}
258−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ -> fmap Identity)' instead" #-}
259−-- | Run the actions contained in the 'DMap'
260−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
261−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
262−
263−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
264−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
265−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
266−wrapDMap f = DMap.map $ f . runIdentity
267−
268−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
269−-- | Replace one functor for a 'DMap''s values with a different functor
270−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
271−rewrapDMap = DMap.map
272−
273−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
274−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
275−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
276−unwrapDMap f = DMap.map $ Identity . f
277−
278−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
279−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
280−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
281−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
282−
283−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
284−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
285−-- underlying functor
286−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
287−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
src/Data/Map/Misc.hs+26−10
@@ -1,4 +1,5 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2+-- | Additional functions for manipulating 'Map's.
2module Data.Map.Misc
3module Data.Map.Misc
3 (
4 (
4 -- * Working with Maps
5 -- * Working with Maps
@@ -10,7 +11,6 @@ module Data.Map.Misc
10 ) where
11 ) where
11
12
12import Data.Align
13import Data.Align
13−import Data.Either (isLeft)
14import Data.Map (Map)
14import Data.Map (Map)
15import qualified Data.Map as Map
15import qualified Data.Map as Map
16import Data.Maybe
16import Data.Maybe
@@ -18,12 +18,21 @@ import Data.Set (Set)
18import qualified Data.Set as Set
18import qualified Data.Set as Set
19import Data.These
19import Data.These
20
20
21+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new@ respectively. @Just@ represents an association present in @new@ and @Nothing@
22+-- represents an association only present in @old@ but no longer present in @new@.
23+--
24+-- Similar to 'diffMap' but doesn't require 'Eq' on the values, thus can't tell if a value has changed or not.
21diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
25diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
22diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
26diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
23 This _ -> Just Nothing
27 This _ -> Just Nothing
24 These _ new -> Just $ Just new
28 These _ new -> Just $ Just new
25 That new -> Just $ Just new
29 That new -> Just $ Just new
26
30
31+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new respectively. @Just@ represents an association present in @new@ and either not
32+-- present in @old@ or where the value has changed. @Nothing@ represents an association only present in @old@ but no longer present in @new@.
33+--
34+-- See also 'diffMapNoEq' for a similar but weaker version which does not require 'Eq' on the values but thus can't indicated a value not changing between
35+-- @old@ and @new@ with @Nothing@.
27diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
36diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
28diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
37diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
29 This _ -> Just Nothing
38 This _ -> Just Nothing
@@ -32,23 +41,30 @@ diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
32 | otherwise -> Just $ Just new
41 | otherwise -> Just $ Just new
33 That new -> Just $ Just new
42 That new -> Just $ Just new
34
43
44+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new map from the given input @'Map' k v@.
45+--
46+-- See also 'Data.Patch.Map' and 'Data.Patch.MapWithMove'.
35applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
47applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
36applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
48applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
37− where (deletions, insertions) = mapPartitionEithers $ maybeToEither <$> patch
49+ where (deletions, insertions) = Map.mapEither maybeToEither patch
38 maybeToEither = \case
50 maybeToEither = \case
39 Nothing -> Left ()
51 Nothing -> Left ()
40 Just r -> Right r
52 Just r -> Right r
41
53
54+-- |Split a @'Map' k (Either a b)@ into @Map k a@ and @Map k b@, equivalent to @'Map.mapEither' id@
55+{-# DEPRECATED mapPartitionEithers "Use 'mapEither' instead" #-}
42mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
56mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
43−mapPartitionEithers m = (fromLeft <$> ls, fromRight <$> rs)
57+mapPartitionEithers = Map.mapEither id
44− where (ls, rs) = Map.partition isLeft m
45− fromLeft (Left l) = l
46− fromLeft _ = error "mapPartitionEithers: fromLeft received a Right value; this should be impossible"
47− fromRight (Right r) = r
48− fromRight _ = error "mapPartitionEithers: fromRight received a Left value; this should be impossible"
49
58
50−-- | Apply a map patch to a set
59+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new @'Set' k@ from the given input set.
60+--
61+-- Equivalent to:
62+--
63+-- @
51−-- > applyMapKeysSet patch (Map.keysSet m) == Map.keysSet (applyMap patch m)
64+-- applyMapKeysSet patch ('Map.keysSet' m) == 'Map.keysSet' ('applyMap' patch m)
65+-- @
66+--
67+-- but avoids the intervening @Map@ and needs no values.
52applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
68applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
53applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
69applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
54 where (insertions, deletions) = Map.partition isJust patch
70 where (insertions, deletions) = Map.partition isJust patch
src/Data/WeakBag.hs+10−5
@@ -15,6 +15,7 @@ module Data.WeakBag
15 , singleton
15 , singleton
16 , insert
16 , insert
17 , traverse
17 , traverse
18+ , traverse_
18 , remove
19 , remove
19 -- * Internal functions
20 -- * Internal functions
20 -- These will not always be available.
21 -- These will not always be available.
@@ -31,8 +32,8 @@ import qualified Data.IntMap.Strict as IntMap
31import Data.IORef
32import Data.IORef
32import System.Mem.Weak
33import System.Mem.Weak
33
34
34−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
35+-- | A 'WeakBag' holds a set of values of type @/a/@, but does not retain them -
35−-- that is, they can still be garbage-collected. As long as the @a@s remain
36+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
36-- alive, the 'WeakBag' will continue to refer to them.
37-- alive, the 'WeakBag' will continue to refer to them.
37data WeakBag a = WeakBag
38data WeakBag a = WeakBag
38 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
39 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
@@ -99,18 +100,22 @@ singleton a wbRef finalizer = {-# SCC "singleton" #-} do
99 ticket <- insert a bag wbRef finalizer
100 ticket <- insert a bag wbRef finalizer
100 return (bag, ticket)
101 return (bag, ticket)
101
102
102−{-# INLINE traverse #-}
103+{-# INLINE traverse_ #-}
103-- | Visit every node in the given list. If new nodes are appended during the
104-- | Visit every node in the given list. If new nodes are appended during the
104-- traversal, they will not be visited. Every live node that was in the list
105-- traversal, they will not be visited. Every live node that was in the list
105-- when the traversal began will be visited exactly once; however, no guarantee
106-- when the traversal began will be visited exactly once; however, no guarantee
106-- is made about the order of the traversal.
107-- is made about the order of the traversal.
107−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
108+traverse_ :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
108−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
109+traverse_ (WeakBag _ children) f = {-# SCC "traverse" #-} do
109 cs <- liftIO $ readIORef children
110 cs <- liftIO $ readIORef children
110 forM_ cs $ \c -> do
111 forM_ cs $ \c -> do
111 ma <- liftIO $ deRefWeak c
112 ma <- liftIO $ deRefWeak c
112 mapM_ f ma
113 mapM_ f ma
113
114
115+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
116+traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
117+traverse = traverse_
118+
114-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
119-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
115-- on the same 'WeakBagTicket'.
120-- on the same 'WeakBagTicket'.
116{-# INLINE remove #-}
121{-# INLINE remove #-}
src/Reflex.hs+1
@@ -19,6 +19,7 @@ import Reflex.Dynamic.TH as X
19import Reflex.Dynamic.Uniq as X
19import Reflex.Dynamic.Uniq as X
20import Reflex.DynamicWriter.Base as X
20import Reflex.DynamicWriter.Base as X
21import Reflex.DynamicWriter.Class as X
21import Reflex.DynamicWriter.Class as X
22+import Reflex.NotReady.Class as X
22import Reflex.PerformEvent.Base as X
23import Reflex.PerformEvent.Base as X
23import Reflex.PerformEvent.Class as X
24import Reflex.PerformEvent.Class as X
24import Reflex.PostBuild.Base as X
25import Reflex.PostBuild.Base as X
src/Reflex/Adjustable/Class.hs+33−6
@@ -3,7 +3,6 @@
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE LambdaCase #-}
5{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE RankNTypes #-}
6{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
@@ -11,6 +10,13 @@
11#ifdef USE_REFLEX_OPTIMIZER
10#ifdef USE_REFLEX_OPTIMIZER
12{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
13#endif
12#endif
13+-- |
14+-- Module:
15+-- Reflex.Adjustable.Class
16+-- Description:
17+-- A class for actions that can be "adjusted" over time based on some 'Event'
18+-- such that, when observed after the firing of any such 'Event', the result
19+-- is as though the action was originally run with the 'Event's value.
14module Reflex.Adjustable.Class
20module Reflex.Adjustable.Class
15 (
21 (
16 -- * The Adjustable typeclass
22 -- * The Adjustable typeclass
@@ -24,7 +30,8 @@ module Reflex.Adjustable.Class
24
30
25import Control.Monad.Identity
31import Control.Monad.Identity
26import Control.Monad.Reader
32import Control.Monad.Reader
27−import Data.Dependent.Map (DMap, GCompare (..))
33+import Data.Dependent.Map (DMap)
34+import Data.GADT.Compare (GCompare(..))
28import qualified Data.Dependent.Map as DMap
35import qualified Data.Dependent.Map as DMap
29import Data.Functor.Constant
36import Data.Functor.Constant
30import Data.Functor.Misc
37import Data.Functor.Misc
@@ -33,7 +40,7 @@ import qualified Data.IntMap.Strict as IntMap
33import Data.Map (Map)
40import Data.Map (Map)
34
41
35import Reflex.Class
42import Reflex.Class
36−import Reflex.Patch.DMapWithMove
43+import Data.Patch.DMapWithMove
37
44
38-- | A 'Monad' that supports adjustment over time. After an action has been
45-- | A 'Monad' that supports adjustment over time. After an action has been
39-- run, if the given events fire, it will adjust itself so that its net effect
46-- 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
94 r <- ask
101 r <- ask
95 lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
102 lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
96
103
104+-- | Traverse a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
105+-- to the 'DMap' can add, remove, or update values.
106+sequenceDMapWithAdjust
107+ :: (GCompare k, Adjustable t m)
108+ => DMap k m
109+ -> Event t (PatchDMap k m)
97−sequenceDMapWithAdjust :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
110+ -> m (DMap k Identity, Event t (PatchDMap k Identity))
98sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
111sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
99
112
113+-- | Traverses a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
114+-- to the 'DMap' can add, remove, update, move, or swap values.
115+sequenceDMapWithAdjustWithMove
116+ :: (GCompare k, Adjustable t m)
117+ => DMap k m
118+ -> Event t (PatchDMapWithMove k m)
100−sequenceDMapWithAdjustWithMove :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
119+ -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
101sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
120sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
102
121
122+-- | Traverses a 'Map', running the provided 'Adjustable' action. The provided 'Event' of patches to the 'Map'
123+-- can add, remove, update, move, or swap values.
124+mapMapWithAdjustWithMove
125+ :: forall t m k v v'. (Adjustable t m, Ord k)
126+ => (k -> v -> m v')
127+ -> Map k v
128+ -> Event t (PatchMapWithMove k v)
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'))
129+ -> m (Map k v', Event t (PatchMapWithMove k v'))
104mapMapWithAdjustWithMove f m0 m' = do
130mapMapWithAdjustWithMove f m0 m' = do
105 (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
131 (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
106 return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
132 return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
@@ -110,4 +136,5 @@ mapMapWithAdjustWithMove f m0 m' = do
110--------------------------------------------------------------------------------
136--------------------------------------------------------------------------------
111
137
112{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
138{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
139+-- | Synonym for 'Adjustable'
113type MonadAdjust = Adjustable
140type MonadAdjust = Adjustable
src/Reflex/BehaviorWriter/Base.hs+16−7
@@ -1,6 +1,6 @@
1{-|
1{-|
2Module: Reflex.BehaviorWriter.Base
2Module: Reflex.BehaviorWriter.Base
3−Description: Implementation of MonadBehaviorWriter
3+Description: Implementation of BehaviorWriter
4-}
4-}
5{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
@@ -24,6 +24,7 @@ module Reflex.BehaviorWriter.Base
24import Control.Monad.Exception
24import Control.Monad.Exception
25import Control.Monad.Identity
25import Control.Monad.Identity
26import Control.Monad.IO.Class
26import Control.Monad.IO.Class
27+import Control.Monad.Morph
27import Control.Monad.Reader
28import Control.Monad.Reader
28import Control.Monad.Ref
29import Control.Monad.Ref
29import Control.Monad.State.Strict
30import Control.Monad.State.Strict
@@ -46,9 +47,20 @@ import Reflex.Query.Class
46import Reflex.Requester.Class
47import Reflex.Requester.Class
47import Reflex.TriggerEvent.Class
48import Reflex.TriggerEvent.Class
48
49
49−-- | A basic implementation of 'MonadBehaviorWriter'.
50+-- | A basic implementation of 'BehaviorWriter'.
50newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
51newtype 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+ )
52
64
53-- | Run a 'BehaviorWriterT' action. The behavior writer output will be provided
65-- | Run a 'BehaviorWriterT' action. The behavior writer output will be provided
54-- along with the result of the action.
66-- along with the result of the action.
@@ -73,9 +85,6 @@ withBehaviorWriterT f dw = do
73deriving instance MonadHold t m => MonadHold t (BehaviorWriterT t w m)
85deriving instance MonadHold t m => MonadHold t (BehaviorWriterT t w m)
74deriving instance MonadSample t m => MonadSample t (BehaviorWriterT t w m)
86deriving instance MonadSample t m => MonadSample t (BehaviorWriterT t w m)
75
87
76−instance MonadTrans (BehaviorWriterT t w) where
77− lift = BehaviorWriterT . lift
78−
79instance MonadRef m => MonadRef (BehaviorWriterT t w m) where
88instance MonadRef m => MonadRef (BehaviorWriterT t w m) where
80 type Ref (BehaviorWriterT t w m) = Ref m
89 type Ref (BehaviorWriterT t w m) = Ref m
81 newRef = lift . newRef
90 newRef = lift . newRef
@@ -89,7 +98,7 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (BehaviorWri
89 newEventWithTrigger = lift . newEventWithTrigger
98 newEventWithTrigger = lift . newEventWithTrigger
90 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
99 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
91
100
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
93 tellBehavior w = BehaviorWriterT $ modify (w :)
102 tellBehavior w = BehaviorWriterT $ modify (w :)
94
103
95instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
104instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
src/Reflex/BehaviorWriter/Class.hs+11−6
@@ -1,26 +1,31 @@
1{-|
1{-|
2Module: Reflex.BehaviorWriter.Class
2Module: Reflex.BehaviorWriter.Class
3−Description: This module defines the 'MonadBehaviorWriter' class
3+Description: This module defines the 'BehaviorWriter' class
4-}
4-}
5{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
6+{-# LANGUAGE ConstraintKinds #-}
6{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
10#ifdef USE_REFLEX_OPTIMIZER
10#ifdef USE_REFLEX_OPTIMIZER
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12#endif
12#endif
13module Reflex.BehaviorWriter.Class
13module Reflex.BehaviorWriter.Class
14− ( MonadBehaviorWriter (..)
14+ ( MonadBehaviorWriter
15+ , BehaviorWriter(..)
15 ) where
16 ) where
16
17
17import Control.Monad.Reader (ReaderT, lift)
18import Control.Monad.Reader (ReaderT, lift)
18import Reflex.Class (Behavior)
19import Reflex.Class (Behavior)
19
20
21+{-# DEPRECATED MonadBehaviorWriter "Use 'BehaviorWriter' instead" #-}
22+-- | Type synonym for 'BehaviorWriter'
23+type MonadBehaviorWriter = BehaviorWriter
24+
20−-- | 'MonadBehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
25+-- | 'BehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
21-- and combines them monoidally to provide a 'Behavior' result.
26-- 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
23 tellBehavior :: Behavior t w -> m ()
28 tellBehavior :: Behavior t w -> m ()
24
29
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
26 tellBehavior = lift . tellBehavior
31 tellBehavior = lift . tellBehavior
src/Reflex/Class.hs+481−141
@@ -7,7 +7,6 @@
7{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE GADTs #-}
8{-# LANGUAGE GADTs #-}
9{-# LANGUAGE LambdaCase #-}
9{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
11{-# LANGUAGE NoMonomorphismRestriction #-}
10{-# LANGUAGE NoMonomorphismRestriction #-}
12{-# LANGUAGE PolyKinds #-}
11{-# LANGUAGE PolyKinds #-}
13{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
@@ -17,32 +16,41 @@
17{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeFamilies #-}
18{-# LANGUAGE TypeOperators #-}
17{-# LANGUAGE TypeOperators #-}
19{-# LANGUAGE UndecidableInstances #-}
18{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
20#ifdef USE_REFLEX_OPTIMIZER
20#ifdef USE_REFLEX_OPTIMIZER
21{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
21{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
22#endif
22#endif
23
23
24+-- |
25+-- Module:
26+-- Reflex.Class
27+-- Description:
24−-- | This module contains the Reflex interface, as well as a variety of
28+-- This module contains the Reflex interface, as well as a variety of
25−-- convenience functions for working with 'Event's, 'Behavior's, and other
29+-- convenience functions for working with 'Event's, 'Behavior's, and other
26−-- signals.
30+-- signals.
27module Reflex.Class
31module Reflex.Class
28− ( module Reflex.Patch
32+ ( module Data.Patch
29 -- * Primitives
33 -- * Primitives
30 , Reflex (..)
34 , Reflex (..)
31 , mergeInt
35 , mergeInt
32 , coerceBehavior
36 , coerceBehavior
33 , coerceEvent
37 , coerceEvent
34 , coerceDynamic
38 , coerceDynamic
39+ , coerceIncremental
35 , MonadSample (..)
40 , MonadSample (..)
36 , MonadHold (..)
41 , MonadHold (..)
37− -- ** 'fan'-related types
42+ -- ** 'fan' related types
38 , EventSelector (..)
43 , EventSelector (..)
44+ , EventSelectorG (..)
39 , EventSelectorInt (..)
45 , EventSelectorInt (..)
40− -- ** 'Incremental'-related types
41 -- * Convenience functions
46 -- * Convenience functions
42 , constDyn
47 , constDyn
43 , pushAlways
48 , pushAlways
44 -- ** Combining 'Event's
49 -- ** Combining 'Event's
45 , leftmost
50 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
46 , mergeMap
54 , mergeMap
47 , mergeIntMap
55 , mergeIntMap
48 , mergeMapIncremental
56 , mergeMapIncremental
@@ -57,6 +65,7 @@ module Reflex.Class
57 , alignEventWithMaybe
65 , alignEventWithMaybe
58 -- ** Breaking up 'Event's
66 -- ** Breaking up 'Event's
59 , splitE
67 , splitE
68+ , fan
60 , fanEither
69 , fanEither
61 , fanThese
70 , fanThese
62 , fanMap
71 , fanMap
@@ -81,6 +90,7 @@ module Reflex.Class
81 , gate
90 , gate
82 -- ** Combining 'Dynamic's
91 -- ** Combining 'Dynamic's
83 , distributeDMapOverDynPure
92 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
84 , distributeListOverDyn
94 , distributeListOverDyn
85 , distributeListOverDynWith
95 , distributeListOverDynWith
86 , zipDyn
96 , zipDyn
@@ -134,8 +144,10 @@ module Reflex.Class
134 -- * Unsafe functions
144 -- * Unsafe functions
135 , unsafeDynamic
145 , unsafeDynamic
136 , unsafeMapIncremental
146 , unsafeMapIncremental
137− -- * 'FunctorMaybe'
147+ -- * 'Filterable' convenience functions
138− , FunctorMaybe (..)
148+ , FunctorMaybe -- fmapMaybe is purposely not exported from deprecated 'FunctorMaybe' and the new alias is exported instead
149+ , mapMaybe -- Re-exported for convenience
150+ , fmapMaybe
139 , fforMaybe
151 , fforMaybe
140 , ffilter
152 , ffilter
141 , filterLeft
153 , filterLeft
@@ -145,10 +157,11 @@ module Reflex.Class
145 , ffor2
157 , ffor2
146 , ffor3
158 , ffor3
147 -- * Deprecated functions
159 -- * Deprecated functions
148− , appendEvents
160+ , switchPromptly
149− , onceE
161+ , switchPromptOnly
150− , sequenceThese
162+ -- * "Cheap" functions
151 , fmapMaybeCheap
163 , fmapMaybeCheap
164+ , mapMaybeCheap
152 , fmapCheap
165 , fmapCheap
153 , fforCheap
166 , fforCheap
154 , fforMaybeCheap
167 , fforMaybeCheap
@@ -156,12 +169,21 @@ module Reflex.Class
156 , tagCheap
169 , tagCheap
157 , mergeWithCheap
170 , mergeWithCheap
158 , mergeWithCheap'
171 , mergeWithCheap'
159− , switchPromptly
160− , switchPromptOnly
161 -- * Slow, but general, implementations
172 -- * Slow, but general, implementations
162 , slowHeadE
173 , slowHeadE
163 ) where
174 ) where
164
175
176+#ifdef MIN_VERSION_semialign
177+import Prelude hiding (zip, zipWith)
178+
179+#if MIN_VERSION_these(0,8,0)
180+import Data.These.Combinators (justThese)
181+#endif
182+#if MIN_VERSION_semialign(1,1,0)
183+import Data.Zip (Zip (..), Unzip (..))
184+#endif
185+#endif
186+
165import Control.Applicative
187import Control.Applicative
166import Control.Monad.Identity
188import Control.Monad.Identity
167import Control.Monad.Reader
189import Control.Monad.Reader
@@ -174,11 +196,12 @@ import Data.Align
174import Data.Bifunctor
196import Data.Bifunctor
175import Data.Coerce
197import Data.Coerce
176import Data.Default
198import Data.Default
177−import Data.Dependent.Map (DMap, DSum (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
178import qualified Data.Dependent.Map as DMap
201import qualified Data.Dependent.Map as DMap
179import Data.Functor.Compose
202import Data.Functor.Compose
180import Data.Functor.Product
203import Data.Functor.Product
181−import Data.GADT.Compare (GEq (..), GCompare (..), (:~:) (..))
204+import Data.GADT.Compare (GEq (..), GCompare (..))
182import Data.FastMutableIntMap (PatchIntMap)
205import Data.FastMutableIntMap (PatchIntMap)
183import Data.Foldable
206import Data.Foldable
184import Data.Functor.Bind
207import Data.Functor.Bind
@@ -188,20 +211,23 @@ import Data.IntMap.Strict (IntMap)
188import qualified Data.IntMap.Strict as IntMap
211import qualified Data.IntMap.Strict as IntMap
189import Data.List.NonEmpty (NonEmpty (..))
212import Data.List.NonEmpty (NonEmpty (..))
190import Data.Map (Map)
213import Data.Map (Map)
191−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
214+import Data.Semigroup (Semigroup (..))
192−import Data.Some (Some)
215+import Data.Some (Some(Some))
193−import qualified Data.Some as Some
194import Data.String
216import Data.String
195import Data.These
217import Data.These
196import Data.Type.Coercion
218import Data.Type.Coercion
219+import Data.Type.Equality ((:~:) (..))
220+import Data.Witherable (Filterable(..))
221+import qualified Data.Witherable as W
197−import Reflex.FunctorMaybe
222+import Reflex.FunctorMaybe (FunctorMaybe)
198−import Reflex.Patch
223+import qualified Reflex.FunctorMaybe
224+import Data.Patch
199−import qualified Reflex.Patch.MapWithMove as PatchMapWithMove
225+import qualified Data.Patch.MapWithMove as PatchMapWithMove
200
226
201import Debug.Trace (trace)
227import Debug.Trace (trace)
202
228
203-- | The 'Reflex' class contains all the primitive functionality needed for
229-- | The 'Reflex' class contains all the primitive functionality needed for
204−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
230+-- Functional Reactive Programming (FRP). The @/t/@ type parameter indicates
205-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
231-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
206-- and the type of the timeline determines the FRP engine to be used. For most
232-- and the type of the timeline determines the FRP engine to be used. For most
207-- purposes, the 'Reflex.Spider' implementation is recommended.
233-- purposes, the 'Reflex.Spider' implementation is recommended.
@@ -249,16 +275,21 @@ class ( MonadHold t (PushM t)
249 -- | Merge a collection of events; the resulting 'Event' will only occur if at
275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
250 -- least one input event is occurring, and will contain all of the input keys
276 -- least one input event is occurring, and will contain all of the input keys
251 -- that are occurring simultaneously
277 -- that are occurring simultaneously
278+
252− merge :: GCompare k => DMap k (Event t) -> Event t (DMap k Identity) --TODO: Generalize to get rid of DMap use --TODO: Provide a type-level guarantee that the result is not empty
279+ --TODO: Generalize to get rid of DMap use --TODO: Provide a type-level guarantee that the result is not empty
280+ mergeG :: GCompare k => (forall a. q a -> Event t (v a))
281+ -> DMap k q -> Event t (DMap k v)
282+
253− -- | Efficiently fan-out an event to many destinations. This function should
283+ -- | Efficiently fan-out an event to many destinations. You should save the
254− -- be partially applied, and then the result applied repeatedly to create
284+ -- result in a @let@-binding, and then repeatedly 'selectG' on the result to
255− -- child events
285+ -- create child events
256− fan :: GCompare k => Event t (DMap k Identity) -> EventSelector t k --TODO: Can we help enforce the partial application discipline here? The combinator is worthless without it
286+ fanG :: GCompare k => Event t (DMap k v) -> EventSelectorG t k v
287+
257 -- | Create an 'Event' that will occur whenever the currently-selected input
288 -- | Create an 'Event' that will occur whenever the currently-selected input
258 -- 'Event' occurs
289 -- 'Event' occurs
259 switch :: Behavior t (Event t a) -> Event t a
290 switch :: Behavior t (Event t a) -> Event t a
260− -- | Create an 'Event' that will occur whenever the input event is occurring
291+ -- | Create an 'Event' that will occur whenever the input event is occurring -- and its occurrence value, another 'Event', is also occurring.
261− -- and its occurrence value, another 'Event', is also occurring
292+ -- You maybe looking for '@switchHold@ @never@' instead.
262 coincidence :: Event t (Event t a) -> Event t a
293 coincidence :: Event t (Event t a) -> Event t a
263 -- | Extract the 'Behavior' of a 'Dynamic'.
294 -- | Extract the 'Behavior' of a 'Dynamic'.
264 current :: Dynamic t a -> Behavior t a
295 current :: Dynamic t a -> Behavior t a
@@ -267,14 +298,19 @@ class ( MonadHold t (PushM t)
267 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
268 -- recent firing of the given 'Event', if any.
299 -- recent firing of the given 'Event', if any.
269 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
300 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
270− -- | Create a new 'Incremental'. The given 'PullM''s value must always change
301+ -- | Create a new 'Incremental'. The given "PullM"'s value must always change
271 -- in the same way that the accumulated application of patches would change
302 -- in the same way that the accumulated application of patches would change
272 -- that value.
303 -- that value.
273 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
274 -- | Create a merge whose parents can change over time
305 -- | Create a merge whose parents can change over time
306+ mergeIncrementalG :: GCompare k
307+ => (forall a. q a -> Event t (v a))
275− mergeIncremental :: GCompare k => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
308+ -> Incremental t (PatchDMap k q)
309+ -> Event t (DMap k v)
276 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
311+ mergeIncrementalWithMoveG :: GCompare k
312+ => (forall a. q a -> Event t (v a))
277− mergeIncrementalWithMove :: GCompare k => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
313+ -> Incremental t (PatchDMapWithMove k q) -> Event t (DMap k v)
278 -- | Extract the 'Behavior' component of an 'Incremental'
314 -- | Extract the 'Behavior' component of an 'Incremental'
279 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
280 -- | Extract the 'Event' component of an 'Incremental'
316 -- | Extract the 'Event' component of an 'Incremental'
@@ -290,10 +326,28 @@ class ( MonadHold t (PushM t)
290 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
291 -- occurrence type
327 -- occurrence type
292 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
328 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
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)
293 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
333 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
294 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
334 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
295
335
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+
296--TODO: Specialize this so that we can take advantage of knowing that there's no changing going on
348--TODO: Specialize this so that we can take advantage of knowing that there's no changing going on
349+-- | Constructs a single 'Event' out of a map of events. The output event may fire with multiple
350+-- keys simultaneously.
297mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
351mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
298mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
352mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
299
353
@@ -309,8 +363,14 @@ coerceEvent = coerceWith $ eventCoercion Coercion
309coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
310coerceDynamic = coerceWith $ dynamicCoercion Coercion
364coerceDynamic = coerceWith $ dynamicCoercion Coercion
311
365
366+-- | Coerce an 'Incremental' between representationally-equivalent value types
367+coerceIncremental
368+ :: (Reflex t, Coercible a b, Coercible (PatchTarget a) (PatchTarget b))
369+ => Incremental t a -> Incremental t b
370+coerceIncremental = coerceWith $ incrementalCoercion Coercion Coercion
371+
312-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
372-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
313−-- _must_ change when and only when the 'Event' fires, such that the
373+-- __must__ change when and only when the 'Event' fires, such that the
314-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
315-- if this is not the case, the resulting 'Dynamic' will behave
375-- if this is not the case, the resulting 'Dynamic' will behave
316-- nondeterministically.
376-- nondeterministically.
@@ -338,7 +398,7 @@ class MonadSample t m => MonadHold t m where
338 -- value and will be updated whenever the given 'Event' occurs. The update
398 -- value and will be updated whenever the given 'Event' occurs. The update
339 -- takes effect immediately after the 'Event' occurs; if the occurrence that
399 -- takes effect immediately after the 'Event' occurs; if the occurrence that
340 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
400 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
341− -- the 'Behavior', it will see the _old_ value of the 'Behavior', not the new
401+ -- the 'Behavior', it will see the __old__ value of the 'Behavior', not the new
342 -- one.
402 -- one.
343 hold :: a -> Event t a -> m (Behavior t a)
403 hold :: a -> Event t a -> m (Behavior t a)
344 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
404 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
@@ -361,27 +421,99 @@ class MonadSample t m => MonadHold t m where
361 -- | Create a new 'Event' that only occurs only once, on the first occurrence of
421 -- | Create a new 'Event' that only occurs only once, on the first occurrence of
362 -- the supplied 'Event'.
422 -- the supplied 'Event'.
363 headE :: Event t a -> m (Event t a)
423 headE :: Event t a -> m (Event t a)
364−
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
365−accumIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> p) -> PatchTarget p -> Event t b -> m (Incremental t p)
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)
366accumIncremental f = accumMaybeIncremental $ \v o -> Just $ f v o
440accumIncremental f = accumMaybeIncremental $ \v o -> Just $ f v o
441+
442+-- | Similar to 'accumIncremental' but the combining function runs in 'PushM'
443+accumMIncremental
367−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)
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)
368accumMIncremental f = accumMaybeMIncremental $ \v o -> Just <$> f v o
449accumMIncremental f = accumMaybeMIncremental $ \v o -> Just <$> f v o
450+
451+-- | Similar to 'accumIncremental' but allows filtering of updates (by dropping updates when the
452+-- combining function produces @Nothing@)
453+accumMaybeIncremental
369−accumMaybeIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> Maybe p) -> PatchTarget p -> Event t b -> m (Incremental t p)
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)
370accumMaybeIncremental f = accumMaybeMIncremental $ \v o -> return $ f v o
459accumMaybeIncremental f = accumMaybeMIncremental $ \v o -> return $ f v o
460+
461+-- | Similar to 'accumMaybeMIncremental' but the combining function runs in 'PushM'
462+accumMaybeMIncremental
371−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)
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)
372accumMaybeMIncremental f z e = do
468accumMaybeMIncremental f z e = do
373 rec let e' = flip push e $ \o -> do
469 rec let e' = flip push e $ \o -> do
374 v <- sample $ currentIncremental d'
470 v <- sample $ currentIncremental d'
375 f v o
471 f v o
376 d' <- holdIncremental z e'
472 d' <- holdIncremental z e'
377 return d'
473 return d'
474+
475+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event'
476+-- with a function that both accumulates and produces a value to fire
477+-- as an 'Event'. Returns both the accumulated value and the constructed
478+-- 'Event'.
479+mapAccumIncremental
378−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)
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)
379mapAccumIncremental f = mapAccumMaybeIncremental $ \v o -> bimap Just Just $ f v o
485mapAccumIncremental f = mapAccumMaybeIncremental $ \v o -> bimap Just Just $ f v o
486+
487+-- | Like 'mapAccumIncremental' but the combining function runs in 'PushM'
488+mapAccumMIncremental
380−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)
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)
381mapAccumMIncremental f = mapAccumMaybeMIncremental $ \v o -> bimap Just Just <$> f v o
494mapAccumMIncremental f = mapAccumMaybeMIncremental $ \v o -> bimap Just Just <$> f v o
495+
496+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event' with
497+-- a function that both optionally accumulates and optionally produces
498+-- a value to fire as a separate output 'Event'.
499+-- Note that because 'Nothing's are discarded in both cases, the output
500+-- 'Event' may fire even though the output 'Incremental' has not changed, and
501+-- the output 'Incremental' may update even when the output 'Event' is not firing.
502+mapAccumMaybeIncremental
382−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)
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)
383mapAccumMaybeIncremental f = mapAccumMaybeMIncremental $ \v o -> return $ f v o
508mapAccumMaybeIncremental f = mapAccumMaybeMIncremental $ \v o -> return $ f v o
509+
510+-- | Like 'mapAccumMaybeIncremental' but the combining function is a 'PushM' action
511+mapAccumMaybeMIncremental
384−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)
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)
385mapAccumMaybeMIncremental f z e = do
517mapAccumMaybeMIncremental f z e = do
386 rec let e' = flip push e $ \o -> do
518 rec let e' = flip push e $ \o -> do
387 v <- sample $ currentIncremental d'
519 v <- sample $ currentIncremental d'
@@ -389,9 +521,10 @@ mapAccumMaybeMIncremental f z e = do
389 return $ case result of
521 return $ case result of
390 (Nothing, Nothing) -> Nothing
522 (Nothing, Nothing) -> Nothing
391 _ -> Just result
523 _ -> Just result
392− d' <- holdIncremental z $ fmapMaybe fst e'
524+ d' <- holdIncremental z $ mapMaybe fst e'
393− return (d', fmapMaybe snd e')
525+ return (d', mapMaybe snd e')
394
526
527+-- | A somewhat slow implementation of 'headE'
395slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
528slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
396slowHeadE e = do
529slowHeadE e = do
397 rec be <- hold e $ fmapCheap (const never) e'
530 rec be <- hold e $ fmapCheap (const never) e'
@@ -400,18 +533,31 @@ slowHeadE e = do
400
533
401-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
402-- key. This is much more efficient than filtering for each key with
535-- key. This is much more efficient than filtering for each key with
403−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
404newtype EventSelector t k = EventSelector
537newtype EventSelector t k = EventSelector
405 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
406 -- determined by the type of the key, so this can be used to fan-out
539 -- determined by the type of the key, so this can be used to fan-out
407 -- 'Event's whose sub-'Event's have different types.
540 -- 'Event's whose sub-'Event's have different types.
408 --
541 --
409 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
410− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
411 -- occurrences of an 'Event'.
544 -- occurrences of an 'Event'.
412 select :: forall a. k a -> Event t a
545 select :: forall a. k a -> Event t a
413 }
546 }
414
547
548+newtype EventSelectorG t k v = EventSelectorG
549+ { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
550+ -- determined by the type of the key, so this can be used to fan-out
551+ -- 'Event's whose sub-'Event's have different types.
552+ --
553+ -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
554+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
555+ -- occurrences of an 'Event'.
556+ selectG :: forall a. k a -> Event t (v a)
557+ }
558+
559+-- | Efficiently select an 'Event' keyed on 'Int'. This is more efficient than manually
560+-- filtering by key.
415newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
561newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
416
562
417--------------------------------------------------------------------------------
563--------------------------------------------------------------------------------
@@ -427,6 +573,7 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
427 holdIncremental a0 = lift . holdIncremental a0
573 holdIncremental a0 = lift . holdIncremental a0
428 buildDynamic a0 = lift . buildDynamic a0
574 buildDynamic a0 = lift . buildDynamic a0
429 headE = lift . headE
575 headE = lift . headE
576+ now = lift now
430
577
431instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
432 sample = lift . sample
579 sample = lift . sample
@@ -437,6 +584,7 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
437 holdIncremental a0 = lift . holdIncremental a0
584 holdIncremental a0 = lift . holdIncremental a0
438 buildDynamic a0 = lift . buildDynamic a0
585 buildDynamic a0 = lift . buildDynamic a0
439 headE = lift . headE
586 headE = lift . headE
587+ now = lift now
440
588
441instance MonadSample t m => MonadSample t (StateT s m) where
589instance MonadSample t m => MonadSample t (StateT s m) where
442 sample = lift . sample
590 sample = lift . sample
@@ -447,6 +595,7 @@ instance MonadHold t m => MonadHold t (StateT s m) where
447 holdIncremental a0 = lift . holdIncremental a0
595 holdIncremental a0 = lift . holdIncremental a0
448 buildDynamic a0 = lift . buildDynamic a0
596 buildDynamic a0 = lift . buildDynamic a0
449 headE = lift . headE
597 headE = lift . headE
598+ now = lift now
450
599
451instance MonadSample t m => MonadSample t (ExceptT e m) where
600instance MonadSample t m => MonadSample t (ExceptT e m) where
452 sample = lift . sample
601 sample = lift . sample
@@ -457,6 +606,7 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
457 holdIncremental a0 = lift . holdIncremental a0
606 holdIncremental a0 = lift . holdIncremental a0
458 buildDynamic a0 = lift . buildDynamic a0
607 buildDynamic a0 = lift . buildDynamic a0
459 headE = lift . headE
608 headE = lift . headE
609+ now = lift now
460
610
461instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
462 sample = lift . sample
612 sample = lift . sample
@@ -467,6 +617,7 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
467 holdIncremental a0 = lift . holdIncremental a0
617 holdIncremental a0 = lift . holdIncremental a0
468 buildDynamic a0 = lift . buildDynamic a0
618 buildDynamic a0 = lift . buildDynamic a0
469 headE = lift . headE
619 headE = lift . headE
620+ now = lift now
470
621
471instance MonadSample t m => MonadSample t (ContT r m) where
622instance MonadSample t m => MonadSample t (ContT r m) where
472 sample = lift . sample
623 sample = lift . sample
@@ -477,6 +628,7 @@ instance MonadHold t m => MonadHold t (ContT r m) where
477 holdIncremental a0 = lift . holdIncremental a0
628 holdIncremental a0 = lift . holdIncremental a0
478 buildDynamic a0 = lift . buildDynamic a0
629 buildDynamic a0 = lift . buildDynamic a0
479 headE = lift . headE
630 headE = lift . headE
631+ now = lift now
480
632
481--------------------------------------------------------------------------------
633--------------------------------------------------------------------------------
482-- Convenience functions
634-- Convenience functions
@@ -526,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
526 a >>= f = pull $ sample a >>= sample . f
678 a >>= f = pull $ sample a >>= sample . f
527 -- Note: it is tempting to write (_ >> b = b); however, this would result in (fail x >> return y) succeeding (returning y), which violates the law that (a >> b = a >>= \_ -> b), since the implementation of (>>=) above actually will fail. Since we can't examine 'Behavior's other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
679 -- Note: it is tempting to write (_ >> b = b); however, this would result in (fail x >> return y) succeeding (returning y), which violates the law that (a >> b = a >>= \_ -> b), since the implementation of (>>=) above actually will fail. Since we can't examine 'Behavior's other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
528 return = constant
680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
529 fail = error "Monad (Behavior t) does not support fail"
682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
530
684
531instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
532 mempty = constant mempty
686 mempty = constant mempty
@@ -542,40 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
542 negate = fmap negate
696 negate = fmap negate
543 signum = fmap signum
697 signum = fmap signum
544
698
699+instance (Num a, Reflex t) => Num (Dynamic t a) where
700+ (+) = liftA2 (+)
701+ (*) = liftA2 (*)
702+ abs = fmap abs
703+ signum = fmap signum
704+ fromInteger = pure . fromInteger
705+ negate = fmap negate
706+ (-) = liftA2 (-)
707+
545instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
546 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
547 sconcat = pull . fmap sconcat . mapM sample
710 sconcat = pull . fmap sconcat . mapM sample
548−#if MIN_VERSION_semigroups(0,17,0)
549 stimes n = fmap $ stimes n
711 stimes n = fmap $ stimes n
550−#else
551− times1p n = fmap $ times1p n
552−#endif
553
712
713+-- | Alias for 'mapMaybe'
714+fmapMaybe :: Filterable f => (a -> Maybe b) -> f a -> f b
715+fmapMaybe = mapMaybe
716+
554−-- | Flipped version of 'fmapMaybe'.
717+-- | Flipped version of 'mapMaybe'.
555−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
718+fforMaybe :: Filterable f => f a -> (a -> Maybe b) -> f b
556−fforMaybe = flip fmapMaybe
719+fforMaybe = flip mapMaybe
557
720
558-- | Filter 'f a' using the provided predicate.
721-- | Filter 'f a' using the provided predicate.
559−-- Relies on 'fforMaybe'.
560−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
722+ffilter :: Filterable f => (a -> Bool) -> f a -> f a
561−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
723+ffilter = W.filter
562
724
563-- | Filter 'Left's from 'f (Either a b)' into 'a'.
725-- | Filter 'Left's from 'f (Either a b)' into 'a'.
564−filterLeft :: FunctorMaybe f => f (Either a b) -> f a
726+filterLeft :: Filterable f => f (Either a b) -> f a
565−filterLeft = fmapMaybe (either Just (const Nothing))
727+filterLeft = mapMaybe (either Just (const Nothing))
566
728
567-- | Filter 'Right's from 'f (Either a b)' into 'b'.
729-- | Filter 'Right's from 'f (Either a b)' into 'b'.
568−filterRight :: FunctorMaybe f => f (Either a b) -> f b
730+filterRight :: Filterable f => f (Either a b) -> f b
569−filterRight = fmapMaybe (either (const Nothing) Just)
731+filterRight = mapMaybe (either (const Nothing) Just)
570
732
571-- | Left-biased event union (prefers left event on simultaneous
733-- | Left-biased event union (prefers left event on simultaneous
572-- occurrence).
734-- occurrence).
573instance Reflex t => Alt (Event t) where
735instance Reflex t => Alt (Event t) where
574 ev1 <!> ev2 = leftmost [ev1, ev2]
736 ev1 <!> ev2 = leftmost [ev1, ev2]
575
737
576−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
577instance Reflex t => Apply (Event t) where
739instance Reflex t => Apply (Event t) where
578− 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+
579
744
580-- | 'Event' intersection (convenient interface to 'coincidence').
745-- | 'Event' intersection (convenient interface to 'coincidence').
581instance Reflex t => Bind (Event t) where
746instance Reflex t => Bind (Event t) where
@@ -584,13 +749,18 @@ instance Reflex t => Bind (Event t) where
584
749
585instance Reflex t => Functor (Event t) where
750instance Reflex t => Functor (Event t) where
586 {-# INLINE fmap #-}
751 {-# INLINE fmap #-}
587− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
588 {-# INLINE (<$) #-}
753 {-# INLINE (<$) #-}
589 x <$ e = fmapCheap (const x) e
754 x <$ e = fmapCheap (const x) e
590
755
756+-- TODO Remove this instance
591instance Reflex t => FunctorMaybe (Event t) where
757instance Reflex t => FunctorMaybe (Event t) where
592 {-# INLINE fmapMaybe #-}
758 {-# INLINE fmapMaybe #-}
759+ fmapMaybe = mapMaybe
760+
761+instance Reflex t => Filterable (Event t) where
762+ {-# INLINE mapMaybe #-}
593− fmapMaybe f = push $ return . f
763+ mapMaybe f = push $ return . f
594
764
595-- | Never: @'zero' = 'never'@.
765-- | Never: @'zero' = 'never'@.
596instance Reflex t => Plus (Event t) where
766instance Reflex t => Plus (Event t) where
@@ -641,7 +811,7 @@ headTailE e = do
641-- event returns 'True'.
811-- event returns 'True'.
642--
812--
643-- Starting at the current time, fire all the occurrences of the 'Event' for
813-- Starting at the current time, fire all the occurrences of the 'Event' for
644−-- which the given predicate returns 'True'. When 'False' first is returned,
814+-- which the given predicate returns 'True'. When first 'False' is returned,
645-- do not fire, and permanently stop firing, even if 'True' values would have
815-- do not fire, and permanently stop firing, even if 'True' values would have
646-- been encountered later.
816-- been encountered later.
647takeWhileE
817takeWhileE
@@ -656,7 +826,7 @@ takeWhileE f = takeWhileJustE $ \v -> guard (f v) $> v
656-- event returns 'Just b'.
826-- event returns 'Just b'.
657--
827--
658-- Starting at the current time, fire all the occurrences of the 'Event' for
828-- Starting at the current time, fire all the occurrences of the 'Event' for
659−-- which the given predicate returns 'Just b'. When 'Nothing' first is returned,
829+-- which the given predicate returns 'Just b'. When first 'Nothing' is returned,
660-- do not fire, and permanently stop firing, even if 'Just b' values would have
830-- do not fire, and permanently stop firing, even if 'Just b' values would have
661-- been encountered later.
831-- been encountered later.
662takeWhileJustE
832takeWhileJustE
@@ -739,11 +909,7 @@ traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
739instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
740 (<>) = alignWith (mergeThese (<>))
910 (<>) = alignWith (mergeThese (<>))
741 sconcat = fmap sconcat . mergeList . toList
911 sconcat = fmap sconcat . mergeList . toList
742−#if MIN_VERSION_semigroups(0,17,0)
743 stimes n = fmap $ stimes n
912 stimes n = fmap $ stimes n
744−#else
745− times1p n = fmap $ times1p n
746−#endif
747
913
748instance (Semigroup a, Reflex t) => Monoid (Event t a) where
914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
749 mempty = never
915 mempty = never
@@ -778,7 +944,12 @@ mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
778mergeList [] = never
944mergeList [] = never
779mergeList es = mergeWithFoldCheap' id es
945mergeList es = mergeWithFoldCheap' id es
780
946
947+unsafeMapIncremental
948+ :: (Reflex t, Patch p, Patch p')
781−unsafeMapIncremental :: (Reflex t, Patch p, Patch p') => (PatchTarget p -> PatchTarget p') -> (p -> p') -> Incremental t p -> Incremental t p'
949+ => (PatchTarget p -> PatchTarget p')
950+ -> (p -> p')
951+ -> Incremental t p
952+ -> Incremental t p'
782unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
783
954
784-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
@@ -808,7 +979,7 @@ fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
808fanEither e =
979fanEither e =
809 let justLeft = either Just (const Nothing)
980 let justLeft = either Just (const Nothing)
810 justRight = either (const Nothing) Just
981 justRight = either (const Nothing) Just
811− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
812
983
813-- | Split the event into separate events for 'This' and 'That' values,
984-- | Split the event into separate events for 'This' and 'That' values,
814-- allowing them to fire simultaneously when the input value is 'These'.
985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -820,7 +991,7 @@ fanThese e =
820 that (That y) = Just y
991 that (That y) = Just y
821 that (These _ y) = Just y
992 that (These _ y) = Just y
822 that _ = Nothing
993 that _ = Nothing
823− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
824
995
825-- | Split the event into an 'EventSelector' that allows efficient selection of
996-- | Split the event into an 'EventSelector' that allows efficient selection of
826-- the individual 'Event's.
997-- the individual 'Event's.
@@ -829,7 +1000,7 @@ fanMap = fan . fmap mapToDMap
829
1000
830-- | Switches to the new event whenever it receives one. Only the old event is
1001-- | Switches to the new event whenever it receives one. Only the old event is
831-- considered the moment a new one is switched in; the output event will fire at
1002-- considered the moment a new one is switched in; the output event will fire at
832−-- that moment if only if the old event does.
1003+-- that moment only if the old event does.
833--
1004--
834-- Because the simultaneous firing case is irrelevant, this function imposes
1005-- Because the simultaneous firing case is irrelevant, this function imposes
835-- laxer "timing requirements" on the overall circuit, avoiding many potential
1006-- laxer "timing requirements" on the overall circuit, avoiding many potential
@@ -875,13 +1046,13 @@ coincidencePatchMap e = fmapCheap PatchMap $ coincidence $ ffor e $ \(PatchMap m
875 Nothing -> fmapCheap (const Nothing) e
1046 Nothing -> fmapCheap (const Nothing) e
876 Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
1047 Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
877
1048
878−-- | See 'coincicencePatchMap'
1049+-- | See 'coincidencePatchMap'
879coincidencePatchIntMap :: Reflex t => Event t (PatchIntMap (Event t v)) -> Event t (PatchIntMap v)
1050coincidencePatchIntMap :: Reflex t => Event t (PatchIntMap (Event t v)) -> Event t (PatchIntMap v)
880coincidencePatchIntMap e = fmapCheap PatchIntMap $ coincidence $ ffor e $ \(PatchIntMap m) -> mergeIntMap $ ffor m $ \case
1051coincidencePatchIntMap e = fmapCheap PatchIntMap $ coincidence $ ffor e $ \(PatchIntMap m) -> mergeIntMap $ ffor m $ \case
881 Nothing -> fmapCheap (const Nothing) e
1052 Nothing -> fmapCheap (const Nothing) e
882 Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
1053 Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
883
1054
884−-- | See 'coincicencePatchMap'
1055+-- | See 'coincidencePatchMap'
885coincidencePatchMapWithMove :: (Reflex t, Ord k) => Event t (PatchMapWithMove k (Event t v)) -> Event t (PatchMapWithMove k v)
1056coincidencePatchMapWithMove :: (Reflex t, Ord k) => Event t (PatchMapWithMove k (Event t v)) -> Event t (PatchMapWithMove k v)
886coincidencePatchMapWithMove e = fmapCheap unsafePatchMapWithMove $ coincidence $ ffor e $ \p -> mergeMap $ ffor (unPatchMapWithMove p) $ \ni -> case PatchMapWithMove._nodeInfo_from ni of
1057coincidencePatchMapWithMove e = fmapCheap unsafePatchMapWithMove $ coincidence $ ffor e $ \p -> mergeMap $ ffor (unPatchMapWithMove p) $ \ni -> case PatchMapWithMove._nodeInfo_from ni of
887 PatchMapWithMove.From_Delete -> fforCheap e $ \_ ->
1058 PatchMapWithMove.From_Delete -> fforCheap e $ \_ ->
@@ -895,6 +1066,9 @@ coincidencePatchMapWithMove e = fmapCheap unsafePatchMapWithMove $ coincidence $
895 ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
1066 ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
896 ]
1067 ]
897
1068
1069+-- | Given a 'PatchTarget' of events (e.g., a 'Map' with 'Event' values) and an event of 'Patch'es
1070+-- (e.g., a 'PatchMap' with 'Event' values), produce an 'Event' of the 'PatchTarget' type that
1071+-- fires with the patched value.
898switchHoldPromptOnlyIncremental
1072switchHoldPromptOnlyIncremental
899 :: forall t m p pt w
1073 :: forall t m p pt w
900 . ( Reflex t
1074 . ( Reflex t
@@ -919,15 +1093,32 @@ switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch e0 e' = d
919
1093
920instance Reflex t => Align (Event t) where
1094instance Reflex t => Align (Event t) where
921 nil = never
1095 nil = never
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
922 align = alignEventWithMaybe Just
1099 align = alignEventWithMaybe Just
923
1100
1101+#ifdef MIN_VERSION_semialign
1102+#if MIN_VERSION_semialign(1,1,0)
1103+instance Reflex t => Zip (Event t) where
1104+#endif
1105+ zip x y = mapMaybe justThese $ align x y
1106+#endif
1107+
1108+#ifdef MIN_VERSION_semialign
1109+#if MIN_VERSION_semialign(1,1,0)
1110+instance Reflex t => Unzip (Event t) where
1111+ unzip = splitE
1112+#endif
1113+#endif
1114+
924-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
1115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
925-- the 'Behavior' is true at the time of occurrence.
1116-- the 'Behavior' is true at the time of occurrence.
926gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
1117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
927gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
1118gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
928
1119
929−-- | Create a new behavior given a starting behavior and switch to a the behvior
1120+-- | Create a new behavior given a starting behavior and switch to the behavior
930−-- carried by the event when it fires.
1121+-- carried by the event when it fires.
931switcher :: (Reflex t, MonadHold t m)
1122switcher :: (Reflex t, MonadHold t m)
932 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
1123 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
933switcher b eb = pull . (sample <=< sample) <$> hold b eb
1124switcher b eb = pull . (sample <=< sample) <$> hold b eb
@@ -942,7 +1133,7 @@ zipDyn = zipDynWith (,)
942
1133
943-- | Combine two 'Dynamic's with a combining function. The result will change
1134-- | Combine two 'Dynamic's with a combining function. The result will change
944-- whenever either (or both) input 'Dynamic' changes.
1135-- whenever either (or both) input 'Dynamic' changes.
945−-- More efficient than liftA2.
1136+-- More efficient than 'liftA2'.
946zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
1137zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
947zipDynWith f da db =
1138zipDynWith f da db =
948 let eab = align (updated da) (updated db)
1139 let eab = align (updated da) (updated db)
@@ -960,11 +1151,7 @@ zipDynWith f da db =
960
1151
961instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
1152instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
962 (<>) = zipDynWith (<>)
1153 (<>) = zipDynWith (<>)
963−#if MIN_VERSION_semigroups(0,17,0)
964 stimes n = fmap $ stimes n
1154 stimes n = fmap $ stimes n
965−#else
966− times1p n = fmap $ times1p n
967−#endif
968
1155
969instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
1156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
970 mconcat = distributeListOverDynWith mconcat
1157 mconcat = distributeListOverDynWith mconcat
@@ -973,14 +1160,23 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
973
1160
974-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
1161-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
975-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
1162-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
976−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
1163+-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
977distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
1164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
978−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
979 [] -> constDyn DMap.empty
1175 [] -> constDyn DMap.empty
980− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
981 _ ->
1177 _ ->
982− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
1178+ let getInitial = DMap.traverseWithKey (\_ -> sample . current . nt) dm
983− edmPre = merge $ DMap.map updated dm
1179+ edmPre = mergeG getCompose $ DMap.map (Compose . updated . nt) dm
984 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
1180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
985 olds <- sample $ current result
1181 olds <- sample $ current result
986 return $ DMap.unionWithKey (\_ _ new -> new) olds news
1182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -992,21 +1188,32 @@ distributeListOverDyn = distributeListOverDynWith id
992
1188
993-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
1189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
994distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
1190distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
995−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
996
1201
997-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
1202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
998-- unless the second supplied 'Event' occurs simultaneously.
1203-- unless the second supplied 'Event' occurs simultaneously.
999difference :: Reflex t => Event t a -> Event t b -> Event t a
1204difference :: Reflex t => Event t a -> Event t b -> Event t a
1000difference = alignEventWithMaybe $ \case
1205difference = alignEventWithMaybe $ \case
1001 This a -> Just a
1206 This a -> Just a
1002− _ -> Nothing
1207+ _ -> Nothing
1003
1208
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
1210+-- 'Nothing' values are dropped.
1004alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
1211alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
1005−alignEventWithMaybe f ea eb =
1212+alignEventWithMaybe f ea eb = mapMaybe (f <=< dmapToThese) $
1006− fmapMaybe (f <=< dmapToThese)
1007− $ merge
1008− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1213+ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1009
1214
1215+-- | Produces an 'Event' that fires only when the input event fires with a 'DSum' key that
1216+-- matches the provided key.
1010filterEventKey
1217filterEventKey
1011 :: forall t m k v a.
1218 :: forall t m k v a.
1012 ( Reflex t
1219 ( Reflex t
@@ -1024,7 +1231,10 @@ filterEventKey k kv' = do
1024 Nothing -> Nothing
1231 Nothing -> Nothing
1025 takeWhileJustE f kv'
1232 takeWhileJustE f kv'
1026
1233
1027−
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.
1028factorEvent
1238factorEvent
1029 :: forall t m k v a.
1239 :: forall t m k v a.
1030 ( Reflex t
1240 ( Reflex t
@@ -1036,9 +1246,9 @@ factorEvent
1036 -> Event t (DSum k v)
1246 -> Event t (DSum k v)
1037 -> m (Event t (v a), Event t (DSum k (Product v (Compose (Event t) v))))
1247 -> m (Event t (v a), Event t (DSum k (Product v (Compose (Event t) v))))
1038factorEvent k0 kv' = do
1248factorEvent k0 kv' = do
1039− 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'
1040 let update = flip push kv' $ \(newKey :=> newVal) -> sample key >>= \case
1250 let update = flip push kv' $ \(newKey :=> newVal) -> sample key >>= \case
1041− Some.This oldKey -> case newKey `geq` oldKey of
1251+ Some oldKey -> case newKey `geq` oldKey of
1042 Just Refl -> return Nothing
1252 Just Refl -> return Nothing
1043 Nothing -> do
1253 Nothing -> do
1044 newInner <- filterEventKey newKey kv'
1254 newInner <- filterEventKey newKey kv'
@@ -1074,26 +1284,94 @@ class Reflex t => Accumulator t f | f -> t where
1074 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
1284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
1075 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
1285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
1076
1286
1287+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1288+-- with the provided function. See 'foldDyn'.
1289+accumDyn
1077−accumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Dynamic t a)
1290+ :: (Reflex t, MonadHold t m, MonadFix m)
1291+ => (a -> b -> a)
1292+ -> a
1293+ -> Event t b
1294+ -> m (Dynamic t a)
1078accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
1295accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
1296+
1297+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1298+-- with the provided 'PushM' action.
1299+accumMDyn
1079−accumMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Dynamic t a)
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)
1080accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
1305accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
1306+
1307+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1308+-- with the provided function, discarding 'Nothing' results.
1309+accumMaybeDyn
1081−accumMaybeDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Dynamic t a)
1310+ :: (Reflex t, MonadHold t m, MonadFix m)
1311+ => (a -> b -> Maybe a)
1312+ -> a
1313+ -> Event t b
1314+ -> m (Dynamic t a)
1082accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
1315accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
1316+
1317+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1318+-- with the provided 'PushM' action, discarding 'Nothing' results.
1319+accumMaybeMDyn
1083−accumMaybeMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Dynamic t a)
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)
1084accumMaybeMDyn f z e = do
1325accumMaybeMDyn f z e = do
1085 rec let e' = flip push e $ \o -> do
1326 rec let e' = flip push e $ \o -> do
1086 v <- sample $ current d'
1327 v <- sample $ current d'
1087 f v o
1328 f v o
1088 d' <- holdDyn z e'
1329 d' <- holdDyn z e'
1089 return d'
1330 return d'
1331+
1332+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1333+-- with a function that both accumulates and produces a value to fire
1334+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
1335+mapAccumDyn
1090−mapAccumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
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)
1091mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1341mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1342+
1343+-- | Similar to 'mapAccumDyn' except that the combining function is a
1344+-- 'PushM' action.
1345+mapAccumMDyn
1092−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)
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)
1093mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1351mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1352+
1353+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event' with
1354+-- a function that both optionally accumulates and optionally produces
1355+-- a value to fire as a separate output 'Event'.
1356+-- Note that because 'Nothing's are discarded in both cases, the output
1357+-- 'Event' may fire even though the output 'Dynamic' has not changed, and
1358+-- the output 'Dynamic' may update even when the output 'Event' is not firing.
1359+mapAccumMaybeDyn
1094−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)
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)
1095mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1365mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1366+
1367+-- | Like 'mapAccumMaybeDyn' except that the combining function is a
1368+-- 'PushM' action.
1369+mapAccumMaybeMDyn
1096−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)
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)
1097mapAccumMaybeMDyn f z e = do
1375mapAccumMaybeMDyn f z e = do
1098 rec let e' = flip push e $ \o -> do
1376 rec let e' = flip push e $ \o -> do
1099 v <- sample $ current d'
1377 v <- sample $ current d'
@@ -1101,18 +1379,42 @@ mapAccumMaybeMDyn f z e = do
1101 return $ case result of
1379 return $ case result of
1102 (Nothing, Nothing) -> Nothing
1380 (Nothing, Nothing) -> Nothing
1103 _ -> Just result
1381 _ -> Just result
1104− d' <- holdDyn z $ fmapMaybe fst e'
1382+ d' <- holdDyn z $ mapMaybe fst e'
1105− return (d', fmapMaybe snd e')
1383+ return (d', mapMaybe snd e')
1106
1384
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
1107{-# INLINE accumB #-}
1387{-# INLINE accumB #-}
1388+accumB
1108−accumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Behavior t a)
1389+ :: (Reflex t, MonadHold t m, MonadFix m)
1390+ => (a -> b -> a)
1391+ -> a
1392+ -> Event t b
1393+ -> m (Behavior t a)
1109accumB f = accumMaybeB $ \v o -> Just $ f v o
1394accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
1110{-# INLINE accumMB #-}
1397{-# INLINE accumMB #-}
1398+accumMB
1111−accumMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Behavior t a)
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)
1112accumMB f = accumMaybeMB $ \v o -> Just <$> f v o
1404accumMB 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.
1113{-# INLINE accumMaybeB #-}
1408{-# INLINE accumMaybeB #-}
1409+accumMaybeB
1114−accumMaybeB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Behavior t a)
1410+ :: (Reflex t, MonadHold t m, MonadFix m)
1411+ => (a -> b -> Maybe a)
1412+ -> a
1413+ -> Event t b
1414+ -> m (Behavior t a)
1115accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1415accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
1116{-# INLINE accumMaybeMB #-}
1418{-# INLINE accumMaybeMB #-}
1117accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
1419accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
1118accumMaybeMB f z e = do
1420accumMaybeMB f z e = do
@@ -1121,16 +1423,42 @@ accumMaybeMB f z e = do
1121 f v o
1423 f v o
1122 d' <- hold z e'
1424 d' <- hold z e'
1123 return d'
1425 return d'
1426+
1427+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1428+-- with a function that both accumulates and produces a value to fire
1429+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
1124{-# INLINE mapAccumB #-}
1430{-# INLINE mapAccumB #-}
1431+mapAccumB
1125−mapAccumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Behavior t a, Event t c)
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)
1126mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1437mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
1127{-# INLINE mapAccumMB #-}
1440{-# INLINE mapAccumMB #-}
1441+mapAccumMB
1128−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)
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)
1129mapAccumMB f = mapAccumMaybeMB $ \v o -> bimap Just Just <$> f v o
1447mapAccumMB 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.
1130{-# INLINE mapAccumMaybeB #-}
1452{-# INLINE mapAccumMaybeB #-}
1453+mapAccumMaybeB
1131−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)
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)
1132mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
1459mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
1133
1460
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
1134{-# INLINE mapAccumMaybeMB #-}
1462{-# INLINE mapAccumMaybeMB #-}
1135mapAccumMaybeMB :: (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)
1463mapAccumMaybeMB :: (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)
1136mapAccumMaybeMB f z e = do
1464mapAccumMaybeMB f z e = do
@@ -1140,8 +1468,8 @@ mapAccumMaybeMB f z e = do
1140 return $ case result of
1468 return $ case result of
1141 (Nothing, Nothing) -> Nothing
1469 (Nothing, Nothing) -> Nothing
1142 _ -> Just result
1470 _ -> Just result
1143− d' <- hold z $ fmapMaybe fst e'
1471+ d' <- hold z $ mapMaybe fst e'
1144− return (d', fmapMaybe snd e')
1472+ return (d', mapMaybe snd e')
1145
1473
1146-- | Accumulate occurrences of an 'Event', producing an output occurrence each
1474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
1147-- time. Discard the underlying 'Accumulator'.
1475-- time. Discard the underlying 'Accumulator'.
@@ -1285,38 +1613,70 @@ infixl 4 <@
1285-- Cheap Functions
1613-- Cheap Functions
1286------------------
1614------------------
1287
1615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
1288{-# INLINE pushAlwaysCheap #-}
1617{-# INLINE pushAlwaysCheap #-}
1289pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
1618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
1290pushAlwaysCheap f = pushCheap (fmap Just . f)
1619pushAlwaysCheap f = pushCheap (fmap Just . f)
1291
1620
1621+-- | A "cheap" version of 'mapMaybe'. See the performance note on 'pushCheap'.
1622+{-# INLINE mapMaybeCheap #-}
1623+mapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1624+mapMaybeCheap f = pushCheap $ return . f
1625+
1626+-- | An alias for 'mapMaybeCheap'
1292{-# INLINE fmapMaybeCheap #-}
1627{-# INLINE fmapMaybeCheap #-}
1293fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1294−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
1630+
1295
1631
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
1296{-# INLINE fforMaybeCheap #-}
1633{-# INLINE fforMaybeCheap #-}
1297fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1298−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
1299
1636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
1300{-# INLINE fforCheap #-}
1638{-# INLINE fforCheap #-}
1301fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
1639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
1302fforCheap = flip fmapCheap
1640fforCheap = flip fmapCheap
1303
1641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
1304{-# INLINE fmapCheap #-}
1643{-# INLINE fmapCheap #-}
1305fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
1644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
1306fmapCheap f = pushCheap $ return . Just . f
1645fmapCheap f = pushCheap $ return . Just . f
1307
1646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
1308{-# INLINE tagCheap #-}
1648{-# INLINE tagCheap #-}
1309tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
1649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
1310tagCheap b = pushAlwaysCheap $ \_ -> sample b
1650tagCheap b = pushAlwaysCheap $ \_ -> sample b
1311
1651
1652+-- | Merge a collection of events; the resulting 'Event' will only occur if at
1653+-- least one input event is occurring, and will contain all of the input keys
1654+-- that are occurring simultaneously
1655+merge :: (Reflex t, GCompare k) => DMap k (Event t) -> Event t (DMap k Identity)
1656+merge = mergeG coerceEvent
1657+{-# INLINE merge #-}
1658+
1659+-- | Create a merge whose parents can change over time
1660+mergeIncremental :: (Reflex t, GCompare k)
1661+ => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
1662+mergeIncremental = mergeIncrementalG coerceEvent
1663+
1664+-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
1665+mergeIncrementalWithMove :: (Reflex t, GCompare k)
1666+ => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
1667+mergeIncrementalWithMove = mergeIncrementalWithMoveG coerceEvent
1668+
1669+-- | A "cheap" version of 'mergeWithCheap'. See the performance note on 'pushCheap'.
1312{-# INLINE mergeWithCheap #-}
1670{-# INLINE mergeWithCheap #-}
1313mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
1671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
1314mergeWithCheap = mergeWithCheap' id
1672mergeWithCheap = mergeWithCheap' id
1315
1673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
1316{-# INLINE mergeWithCheap' #-}
1675{-# INLINE mergeWithCheap' #-}
1317mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
1676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
1318mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
1677mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
1319
1678
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
1320{-# INLINE mergeWithFoldCheap' #-}
1680{-# INLINE mergeWithFoldCheap' #-}
1321mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
1681mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
1322mergeWithFoldCheap' f es =
1682mergeWithFoldCheap' f es =
@@ -1329,31 +1689,11 @@ mergeWithFoldCheap' f es =
1329-- Deprecated functions
1689-- Deprecated functions
1330--------------------------------------------------------------------------------
1690--------------------------------------------------------------------------------
1331
1691
1332−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
1333−-- occurs. If both occur at the same time they are combined using 'mappend'.
1334−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
1335−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
1336−appendEvents = alignWith $ mergeThese mappend
1337−
1338−-- | Alias for 'headE'
1339−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1340−onceE :: MonadHold t m => Event t a -> m (Event t a)
1341−onceE = headE
1342−
1343−-- | Run both sides of a 'These' monadically, combining the results.
1344−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
1345−#ifdef USE_TEMPLATE_HASKELL
1346−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
1347−#endif
1348−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
1349−sequenceThese t = case t of
1350− This ma -> fmap This ma
1351− These ma mb -> liftM2 These ma mb
1352− That mb -> fmap That mb
1353−
1354{-# 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'. " #-}
1692{-# DEPRECATED switchPromptly "Use 'switchHoldPromptly' instead. The 'switchHold*' naming convention was chosen because those functions are more closely related to each other than they are to 'switch'. " #-}
1693+-- | See 'switchHoldPromptly'
1355switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1694switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1356switchPromptly = switchHoldPromptly
1695switchPromptly = switchHoldPromptly
1357{-# 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'. " #-}
1696{-# DEPRECATED switchPromptOnly "Use 'switchHoldPromptOnly' instead. The 'switchHold*' naming convention was chosen because those functions are more closely related to each other than they are to 'switch'. " #-}
1697+-- | See 'switchHoldPromptOnly'
1358switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1698switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1359switchPromptOnly = switchHoldPromptOnly
1699switchPromptOnly = switchHoldPromptOnly
src/Reflex/Collection.hs+157−53
@@ -10,12 +10,14 @@
10#ifdef USE_REFLEX_OPTIMIZER
10#ifdef USE_REFLEX_OPTIMIZER
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12#endif
12#endif
13+-- |
14+-- Module:
15+-- Reflex.Collection
13module Reflex.Collection
16module Reflex.Collection
14 (
17 (
15 -- * Widgets on Collections
18 -- * Widgets on Collections
16 listHoldWithKey
19 listHoldWithKey
17 , listWithKey
20 , listWithKey
18− , listWithKey'
19 , listWithKeyShallowDiff
21 , listWithKeyShallowDiff
20 , listViewWithKey
22 , listViewWithKey
21 , selectViewListWithKey
23 , selectViewListWithKey
@@ -25,6 +27,13 @@ module Reflex.Collection
25 , simpleList
27 , simpleList
26 ) where
28 ) where
27
29
30+#ifdef MIN_VERSION_semialign
31+import Prelude hiding (zip, zipWith)
32+#if MIN_VERSION_semialign(1,1,0)
33+import Data.Zip (Zip (..))
34+#endif
35+#endif
36+
28import Control.Monad.Identity
37import Control.Monad.Identity
29import Data.Align
38import Data.Align
30import Data.Functor.Misc
39import Data.Functor.Misc
@@ -38,84 +47,179 @@ import Reflex.Adjustable.Class
38import Reflex.Dynamic
47import Reflex.Dynamic
39import Reflex.PostBuild.Class
48import Reflex.PostBuild.Class
40
49
50+-- | Create a set of widgets based on the provided 'Map'. When the
51+-- input 'Event' fires, remove widgets for keys with the value 'Nothing'
52+-- and add/replace widgets for keys with 'Just' values.
53+listHoldWithKey
54+ :: forall t m k v a
41−listHoldWithKey :: forall t m k v a. (Ord k, Adjustable t m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
55+ . (Ord k, Adjustable t m, MonadHold t m)
56+ => Map k v
57+ -> Event t (Map k (Maybe v))
58+ -> (k -> v -> m a)
59+ -> m (Dynamic t (Map k a))
42listHoldWithKey m0 m' f = do
60listHoldWithKey m0 m' f = do
43 let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
61 let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
62+ dm' = fmap
44− dm' = fmap (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey (\k v -> ComposeMaybe $ fmap (f k) v)) m'
63+ (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey
64+ (\k v -> ComposeMaybe $ fmap (f k) v)
65+ )
66+ m'
45 (a0, a') <- sequenceDMapWithAdjust dm0 dm'
67 (a0, a') <- sequenceDMapWithAdjust dm0 dm'
46− fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a' --TODO: Move the dmapToMap to the righthand side so it doesn't get fully redone every time
47
68
69+ --TODO: Move the dmapToMap to the righthand side so it doesn't get
70+ --fully redone every time
71+ fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a'
72+
48−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
73+--TODO: Something better than Dynamic t (Map k v) - we want something
74+--where the Events carry diffs, not the whole value
75+listWithKey
76+ :: forall t k v m a
49−listWithKey :: forall t k v m a. (Ord k, Adjustable t m, PostBuild t m, MonadFix m, MonadHold t m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m a) -> m (Dynamic t (Map k a))
77+ . (Ord k, Adjustable t m, PostBuild t m, MonadFix m, MonadHold t m)
78+ => Dynamic t (Map k v)
79+ -> (k -> Dynamic t v -> m a)
80+ -> m (Dynamic t (Map k a))
50listWithKey vals mkChild = do
81listWithKey vals mkChild = do
51 postBuild <- getPostBuild
82 postBuild <- getPostBuild
52 let childValChangedSelector = fanMap $ updated vals
83 let childValChangedSelector = fanMap $ updated vals
84+
53− -- We keep track of changes to children values in the mkChild function we pass to listHoldWithKey
85+ -- We keep track of changes to children values in the mkChild
86+ -- function we pass to listHoldWithKey The other changes we need
54− -- The other changes we need to keep track of are child insertions and deletions. diffOnlyKeyChanges
87+ -- to keep track of are child insertions and
88+ -- deletions. diffOnlyKeyChanges keeps track of insertions and
55− -- keeps track of insertions and deletions but ignores value changes, since they're already accounted for.
89+ -- deletions but ignores value changes, since they're already
90+ -- accounted for.
91+ diffOnlyKeyChanges olds news =
56− diffOnlyKeyChanges olds news = flip Map.mapMaybe (align olds news) $ \case
92+ flip Map.mapMaybe (align olds news) $ \case
57− This _ -> Just Nothing
93+ This _ -> Just Nothing
58− These _ _ -> Nothing
94+ These _ _ -> Nothing
59− That new -> Just $ Just new
95+ That new -> Just $ Just new
60 rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
96 rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
61 let changeVals :: Event t (Map k (Maybe v))
97 let changeVals :: Event t (Map k (Maybe v))
98+ changeVals =
62− changeVals = attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
99+ attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
63− [ updated vals
100+ [ updated vals
101+
102+ -- TODO: This should probably be added to the
103+ -- attachWith, not to the updated; if we were using
64− , tag (current vals) postBuild --TODO: This should probably be added to the attachWith, not to the updated; if we were using diffMap instead of diffMapNoEq, I think it might not work
104+ -- diffMap instead of diffMapNoEq, I think it might not
105+ -- work
106+ , tag (current vals) postBuild
65− ]
107+ ]
66 listHoldWithKey Map.empty changeVals $ \k v ->
108 listHoldWithKey Map.empty changeVals $ \k v ->
67 mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
109 mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
68
110
69−{-# DEPRECATED listWithKey' "listWithKey' has been renamed to listWithKeyShallowDiff; also, its behavior has changed to fix a bug where children were always rebuilt (never updated)" #-}
111+-- | Display the given map of items (in key order) using the builder
70−listWithKey' :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> Event t v -> m a) -> m (Dynamic t (Map k a))
112+-- function provided, and update it with the given event. 'Nothing'
71−listWithKey' = listWithKeyShallowDiff
113+-- update entries will delete the corresponding children, and 'Just'
72−
114+-- entries will create them if they do not exist or send an update
73−-- | Display the given map of items (in key order) using the builder function provided, and update it with the given event. 'Nothing' update entries will delete the corresponding children, and 'Just' entries will create them if they do not exist or send an update event to them if they do.
115+-- event to them if they do.
116+listWithKeyShallowDiff
74−listWithKeyShallowDiff :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> Event t v -> m a) -> m (Dynamic t (Map k a))
117+ :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m)
118+ => Map k v
119+ -> Event t (Map k (Maybe v))
120+ -> (k -> v -> Event t v -> m a)
121+ -> m (Dynamic t (Map k a))
75listWithKeyShallowDiff initialVals valsChanged mkChild = do
122listWithKeyShallowDiff initialVals valsChanged mkChild = do
76 let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
123 let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
77 sentVals <- foldDyn applyMap (void initialVals) $ fmap (fmap void) valsChanged
124 sentVals <- foldDyn applyMap (void initialVals) $ fmap (fmap void) valsChanged
78 let relevantPatch patch _ = case patch of
125 let relevantPatch patch _ = case patch of
126+
79− Nothing -> Just Nothing -- Even if we let a Nothing through when the element doesn't already exist, this doesn't cause a problem because it is ignored
127+ -- Even if we let a Nothing through when the element doesn't
128+ -- already exist, this doesn't cause a problem because it is
129+ -- ignored
130+ Nothing -> Just Nothing
131+
80− Just _ -> Nothing -- We don't want to let spurious re-creations of items through
132+ -- We don't want to let spurious re-creations of items through
133+ Just _ -> Nothing
134+ listHoldWithKey
135+ initialVals
81− listHoldWithKey initialVals (attachWith (flip (Map.differenceWith relevantPatch)) (current sentVals) valsChanged) $ \k v ->
136+ (attachWith (flip (Map.differenceWith relevantPatch))
137+ (current sentVals)
138+ valsChanged
139+ )
82− mkChild k v $ select childValChangedSelector $ Const2 k
140+ $ \k v -> mkChild k v $ select childValChangedSelector $ Const2 k
83−
141+
84−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
142+--TODO: Something better than Dynamic t (Map k v) - we want something
143+--where the Events carry diffs, not the whole value
85−-- | Create a dynamically-changing set of Event-valued widgets.
144+-- | Create a dynamically-changing set of Event-valued widgets. This
86−-- This is like listWithKey, specialized for widgets returning (Event t a). listWithKey would return 'Dynamic t (Map k (Event t a))' in this scenario, but listViewWithKey flattens this to 'Event t (Map k a)' via 'switch'.
145+-- is like 'listWithKey', specialized for widgets returning @/Event t a/@.
146+-- 'listWithKey' would return @/Dynamic t (Map k (Event t a))/@ in
147+-- this scenario, but 'listViewWithKey' flattens this to
148+-- @/Event t (Map k a)/@ via 'switch'.
149+listViewWithKey
87−listViewWithKey :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m (Event t a)) -> m (Event t (Map k a))
150+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
151+ => Dynamic t (Map k v)
152+ -> (k -> Dynamic t v -> m (Event t a))
153+ -> m (Event t (Map k a))
154+listViewWithKey vals mkChild =
88−listViewWithKey vals mkChild = switch . fmap mergeMap <$> listViewWithKey' vals mkChild
155+ switch . fmap mergeMap <$> listViewWithKey' vals mkChild
89−
156+
157+listViewWithKey'
90−listViewWithKey' :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m a) -> m (Behavior t (Map k a))
158+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
159+ => Dynamic t (Map k v)
160+ -> (k -> Dynamic t v -> m a)
161+ -> m (Behavior t (Map k a))
91listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
162listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
92
163
93−-- | Create a dynamically-changing set of widgets, one of which is selected at any time.
164+-- | Create a dynamically-changing set of widgets, one of which is
165+-- selected at any time.
166+selectViewListWithKey
167+ :: forall t m k v a
94−selectViewListWithKey :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
168+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
169+ => Dynamic t k
95− => Dynamic t k -- ^ Current selection key
170+ -- ^ Current selection key
171+ -> Dynamic t (Map k v)
96− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
172+ -- ^ Dynamic key/value map
173+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
174+ -- ^ Function to create a widget for a given key from Dynamic value
97− -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a)) -- ^ Function to create a widget for a given key from Dynamic value and Dynamic Bool indicating if this widget is currently selected
175+ -- and Dynamic Bool indicating if this widget is currently selected
176+ -> m (Event t (k, a))
98− -> m (Event t (k, a)) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
177+ -- ^ Event that fires when any child's return Event fires. Contains
178+ -- key of an arbitrary firing widget.
99selectViewListWithKey selection vals mkChild = do
179selectViewListWithKey selection vals mkChild = do
100− let selectionDemux = demux selection -- For good performance, this value must be shared across all children
180+ -- For good performance, this value must be shared across all children
181+ let selectionDemux = demux selection
101 selectChild <- listWithKey vals $ \k v -> do
182 selectChild <- listWithKey vals $ \k v -> do
102 let selected = demuxed selectionDemux k
183 let selected = demuxed selectionDemux k
103 selectSelf <- mkChild k v selected
184 selectSelf <- mkChild k v selected
104 return $ fmap ((,) k) selectSelf
185 return $ fmap ((,) k) selectSelf
105 return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
186 return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
106
187
188+-- | Like 'selectViewListWithKey' but discards the value of the list
189+-- item widget's output 'Event'.
190+selectViewListWithKey_
191+ :: forall t m k v a
107−selectViewListWithKey_ :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
192+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
193+ => Dynamic t k
108− => Dynamic t k -- ^ Current selection key
194+ -- ^ Current selection key
195+ -> Dynamic t (Map k v)
109− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
196+ -- ^ Dynamic key/value map
197+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
198+ -- ^ Function to create a widget for a given key from Dynamic value
110− -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a)) -- ^ Function to create a widget for a given key from Dynamic value and Dynamic Bool indicating if this widget is currently selected
199+ -- and Dynamic Bool indicating if this widget is currently selected
200+ -> m (Event t k)
111− -> m (Event t k) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
201+ -- ^ Event that fires when any child's return Event fires. Contains
202+ -- key of an arbitrary firing widget.
203+selectViewListWithKey_ selection vals mkChild =
112−selectViewListWithKey_ selection vals mkChild = fmap fst <$> selectViewListWithKey selection vals mkChild
204+ fmap fst <$> selectViewListWithKey selection vals mkChild
113
205
114−-- | Create a dynamically-changing set of widgets from a Dynamic key/value map.
206+-- | Create a dynamically-changing set of widgets from a Dynamic
207+-- key/value map. Unlike the 'withKey' variants, the child widgets
115−-- Unlike the 'withKey' variants, the child widgets are insensitive to which key they're associated with.
208+-- are insensitive to which key they're associated with.
209+list
116−list :: (Ord k, Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t (Map k v) -> (Dynamic t v -> m a) -> m (Dynamic t (Map k a))
210+ :: (Ord k, Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
211+ => Dynamic t (Map k v)
212+ -> (Dynamic t v -> m a)
213+ -> m (Dynamic t (Map k a))
117list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
214list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
118
215
119-- | Create a dynamically-changing set of widgets from a Dynamic list.
216-- | Create a dynamically-changing set of widgets from a Dynamic list.
217+simpleList
120−simpleList :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t [v] -> (Dynamic t v -> m a) -> m (Dynamic t [a])
218+ :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
219+ => Dynamic t [v]
220+ -> (Dynamic t v -> m a)
221+ -> m (Dynamic t [a])
222+simpleList xs mkChild =
121−simpleList xs mkChild = fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap (Map.fromList . zip [(1::Int)..]) xs
223+ fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap
224+ (Map.fromList . zip [(1 :: Int) ..])
225+ xs
src/Reflex/Dynamic.hs+51−186
@@ -17,8 +17,12 @@
17#ifdef USE_REFLEX_OPTIMIZER
17#ifdef USE_REFLEX_OPTIMIZER
18{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
18{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
19#endif
19#endif
20+-- |
21+-- Module:
22+-- Reflex.Dynamic
23+-- Description:
20−-- | This module contains various functions for working with 'Dynamic' values.
24+-- This module contains various functions for working with 'Dynamic' values.
21−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
25+-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
22module Reflex.Dynamic
26module Reflex.Dynamic
23 ( -- * Basics
27 ( -- * Basics
24 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
28 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
@@ -49,15 +53,18 @@ module Reflex.Dynamic
49 , foldDynMaybe
53 , foldDynMaybe
50 , foldDynMaybeM
54 , foldDynMaybeM
51 , joinDynThroughMap
55 , joinDynThroughMap
56+ , joinDynThroughIntMap
52 , traceDyn
57 , traceDyn
53 , traceDynWith
58 , traceDynWith
54 , splitDynPure
59 , splitDynPure
55 , distributeMapOverDynPure
60 , distributeMapOverDynPure
61+ , distributeIntMapOverDynPure
56 , distributeDMapOverDynPure
62 , distributeDMapOverDynPure
57 , distributeListOverDynPure
63 , distributeListOverDynPure
58 , Demux
64 , Demux
59 , demux
65 , demux
60 , demuxed
66 , demuxed
67+ -- * Miscellaneous
61 -- Things that probably aren't very useful:
68 -- Things that probably aren't very useful:
62 , HList (..)
69 , HList (..)
63 , FHList (..)
70 , FHList (..)
@@ -67,34 +74,14 @@ module Reflex.Dynamic
67 , AllAreFunctors (..)
74 , AllAreFunctors (..)
68 , HListPtr (..)
75 , HListPtr (..)
69 , distributeFHListOverDynPure
76 , distributeFHListOverDynPure
70− -- Unsafe
77+ -- * Unsafe
71 , unsafeDynamic
78 , unsafeDynamic
72− -- * Deprecated functions
73− , apDyn
74− , attachDyn
75− , attachDynWith
76− , attachDynWithMaybe
77− , collectDyn
78− , combineDyn
79− , distributeDMapOverDyn
80− , distributeFHListOverDyn
81− , forDyn
82− , getDemuxed
83− , joinDyn
84− , mapDyn
85− , mconcatDyn
86− , nubDyn
87− , splitDyn
88− , tagDyn
89− , uniqDyn
90− , uniqDynBy
91 ) where
79 ) where
92
80
93import Data.Functor.Compose
81import Data.Functor.Compose
94import Data.Functor.Misc
82import Data.Functor.Misc
95import Reflex.Class
83import Reflex.Class
96
84
97−import Control.Applicative ((<*>))
98import Control.Monad
85import Control.Monad
99import Control.Monad.Fix
86import Control.Monad.Fix
100import Control.Monad.Identity
87import Control.Monad.Identity
@@ -102,12 +89,14 @@ import Data.Align
102import Data.Dependent.Map (DMap)
89import Data.Dependent.Map (DMap)
103import qualified Data.Dependent.Map as DMap
90import qualified Data.Dependent.Map as DMap
104import Data.Dependent.Sum (DSum (..))
91import Data.Dependent.Sum (DSum (..))
105−import Data.Functor.Product
106−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
107import Data.Map (Map)
95import Data.Map (Map)
108import Data.Maybe
96import Data.Maybe
109−import Data.Monoid hiding (Product)
97+import Data.Monoid ((<>))
110import Data.These
98import Data.These
99+import Data.Type.Equality ((:~:) (..))
111
100
112import Debug.Trace
101import Debug.Trace
113
102
@@ -130,7 +119,7 @@ holdUniqDyn = holdUniqDynBy (==)
130holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
119holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
131holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
120holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
132
121
133−-- | Dynamic Maybe that can only update from Nothing to Just or Just to Just (i.e., cannot revert to Nothing)
122+-- | @/Dynamic Maybe/@ that can only update from @/Nothing/@ to @/Just/@ or @/Just/@ to @/Just/@ (i.e., cannot revert to @/Nothing/@)
134improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
123improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
135improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
124improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
136
125
@@ -195,9 +184,9 @@ switchDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
195switchDyn d = switch (current d)
184switchDyn d = switch (current d)
196
185
197-- | Switches to the new 'Event' whenever it receives one. Switching occurs
186-- | Switches to the new 'Event' whenever it receives one. Switching occurs
198−-- *before* the inner 'Event' fires - so if the 'Dynamic' changes and both the
187+-- __before__ the inner 'Event' fires - so if the 'Dynamic' changes and both the
199-- old and new inner Events fire simultaneously, the output will fire with the
188-- old and new inner Events fire simultaneously, the output will fire with the
200−-- value of the *new* 'Event'.
189+-- value of the __new__ 'Event'.
201--
190--
202-- Prefer 'switchDyn' to this where possible. The timing requirements that
191-- Prefer 'switchDyn' to this where possible. The timing requirements that
203-- switching before imposes are likely to bring down your app unless you are
192-- switching before imposes are likely to bring down your app unless you are
@@ -217,28 +206,30 @@ splitDynPure d = (fmap fst d, fmap snd d)
217distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
218distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
219
208
209+-- | Convert an 'IntMap' with 'Dynamic' elements into a 'Dynamic' of an 'IntMap' with
210+-- non-'Dynamic' elements.
211+distributeIntMapOverDynPure :: (Reflex t) => IntMap (Dynamic t v) -> Dynamic t (IntMap v)
212+distributeIntMapOverDynPure = fmap dmapToIntMap . distributeDMapOverDynPure . intMapWithFunctorToDMap
213+
220-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
221-- non-'Dynamic' elements, preserving the order of the elements.
215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
222distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
223−distributeListOverDynPure =
218+distributeListOverDynPure = distributeListOverDyn
224− fmap (map fromDSum . DMap.toAscList) .
225− distributeDMapOverDynPure .
226− DMap.fromDistinctAscList .
227− zipWith toDSum [0..]
228− where
229− toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
230− toDSum k v = Const2 k :=> v
231− fromDSum :: DSum (Const2 Int a) Identity -> a
232− fromDSum (Const2 _ :=> Identity v) = v
233
219
234--TODO: Generalize this to functors other than Maps
220--TODO: Generalize this to functors other than Maps
235-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
236-- with the current values of the 'Dynamic's in a map.
222-- with the current values of the 'Dynamic's in a map.
237joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
238−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 =<<)
239
230
240-- | Print the value of the 'Dynamic' when it is first read and on each
231-- | Print the value of the 'Dynamic' when it is first read and on each
241−-- subsequent change that is observed (as traceEvent), prefixed with the
232+-- subsequent change that is observed (as 'traceEvent'), prefixed with the
242-- provided string. This should /only/ be used for debugging.
233-- provided string. This should /only/ be used for debugging.
243--
234--
244-- Note: Just like Debug.Trace.trace, the value will only be shown if something
235-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -248,7 +239,7 @@ traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
248
239
249-- | Print the result of applying the provided function to the value
240-- | Print the result of applying the provided function to the value
250-- of the 'Dynamic' when it is first read and on each subsequent change
241-- of the 'Dynamic' when it is first read and on each subsequent change
251−-- that is observed (as traceEvent). This should /only/ be used for
242+-- that is observed (as 'traceEvent'). This should /only/ be used for
252-- debugging.
243-- debugging.
253--
244--
254-- Note: Just like Debug.Trace.trace, the value will only be shown if something
245-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -264,27 +255,27 @@ traceDynWith f d =
264-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
255-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
265-- each time the 'Event' occurs.
256-- each time the 'Event' occurs.
266--
257--
267−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
258+-- Note: @/tagPromptlyDyn d e/@ differs from @/tag (current d) e/@ in the case that @/e/@ is firing
268−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
259+-- at the same time that @/d/@ is changing. With @/tagPromptlyDyn d e/@, the __new__ value of @/d/@
269−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
260+-- will replace the value of @/e/@, whereas with @/tag (current d) e/@, the __old__ value
270-- will be used, since the 'Behavior' won't be updated until the end of the frame.
261-- will be used, since the 'Behavior' won't be updated until the end of the frame.
271-- Additionally, this means that the output 'Event' may not be used to directly change
262-- Additionally, this means that the output 'Event' may not be used to directly change
272−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
263+-- the input 'Dynamic', because that would mean its value depends on itself. __When creating__
273−-- cyclic data flows, generally `tag (current d) e` is preferred.
264+-- __cyclic data flows, generally @/tag (current d) e/@ is preferred.__
274tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
265tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
275tagPromptlyDyn = attachPromptlyDynWith const
266tagPromptlyDyn = attachPromptlyDynWith const
276
267
277-- | Attach the current value of the 'Dynamic' to the value of the
268-- | Attach the current value of the 'Dynamic' to the value of the
278-- 'Event' each time it occurs.
269-- 'Event' each time it occurs.
279--
270--
280−-- Note: `attachPromptlyDyn d` is not the same as `attach (current d)`. See 'tagPromptlyDyn' for details.
271+-- Note: @/attachPromptlyDyn d/@ is not the same as @/attach (current d)/@. See 'tagPromptlyDyn' for details.
281attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
272attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
282attachPromptlyDyn = attachPromptlyDynWith (,)
273attachPromptlyDyn = attachPromptlyDynWith (,)
283
274
284-- | Combine the current value of the 'Dynamic' with the value of the
275-- | Combine the current value of the 'Dynamic' with the value of the
285-- 'Event' each time it occurs.
276-- 'Event' each time it occurs.
286--
277--
287−-- Note: `attachPromptlyDynWith f d` is not the same as `attachWith f (current d)`. See 'tagPromptlyDyn' for details.
278+-- Note: @/attachPromptlyDynWith f d/@ is not the same as @/attachWith f (current d)/@. See 'tagPromptlyDyn' for details.
288attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
279attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
289attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
280attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
290
281
@@ -292,8 +283,7 @@ attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
292-- current value of the 'Dynamic' value and possibly filtering if the combining
283-- current value of the 'Dynamic' value and possibly filtering if the combining
293-- function returns 'Nothing'.
284-- function returns 'Nothing'.
294--
285--
295−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
286+-- Note: @/attachPromptlyDynWithMaybe f d/@ is not the same as @/attachWithMaybe f (current d)/@. See 'tagPromptlyDyn' for details.
296−-- (current d)`. See 'tagPromptlyDyn' for details.
297attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
287attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
298attachPromptlyDynWithMaybe f d e =
288attachPromptlyDynWithMaybe f d e =
299 let e' = attach (current d) e
289 let e' = attach (current d) e
@@ -302,8 +292,8 @@ attachPromptlyDynWithMaybe f d e =
302 These (_, b) a -> f a b -- Both events are firing, so use the newer value
292 These (_, b) a -> f a b -- Both events are firing, so use the newer value
303 That _ -> Nothing -- The tagging event isn't firing, so don't fire
293 That _ -> Nothing -- The tagging event isn't firing, so don't fire
304
294
305−-- | Factor a @Dynamic t (Maybe a)@ into a @Dynamic t (Maybe (Dynamic t a))@,
295+-- | Factor a @/Dynamic t (Maybe a)/@ into a @/Dynamic t (Maybe (Dynamic t a))/@,
306−-- such that the outer 'Dynamic' is updated only when the 'Maybe''s constructor
296+-- such that the outer 'Dynamic' is updated only when the "Maybe"'s constructor
307-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
297-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
308-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
298-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
309-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
299-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
@@ -318,6 +308,8 @@ maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
318 Left _ -> Nothing
308 Left _ -> Nothing
319 Right a -> Just a
309 Right a -> Just a
320
310
311+-- | Turns a 'Dynamic t (Either a b)' into a 'Dynamic t (Either (Dynamic t a) (Dynamic t b))' such that
312+-- the outer 'Dynamic' is updated only when the 'Either' constructor changes (e.g., from 'Left' to 'Right').
321eitherDyn :: 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)))
313eitherDyn :: 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)))
322eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
314eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
323 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
315 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
325 LeftTag :=> Compose a -> Left $ coerceDynamic a
317 LeftTag :=> Compose a -> Left $ coerceDynamic a
326 RightTag :=> Compose b -> Right $ coerceDynamic b
318 RightTag :=> Compose b -> Right $ coerceDynamic b
327
319
320+-- | Factor a 'Dynamic t DSum' into a 'Dynamic' 'DSum' containing nested 'Dynamic' values.
321+-- The outer 'Dynamic' updates only when the key of the 'DSum' changes, while the update of the inner
322+-- 'Dynamic' represents updates within the current key.
328factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k)
323factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k)
329 => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
324 => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
330factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
325factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
@@ -339,6 +334,7 @@ factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
339 inner' <- filterEventKey k (updated d)
334 inner' <- filterEventKey k (updated d)
340 inner <- holdDyn v inner'
335 inner <- holdDyn v inner'
341 return $ k :=> Compose inner
336 return $ k :=> Compose inner
337+
342--------------------------------------------------------------------------------
338--------------------------------------------------------------------------------
343-- Demux
339-- Demux
344--------------------------------------------------------------------------------
340--------------------------------------------------------------------------------
@@ -352,7 +348,7 @@ factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
352--
348--
353-- > demuxed (demux d) k === fmap (== k) d
349-- > demuxed (demux d) k === fmap (== k) d
354--
350--
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
356-- /O(log(n))/, rather than /O(n)/ for fmap.
352-- /O(log(n))/, rather than /O(n)/ for fmap.
357data Demux t k = Demux { demuxValue :: Behavior t k
353data Demux t k = Demux { demuxValue :: Behavior t k
358 , demuxSelector :: EventSelector t (Const2 k Bool)
354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -506,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
506
502
507-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
508-- single 'Dynamic' whose value represents all the current values of the input's
504-- single 'Dynamic' whose value represents all the current values of the input's
509−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
510collectDynPure :: ( RebuildSortedHList (HListElems b)
506collectDynPure :: ( RebuildSortedHList (HListElems b)
511 , IsHList a, IsHList b
507 , IsHList a, IsHList b
512 , AllAreFunctors (Dynamic t) (HListElems b)
508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -547,134 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
547#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
548 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
549#endif
545#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
13 ( qDynPure
13 ( qDynPure
14 , unqDyn
14 , unqDyn
15 , mkDynPure
15 , mkDynPure
16− -- * Deprecated functions
17− , qDyn
18− , mkDyn
19 ) where
16 ) where
20
17
21import Reflex.Dynamic
18import Reflex.Dynamic
@@ -23,7 +20,7 @@ import Reflex.Dynamic
23import Control.Monad.State
20import Control.Monad.State
24import Data.Data
21import Data.Data
25import Data.Generics
22import Data.Generics
26−import Data.Monoid
23+import Data.Monoid ((<>))
27import qualified Language.Haskell.Exts as Hs
24import qualified Language.Haskell.Exts as Hs
28import qualified Language.Haskell.Meta.Syntax.Translate as Hs
25import qualified Language.Haskell.Meta.Syntax.Translate as Hs
29import Language.Haskell.TH
26import Language.Haskell.TH
@@ -84,7 +81,7 @@ mkDynPure = QuasiQuoter
84 }
81 }
85
82
86mkDynExp :: String -> Q Exp
83mkDynExp :: String -> Q Exp
87−mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] }) s of
84+mkDynExp s = case Hs.parseExpWithMode Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] } s of
88 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
85 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
89 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
86 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
90 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
87 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
@@ -107,24 +104,3 @@ mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ H
107 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
104 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
108 | modName == modName' && occName == occName' = 'unqMarker
105 | modName == modName' && occName == occName' = 'unqMarker
109 reinstateUnqDyn x = x
106 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
22import Control.Monad.Exception
22import Control.Monad.Exception
23import Control.Monad.Identity
23import Control.Monad.Identity
24import Control.Monad.IO.Class
24import Control.Monad.IO.Class
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
25import Control.Monad.Reader
27import Control.Monad.Reader
26import Control.Monad.Ref
28import Control.Monad.Ref
27import Control.Monad.State.Strict
29import Control.Monad.State.Strict
@@ -34,7 +36,7 @@ import Data.IntMap (IntMap)
34import qualified Data.IntMap as IntMap
36import qualified Data.IntMap as IntMap
35import Data.Map (Map)
37import Data.Map (Map)
36import qualified Data.Map as Map
38import qualified Data.Map as Map
37−import Data.Semigroup
39+import Data.Semigroup (Semigroup(..))
38import Data.Some (Some)
40import Data.Some (Some)
39import Data.These
41import Data.These
40
42
@@ -43,16 +45,13 @@ import Reflex.Class
43import Reflex.DynamicWriter.Class
45import Reflex.DynamicWriter.Class
44import Reflex.EventWriter.Class (EventWriter, tellEvent)
46import Reflex.EventWriter.Class (EventWriter, tellEvent)
45import Reflex.Host.Class
47import Reflex.Host.Class
46−import qualified Reflex.Patch.MapWithMove as MapWithMove
48+import qualified Data.Patch.MapWithMove as MapWithMove
47import Reflex.PerformEvent.Class
49import Reflex.PerformEvent.Class
48import Reflex.PostBuild.Class
50import Reflex.PostBuild.Class
49import Reflex.Query.Class
51import Reflex.Query.Class
50import Reflex.Requester.Class
52import Reflex.Requester.Class
51import Reflex.TriggerEvent.Class
53import Reflex.TriggerEvent.Class
52
54
53−instance MonadTrans (DynamicWriterT t w) where
54− lift = DynamicWriterT . lift
55−
56mapIncrementalMapValues :: (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')
55mapIncrementalMapValues :: (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')
57mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
56mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
58
57
@@ -87,9 +86,20 @@ mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current)
87 noLongerMovedMap = Map.fromList $ fmap (, ()) noLongerMoved
86 noLongerMovedMap = Map.fromList $ fmap (, ()) noLongerMoved
88 in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
87 in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
89
88
90−-- | A basic implementation of 'MonadDynamicWriter'.
89+-- | A basic implementation of 'DynamicWriter'.
91newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT [Dynamic t w] m a }
90newtype 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+ )
93
103
94deriving instance MonadHold t m => MonadHold t (DynamicWriterT t w m)
104deriving instance MonadHold t m => MonadHold t (DynamicWriterT t w m)
95deriving instance MonadSample t m => MonadSample t (DynamicWriterT t w m)
105deriving instance MonadSample t m => MonadSample t (DynamicWriterT t w m)
@@ -115,7 +125,7 @@ runDynamicWriterT (DynamicWriterT a) = do
115 (result, ws) <- runStateT a []
125 (result, ws) <- runStateT a []
116 return (result, mconcat $ reverse ws)
126 return (result, mconcat $ reverse ws)
117
127
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
119 tellDyn w = DynamicWriterT $ modify (w :)
129 tellDyn w = DynamicWriterT $ modify (w :)
120
130
121instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
131instance 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
140 get = lift get
150 get = lift get
141 put = lift . put
151 put = lift . put
142
152
153+instance PrimMonad m => PrimMonad (DynamicWriterT t w m) where
154+ type PrimState (DynamicWriterT t w m) = PrimState m
155+ primitive = lift . primitive
156+
143newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
157newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
144
158
145-- | When the execution of a 'DynamicWriterT' action is adjusted using
159-- | 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 #-}
2{-# LANGUAGE CPP #-}
3{-# LANGUAGE CPP #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE UndecidableInstances #-}
6{-# LANGUAGE UndecidableInstances #-}
7#ifdef USE_REFLEX_OPTIMIZER
7#ifdef USE_REFLEX_OPTIMIZER
8{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
8{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
9#endif
9#endif
10module Reflex.DynamicWriter.Class
10module Reflex.DynamicWriter.Class
11− ( MonadDynamicWriter (..)
11+ ( MonadDynamicWriter
12+ , DynamicWriter(..)
12 ) where
13 ) where
13
14
14import Control.Monad.Reader (ReaderT, lift)
15import Control.Monad.Reader (ReaderT, lift)
15import Reflex.Class (Dynamic)
16import Reflex.Class (Dynamic)
16
17
18+{-# DEPRECATED MonadDynamicWriter "Use 'DynamicWriter' instead" #-}
19+-- | Type synonym for 'DynamicWriter'
20+type MonadDynamicWriter = DynamicWriter
21+
17-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
22-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
18-- and combines them monoidally to provide a 'Dynamic' result.
23-- 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
20 tellDyn :: Dynamic t w -> m ()
25 tellDyn :: Dynamic t w -> m ()
21
26
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
23 tellDyn = lift . tellDyn
28 tellDyn = lift . tellDyn
24−
src/Reflex/EventWriter/Base.hs+19−8
@@ -25,7 +25,7 @@ module Reflex.EventWriter.Base
25import Reflex.Adjustable.Class
25import Reflex.Adjustable.Class
26import Reflex.Class
26import Reflex.Class
27import Reflex.EventWriter.Class (EventWriter, tellEvent)
27import Reflex.EventWriter.Class (EventWriter, tellEvent)
28−import Reflex.DynamicWriter.Class (MonadDynamicWriter, tellDyn)
28+import Reflex.DynamicWriter.Class (DynamicWriter, tellDyn)
29import Reflex.Host.Class
29import Reflex.Host.Class
30import Reflex.PerformEvent.Class
30import Reflex.PerformEvent.Class
31import Reflex.PostBuild.Class
31import Reflex.PostBuild.Class
@@ -35,12 +35,14 @@ import Reflex.TriggerEvent.Class
35
35
36import Control.Monad.Exception
36import Control.Monad.Exception
37import Control.Monad.Identity
37import Control.Monad.Identity
38+import Control.Monad.Morph
38import Control.Monad.Primitive
39import Control.Monad.Primitive
39import Control.Monad.Reader
40import Control.Monad.Reader
40import Control.Monad.Ref
41import Control.Monad.Ref
41import Control.Monad.State.Strict
42import Control.Monad.State.Strict
42−import Data.Dependent.Map (DMap, DSum (..))
43+import Data.Dependent.Map (DMap)
43import qualified Data.Dependent.Map as DMap
44import qualified Data.Dependent.Map as DMap
45+import Data.Dependent.Sum (DSum (..))
44import Data.Functor.Compose
46import Data.Functor.Compose
45import Data.Functor.Misc
47import Data.Functor.Misc
46import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
48import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
@@ -52,7 +54,7 @@ import qualified Data.Map as Map
52import Data.Semigroup
54import Data.Semigroup
53import Data.Some (Some)
55import Data.Some (Some)
54import Data.Tuple
56import Data.Tuple
55−import Data.Type.Equality hiding (apply)
57+import Data.Type.Equality
56
58
57import Unsafe.Coerce
59import Unsafe.Coerce
58
60
@@ -96,7 +98,17 @@ data EventWriterState t w = EventWriterState
96
98
97-- | A basic implementation of 'EventWriter'.
99-- | A basic implementation of 'EventWriter'.
98newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (EventWriterState t w) m a }
100newtype 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+ )
100
112
101-- | Run a 'EventWriterT' action.
113-- | Run a 'EventWriterT' action.
102runEventWriterT :: forall t m w a. (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
114runEventWriterT :: 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
116 , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
128 , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
117 }
129 }
118
130
119−instance MonadTrans (EventWriterT t w) where
120− lift = EventWriterT . lift
121−
122instance MonadSample t m => MonadSample t (EventWriterT t w m) where
131instance MonadSample t m => MonadSample t (EventWriterT t w m) where
123 sample = lift . sample
132 sample = lift . sample
124
133
@@ -133,6 +142,8 @@ instance MonadHold t m => MonadHold t (EventWriterT t w m) where
133 buildDynamic a0 = lift . buildDynamic a0
142 buildDynamic a0 = lift . buildDynamic a0
134 {-# INLINABLE headE #-}
143 {-# INLINABLE headE #-}
135 headE = lift . headE
144 headE = lift . headE
145+ {-# INLINABLE now #-}
146+ now = lift now
136
147
137instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
148instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
138 runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
149 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
278 askQueryResult = lift askQueryResult
289 askQueryResult = lift askQueryResult
279 queryIncremental = lift . queryIncremental
290 queryIncremental = lift . queryIncremental
280
291
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
282 tellDyn = lift . tellDyn
293 tellDyn = lift . tellDyn
283
294
284instance PrimMonad m => PrimMonad (EventWriterT t w m) where
295instance PrimMonad m => PrimMonad (EventWriterT t w m) where
src/Reflex/EventWriter/Class.hs−1
@@ -2,7 +2,6 @@
2{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE UndecidableInstances #-}
5{-# LANGUAGE UndecidableInstances #-}
7#ifdef USE_REFLEX_OPTIMIZER
6#ifdef USE_REFLEX_OPTIMIZER
8{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
7{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
src/Reflex/FastWeak.hs+69−5
@@ -5,6 +5,19 @@
5{-# LANGUAGE ForeignFunctionInterface #-}
5{-# LANGUAGE ForeignFunctionInterface #-}
6{-# LANGUAGE JavaScriptFFI #-}
6{-# LANGUAGE JavaScriptFFI #-}
7#endif
7#endif
8+
9+-- |
10+-- Module:
11+-- Reflex.FastWeak
12+-- Description:
13+-- 'FastWeak' is a weak pointer to some value, and 'FastWeakTicket' ensures the value
14+-- referred to by a 'FastWeak' stays live while the ticket is held (live).
15+--
16+-- On GHC or GHCJS when not built with the @fast-weak@ cabal flag, 'FastWeak' is a wrapper
17+-- around the simple version of 'System.Mem.Weak.Weak' where the key and value are the same.
18+--
19+-- On GHCJS when built with the @fast-weak@ cabal flag, 'FastWeak' is implemented directly
20+-- in JS using @h$FastWeak@ and @h$FastWeakTicket@ which are a nonstandard part of the GHCJS RTS.
8module Reflex.FastWeak
21module Reflex.FastWeak
9 ( FastWeakTicket
22 ( FastWeakTicket
10 , FastWeak
23 , FastWeak
@@ -35,29 +48,57 @@ import System.Mem.Weak
35
48
36
49
37#ifdef GHCJS_FAST_WEAK
50#ifdef GHCJS_FAST_WEAK
51+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
52+-- can be used to get the referred to value without fear of @Nothing,
53+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
54+--
55+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeakTicket@.
38newtype FastWeakTicket a = FastWeakTicket JSVal
56newtype FastWeakTicket a = FastWeakTicket JSVal
39
57
58+-- | A reference to some value which can be garbage collected if there are only
59+-- weak references to the value left.
60+--
61+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
62+--
63+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using
64+-- 'getFastWeakTicket' if the value hasn't been collected yet.
65+--
66+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeak@.
40newtype FastWeak a = FastWeak JSVal
67newtype FastWeak a = FastWeak JSVal
41
68
42-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
69-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
43data Val a = Val { unVal :: a }
70data Val a = Val { unVal :: a }
44
71
45−-- | Coerce a JSVal that represents the heap object of a value of type 'a' into a value of type 'a'
72+-- | Coerce a JSVal that represents the heap object of a value of type @a@ into a value of type @a@
46unsafeFromRawJSVal :: JSVal -> a
73unsafeFromRawJSVal :: JSVal -> a
47unsafeFromRawJSVal v = unVal (unsafeCoerce v)
74unsafeFromRawJSVal v = unVal (unsafeCoerce v)
48
75
76+-- | Coerce a heap object of type @a@ into a 'JSVal' which represents that object.
49unsafeToRawJSVal :: a -> JSVal
77unsafeToRawJSVal :: a -> JSVal
50unsafeToRawJSVal v = unsafeCoerce (Val v)
78unsafeToRawJSVal v = unsafeCoerce (Val v)
51#else
79#else
80+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
81+-- can be used to get the referred to value without fear of @Nothing@,
82+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
52data FastWeakTicket a = FastWeakTicket
83data FastWeakTicket a = FastWeakTicket
53 { _fastWeakTicket_val :: !a
84 { _fastWeakTicket_val :: !a
54 , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
85 , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
55 }
86 }
56
87
88+-- | A reference to some value which can be garbage collected if there are only weak references to the value left.
89+--
90+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
91+--
92+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using 'getFastWeakTicket'
93+-- if the value hasn't been collected yet.
94+--
95+-- Synonymous with 'Weak'.
57type FastWeak a = Weak a
96type FastWeak a = Weak a
58#endif
97#endif
59
98
99+-- | Return the @a@ kept alive by the given 'FastWeakTicket'.
100+--
60−-- This needs to be in IO so we know that we've relinquished the ticket
101+-- This needs to be in IO so we know that we've relinquished the ticket.
61getFastWeakTicketValue :: FastWeakTicket a -> IO a
102getFastWeakTicketValue :: FastWeakTicket a -> IO a
62#ifdef GHCJS_FAST_WEAK
103#ifdef GHCJS_FAST_WEAK
63getFastWeakTicketValue t = do
104getFastWeakTicketValue t = do
@@ -69,6 +110,8 @@ foreign import javascript unsafe "$r = $1.val;" js_ticketVal :: FastWeakTicket a
69getFastWeakTicketValue = return . _fastWeakTicket_val
110getFastWeakTicketValue = return . _fastWeakTicket_val
70#endif
111#endif
71
112
113+-- | Get the value referred to by a 'FastWeak' if it hasn't yet been collected,
114+-- or @Nothing@ if it has been collected.
72getFastWeakValue :: FastWeak a -> IO (Maybe a)
115getFastWeakValue :: FastWeak a -> IO (Maybe a)
73#ifdef GHCJS_FAST_WEAK
116#ifdef GHCJS_FAST_WEAK
74getFastWeakValue w = do
117getFastWeakValue w = do
@@ -84,6 +127,9 @@ foreign import javascript unsafe "$r = ($1.ticket === null) ? null : $1.ticket.v
84getFastWeakValue = deRefWeak
127getFastWeakValue = deRefWeak
85#endif
128#endif
86
129
130+-- | Try to create a 'FastWeakTicket' for the given 'FastWeak' which will ensure the value referred
131+-- remains alive. Returns @Just@ if the value hasn't been collected
132+-- and a ticket can therefore be obtained, @Nothing@ if it's been collected.
87getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
133getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
88#ifdef GHCJS_FAST_WEAK
134#ifdef GHCJS_FAST_WEAK
89getFastWeakTicket w = do
135getFastWeakTicket w = do
@@ -103,8 +149,21 @@ getFastWeakTicket w = do
103 }
149 }
104#endif
150#endif
105
151
106−-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the associated FastWeak to actually be weak
152+-- | Create a 'FastWeakTicket' directly from a value, creating a 'FastWeak' in the process
153+-- which can be obtained with 'getFastWeakTicketValue'.
154+--
155+-- This function is marked NOINLINE so it is opaque to GHC.
156+-- If we do not do this, then GHC will sometimes fuse the constructor away
157+-- so any weak references that are attached to the ticket will have their
158+-- finalizer run. Using the opaque constructor, GHC does not see the
159+-- constructor application, so it behaves like an IORef and cannot be fused away.
160+--
161+-- The result is also evaluated to WHNF, since forcing a thunk invalidates
162+-- the weak pointer to it in some cases.
163+{-# NOINLINE mkFastWeakTicket #-}
107mkFastWeakTicket :: a -> IO (FastWeakTicket a)
164mkFastWeakTicket :: a -> IO (FastWeakTicket a)
165+-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the
166+-- associated FastWeak to actually be weak
108#ifdef GHCJS_FAST_WEAK
167#ifdef GHCJS_FAST_WEAK
109mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
168mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
110
169
@@ -119,11 +178,16 @@ mkFastWeakTicket v = do
119 }
178 }
120#endif
179#endif
121
180
181+-- | Demote a 'FastWeakTicket'; which ensures the value is alive, to a 'FastWeak' which doesn't.
182+-- Note that unless the ticket for the same 'FastWeak' is held in some other way
183+-- the value might be collected immediately.
184+getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
122-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
185-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
123#ifdef GHCJS_FAST_WEAK
186#ifdef GHCJS_FAST_WEAK
124−foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
187+foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak' :: FastWeakTicket a -> IO (FastWeak a)
188+{-# INLINE getFastWeakTicketWeak #-}
189+getFastWeakTicketWeak = getFastWeakTicketWeak'
125#else
190#else
126−getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
127getFastWeakTicketWeak = return . _fastWeakTicket_weak
191getFastWeakTicketWeak = return . _fastWeakTicket_weak
128#endif
192#endif
129
193
src/Reflex/FunctorMaybe.hs+25−21
@@ -1,43 +1,47 @@
1+{-# LANGUAGE CPP #-}
2+#if MIN_VERSION_base(4,9,0)
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE StandaloneDeriving #-}
5+#endif
6+
7+-- |
8+-- Module:
9+-- Reflex.FunctorMaybe
10+-- Description:
1−-- | This module defines the FunctorMaybe class, which extends Functors with the
11+-- This module defines the FunctorMaybe class, which extends Functors with the
2−-- ability to delete values.
12+-- ability to delete values.
3module Reflex.FunctorMaybe
13module Reflex.FunctorMaybe
4 ( FunctorMaybe (..)
14 ( FunctorMaybe (..)
5 ) where
15 ) where
6
16
7import Data.IntMap (IntMap)
17import Data.IntMap (IntMap)
8−import qualified Data.IntMap as IntMap
9import Data.Map (Map)
18import Data.Map (Map)
10−import qualified Data.Map as Map
19+#if MIN_VERSION_base(4,9,0)
20+import Data.Semigroup (Option(..))
21+#endif
11−import Data.Maybe
22+import Data.Witherable
12
23
13--TODO: See if there's a better class in the standard libraries already
24--TODO: See if there's a better class in the standard libraries already
14
25
15-- | A class for values that combines filtering and mapping using 'Maybe'.
26-- | A class for values that combines filtering and mapping using 'Maybe'.
16−-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@. Also similar is the
27+-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@.
17−-- @Witherable@ typeclass, but it requires @Foldable f@ and @Traverable f@,
28+{-# DEPRECATED FunctorMaybe "Use 'Filterable' from Data.Witherable instead" #-}
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@
27class FunctorMaybe f where
29class FunctorMaybe f where
28 -- | Combined mapping and filtering function.
30 -- | Combined mapping and filtering function.
29 fmapMaybe :: (a -> Maybe b) -> f a -> f b
31 fmapMaybe :: (a -> Maybe b) -> f a -> f b
30
32
31−-- | @fmapMaybe = (=<<)
32instance FunctorMaybe Maybe where
33instance FunctorMaybe Maybe where
33− fmapMaybe = (=<<)
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
34
39
35−-- | @fmapMaybe = mapMaybe@
36instance FunctorMaybe [] where
40instance FunctorMaybe [] where
37 fmapMaybe = mapMaybe
41 fmapMaybe = mapMaybe
38
42
39instance FunctorMaybe (Map k) where
43instance FunctorMaybe (Map k) where
40− fmapMaybe = Map.mapMaybe
44+ fmapMaybe = mapMaybe
41
45
42instance FunctorMaybe IntMap where
46instance FunctorMaybe IntMap where
43− fmapMaybe = IntMap.mapMaybe
47+ fmapMaybe = mapMaybe
src/Reflex/Host/Class.hs−1
@@ -4,7 +4,6 @@
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE GADTs #-}
6{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE RankNTypes #-}
7{-# LANGUAGE RankNTypes #-}
9{-# LANGUAGE RoleAnnotations #-}
8{-# LANGUAGE RoleAnnotations #-}
10{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
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 @@
3#ifdef USE_REFLEX_OPTIMIZER
3#ifdef USE_REFLEX_OPTIMIZER
4{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
4{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
5#endif
5#endif
6+-- |
7+-- Module:
8+-- Reflex.Network
9+-- Description:
10+-- This module provides combinators for building FRP graphs/networks and modifying them dynamically.
6module Reflex.Network
11module Reflex.Network
7 ( networkView
12 ( networkView
8 , networkHold
13 , networkHold
@@ -14,16 +19,17 @@ import Reflex.Adjustable.Class
14import Reflex.NotReady.Class
19import Reflex.NotReady.Class
15import Reflex.PostBuild.Class
20import Reflex.PostBuild.Class
16
21
17−-- | Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
22+-- | A 'Dynamic' "network": Takes a 'Dynamic' of network-creating actions and replaces the network whenever the 'Dynamic' updates.
18−-- The returned Event of network results occurs when the Dynamic does.
23+-- The returned Event of network results fires at post-build time and when the 'Dynamic' updates.
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').
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').
20networkView :: (NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
26networkView :: (NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
21networkView child = do
27networkView child = do
22 postBuild <- getPostBuild
28 postBuild <- getPostBuild
23 let newChild = leftmost [updated child, tagCheap (current child) postBuild]
29 let newChild = leftmost [updated child, tagCheap (current child) postBuild]
24 snd <$> runWithReplace notReady newChild
30 snd <$> runWithReplace notReady newChild
25
31
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.
27-- The returned Dynamic of network results occurs when the Event does.
33-- The returned Dynamic of network results occurs when the Event does.
28-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
34-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
29networkHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
35networkHold :: (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 @@
3{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE TypeFamilies #-}
6{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE UndecidableInstances #-}
7{-# LANGUAGE UndecidableInstances #-}
9#ifdef USE_REFLEX_OPTIMIZER
8#ifdef USE_REFLEX_OPTIMIZER
@@ -15,7 +14,9 @@ module Reflex.NotReady.Class
15
14
16import Control.Monad.Reader (ReaderT)
15import Control.Monad.Reader (ReaderT)
17import Control.Monad.Trans
16import Control.Monad.Trans
17+import Control.Monad.Trans.Writer (WriterT)
18
18
19+import Reflex.BehaviorWriter.Base (BehaviorWriterT)
19import Reflex.Class
20import Reflex.Class
20import Reflex.DynamicWriter.Base (DynamicWriterT)
21import Reflex.DynamicWriter.Base (DynamicWriterT)
21import Reflex.EventWriter.Base (EventWriterT)
22import Reflex.EventWriter.Base (EventWriterT)
@@ -39,6 +40,10 @@ instance NotReady t m => NotReady t (ReaderT r m) where
39 notReadyUntil = lift . notReadyUntil
40 notReadyUntil = lift . notReadyUntil
40 notReady = lift notReady
41 notReady = lift notReady
41
42
43+instance (NotReady t m, Monoid w) => NotReady t (WriterT w m) where
44+ notReadyUntil = lift . notReadyUntil
45+ notReady = lift notReady
46+
42instance NotReady t m => NotReady t (PostBuildT t m) where
47instance NotReady t m => NotReady t (PostBuildT t m) where
43 notReadyUntil = lift . notReadyUntil
48 notReadyUntil = lift . notReadyUntil
44 notReady = lift notReady
49 notReady = lift notReady
@@ -51,6 +56,10 @@ instance NotReady t m => NotReady t (DynamicWriterT t w m) where
51 notReadyUntil = lift . notReadyUntil
56 notReadyUntil = lift . notReadyUntil
52 notReady = lift notReady
57 notReady = lift notReady
53
58
59+instance NotReady t m => NotReady t (BehaviorWriterT t w m) where
60+ notReadyUntil = lift . notReadyUntil
61+ notReady = lift notReady
62+
54instance NotReady t m => NotReady t (QueryT t q m) where
63instance NotReady t m => NotReady t (QueryT t q m) where
55 notReadyUntil = lift . notReadyUntil
64 notReadyUntil = lift . notReadyUntil
56 notReady = lift notReady
65 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.
5{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
6{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE LambdaCase #-}
7{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
4+-- |
5+-- Module:
6+-- Reflex.Optimizer
7+-- Description:
8+-- This module provides a GHC plugin designed to improve code that uses
9+-- Reflex. Currently, it just adds an INLINABLE pragma to any top-level
10+-- definition that doesn't have an explicit inlining pragma. In the future,
11+-- additional optimizations are likely to be added.
8module Reflex.Optimizer
12module Reflex.Optimizer
9 ( plugin
13 ( plugin
10 ) where
14 ) where
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−68
@@ -1,68 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE PolyKinds #-}
4−{-# LANGUAGE Rank2Types #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE StandaloneDeriving #-}
7−{-# LANGUAGE TypeFamilies #-}
8−module Reflex.Patch.DMap where
9−
10−import Reflex.Patch.Class
11−import Reflex.Patch.IntMap
12−import Reflex.Patch.Map
13−
14−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
15−import qualified Data.Dependent.Map as DMap
16−import Data.Functor.Constant
17−import Data.Functor.Misc
18−import qualified Data.IntMap as IntMap
19−import qualified Data.Map as Map
20−import Data.Semigroup (Semigroup (..))
21−import Data.Some (Some)
22−
23−-- | A set of changes to a 'DMap'. Any element may be inserted/updated or
24−-- deleted.
25−newtype PatchDMap k v = PatchDMap { unPatchDMap :: DMap k (ComposeMaybe v) }
26−
27−deriving instance GCompare k => Semigroup (PatchDMap k v)
28−
29−deriving instance GCompare k => Monoid (PatchDMap k v)
30−
31−instance GCompare k => Patch (PatchDMap k v) where
32− type PatchTarget (PatchDMap k v) = DMap k v
33− apply (PatchDMap diff) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
34− where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
35− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
36− nothingToJust = \case
37− Nothing -> Just $ Constant ()
38− Just _ -> Nothing
39−
40−mapPatchDMap :: (forall a. v a -> v' a) -> PatchDMap k v -> PatchDMap k v'
41−mapPatchDMap f (PatchDMap p) = PatchDMap $ DMap.map (ComposeMaybe . fmap f . getComposeMaybe) p
42−
43−traversePatchDMap :: Applicative m => (forall a. v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
44−traversePatchDMap f = traversePatchDMapWithKey $ const f
45−
46−traversePatchDMapWithKey :: Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
47−traversePatchDMapWithKey f (PatchDMap p) = PatchDMap <$> DMap.traverseWithKey (\k (ComposeMaybe v) -> ComposeMaybe <$> traverse (f k) v) p
48−
49−weakenPatchDMapWith :: (forall a. v a -> v') -> PatchDMap k v -> PatchMap (Some k) v'
50−weakenPatchDMapWith f (PatchDMap p) = PatchMap $ weakenDMapWith (fmap f . getComposeMaybe) p
51−
52−patchDMapToPatchMapWith :: (f v -> v') -> PatchDMap (Const2 k v) f -> PatchMap k v'
53−patchDMapToPatchMapWith f (PatchDMap p) = PatchMap $ dmapToMapWith (fmap f . getComposeMaybe) p
54−
55−const2PatchDMapWith :: forall k v f a. (v -> f a) -> PatchMap k v -> PatchDMap (Const2 k a) f
56−const2PatchDMapWith f (PatchMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
57− where g :: (k, Maybe v) -> DSum (Const2 k a) (ComposeMaybe f)
58− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
59−
60−const2IntPatchDMapWith :: forall v f a. (v -> f a) -> PatchIntMap v -> PatchDMap (Const2 IntMap.Key a) f
61−const2IntPatchDMapWith f (PatchIntMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> IntMap.toAscList p
62− where g :: (IntMap.Key, Maybe v) -> DSum (Const2 IntMap.Key a) (ComposeMaybe f)
63− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
64−
65−-- | Get the values that will be deleted if the given patch is applied to the
66−-- given 'DMap'. Includes values that will be replaced.
67−getDeletions :: GCompare k => PatchDMap k v -> DMap k v' -> DMap k v'
68−getDeletions (PatchDMap p) m = DMap.intersectionWithKey (\_ v _ -> v) m p
src/Reflex/Patch/DMapWithMove.hsdeleted−363
@@ -1,363 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE Rank2Types #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−
14−-- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
15−-- move values between keys.
16−module Reflex.Patch.DMapWithMove where
17−
18−import Reflex.Patch.Class
19−import Reflex.Patch.MapWithMove (PatchMapWithMove (..))
20−import qualified Reflex.Patch.MapWithMove as MapWithMove
21−
22−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
23−import qualified Data.Dependent.Map as DMap
24−import Data.Dependent.Sum (EqTag (..))
25−import Data.Functor.Constant
26−import Data.Functor.Misc
27−import Data.Functor.Product
28−import Data.GADT.Compare (GEq (..))
29−import Data.GADT.Show (GShow, gshow)
30−import qualified Data.Map as Map
31−import Data.Maybe
32−import Data.Semigroup (Semigroup (..), (<>))
33−import Data.Some (Some)
34−import qualified Data.Some as Some
35−import Data.These
36−
37−-- | Like 'PatchMapWithMove', but for 'DMap'. Each key carries a 'NodeInfo' which describes how it will be changed by the patch and connects move sources and
38−-- destinations.
39−--
40−-- Invariants:
41−--
42−-- * A key should not move to itself.
43−-- * A move should always be represented with both the destination key (as a 'From_Move') and the source key (as a @'ComposeMaybe' ('Just' destination)@)
44−newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
45−
46−-- |Structure which represents what changes apply to a particular key. @_nodeInfo_from@ specifies what happens to this key, and in particular what other key
47−-- the current key is moving from, while @_nodeInfo_to@ specifies what key the current key is moving to if involved in a move.
48−data NodeInfo k v a = NodeInfo
49− { _nodeInfo_from :: !(From k v a)
50− -- ^Change applying to the current key, be it an insert, move, or delete.
51− , _nodeInfo_to :: !(To k a)
52− -- ^Where this key is moving to, if involved in a move. Should only be @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
53− }
54− deriving (Show)
55−
56−-- |Structure describing a particular change to a key, be it inserting a new key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting a
57−-- key (@From_Delete@), or moving a key (@From_Move@).
58−data From (k :: a -> *) (v :: a -> *) :: a -> * where
59− -- |Insert a new or update an existing key with the given value @v a@
60− From_Insert :: v a -> From k v a
61− -- |Delete the existing key
62− From_Delete :: From k v a
63− -- |Move the value from the given key @k a@ to this key. The source key should also have an entry in the patch giving the current key as @_nodeInfo_to@,
64− -- usually but not necessarily with @From_Delete@.
65− From_Move :: !(k a) -> From k v a
66− deriving (Show, Read, Eq, Ord)
67−
68−-- |Type alias for the "to" part of a 'NodeInfo'. @'ComposeMaybe' ('Just' k)@ means the key is moving to another key, @ComposeMaybe Nothing@ for any other
69−-- operation.
70−type To = ComposeMaybe
71−
72−-- |Test whether a 'PatchDMapWithMove' satisfies its invariants.
73−validPatchDMapWithMove :: forall k v. (GCompare k, 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−instance EqTag k (NodeInfo k v) => Eq (PatchDMapWithMove k v) where
108− PatchDMapWithMove a == PatchDMapWithMove b = a == b
109−
110−-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
111−data Pair1 f g a = Pair1 (f a) (g a)
112−
113−-- |Helper data structure used for composing patches using the monoid instance.
114−data Fixup k v a
115− = Fixup_Delete
116− | Fixup_Update (These (From k v a) (To k a))
117−
118−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
119−instance GCompare k => Semigroup (PatchDMapWithMove k v) where
120− PatchDMapWithMove ma <> PatchDMapWithMove mb = PatchDMapWithMove m
121− where
122− connections = DMap.toList $ DMap.intersectionWithKey (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b)) ma mb
123− h :: DSum k (Pair1 (ComposeMaybe k) (From k v)) -> [DSum k (Fixup k v)]
124− h (_ :=> Pair1 (ComposeMaybe mToAfter) editBefore) = case (mToAfter, editBefore) of
125− (Just toAfter, From_Move fromBefore)
126− | isJust $ fromBefore `geq` toAfter
127− -> [toAfter :=> Fixup_Delete]
128− | otherwise
129− -> [ toAfter :=> Fixup_Update (This editBefore)
130− , fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))
131− ]
132− (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
133− (Just toAfter, _) -> [toAfter :=> Fixup_Update (This editBefore)]
134− (Nothing, _) -> []
135− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
136− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
137− | This x <- a, That y <- b
138− = Fixup_Update $ These x y
139− | That y <- a, This x <- b
140− = Fixup_Update $ These x y
141− mergeFixups _ _ _ = error "PatchDMapWithMove: incompatible fixups"
142− fixups = DMap.fromListWithKey mergeFixups $ concatMap h connections
143− combineNodeInfos _ nia nib = NodeInfo
144− { _nodeInfo_from = _nodeInfo_from nia
145− , _nodeInfo_to = _nodeInfo_to nib
146− }
147− applyFixup _ ni = \case
148− Fixup_Delete -> Nothing
149− Fixup_Update u -> Just $ NodeInfo
150− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
151− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
152− }
153− m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
154− getHere :: These a b -> Maybe a
155− getHere = \case
156− This a -> Just a
157− These a _ -> Just a
158− That _ -> Nothing
159− getThere :: These a b -> Maybe b
160− getThere = \case
161− This _ -> Nothing
162− These _ b -> Just b
163− That b -> Just b
164−
165−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
166−instance GCompare k => Monoid (PatchDMapWithMove k v) where
167− mempty = PatchDMapWithMove mempty
168− mappend = (<>)
169−
170−{-
171−mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
172−PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
173− where
174− 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
175− removeRedundantDst toKey (From_Move fromKey) | isJust (toKey `geq` fromKey) = Nothing
176− removeRedundantDst _ a = Just a
177− f :: forall a. k a -> From k v a -> Maybe (From k v a)
178− f toKey _ = removeRedundantDst toKey $ case getDstAction toKey dstAfter of
179− From_Move fromKey -> getDstAction fromKey dstBefore
180− nonMove -> nonMove
181− dst = DMap.mapMaybeWithKey f $ DMap.union dstAfter dstBefore
182− getSrcAction k m = fromMaybe (ComposeMaybe $ Just k) $ DMap.lookup k m
183− removeRedundantSrc fromKey (ComposeMaybe (Just toKey)) | isJust (fromKey `geq` toKey) = Nothing
184− removeRedundantSrc _ a = Just a
185− g :: forall a. k a -> ComposeMaybe k a -> Maybe (ComposeMaybe k a)
186− g fromKey _ = removeRedundantSrc fromKey $ case getSrcAction fromKey srcBefore of
187− ComposeMaybe Nothing -> ComposeMaybe Nothing
188− ComposeMaybe (Just toKeyBefore) -> getSrcAction toKeyBefore srcAfter
189− src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
190−-}
191−
192−-- |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'.
193−insertDMapKey :: k a -> v a -> PatchDMapWithMove k v
194−insertDMapKey k v =
195− PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
196−
197−-- |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:
198−--
199−-- @
200−-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
201−-- @
202−moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
203−moveDMapKey src dst = case src `geq` dst of
204− Nothing -> PatchDMapWithMove $ DMap.fromList
205− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
206− , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
207− ]
208− Just _ -> mempty
209−
210−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
211−--
212−-- @
213−-- let aMay = DMap.lookup a dmap
214−-- bMay = DMap.lookup b dmap
215−-- in maybe id (DMap.insert a) (bMay `mplus` aMay)
216−-- . maybe id (DMap.insert b) (aMay `mplus` bMay)
217−-- . DMap.delete a . DMap.delete b $ dmap
218−-- @
219−swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
220−swapDMapKey src dst = case src `geq` dst of
221− Nothing -> PatchDMapWithMove $ DMap.fromList
222− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe $ Just src)
223− , src :=> NodeInfo (From_Move dst) (ComposeMaybe $ Just dst)
224− ]
225− Just _ -> mempty
226−
227−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'DMap.delete'.
228−deleteDMapKey :: k a -> PatchDMapWithMove k v
229−deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
230−
231−{-
232−k1, k2 :: Const2 Int () ()
233−k1 = Const2 1
234−k2 = Const2 2
235−p1, p2 :: PatchDMapWithMove (Const2 Int ()) Identity
236−p1 = moveDMapKey k1 k2
237−p2 = moveDMapKey k2 k1
238−p12 = p1 <> p2
239−p21 = p2 <> p1
240−p12Slow = p1 `mappendPatchDMapWithMoveSlow` p2
241−p21Slow = p2 `mappendPatchDMapWithMoveSlow` p1
242−
243−testPatchDMapWithMove = do
244− print p1
245− print p2
246− print $ p12 == deleteDMapKey k1
247− print $ p21 == deleteDMapKey k2
248− print $ p12Slow == deleteDMapKey k1
249− print $ p21Slow == deleteDMapKey k2
250−
251−dst (PatchDMapWithMove x _) = x
252−src (PatchDMapWithMove _ x) = x
253−-}
254−
255−-- |Extract the 'DMap' representing the patch changes from the 'PatchDMapWithMove'.
256−unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
257−unPatchDMapWithMove (PatchDMapWithMove p) = p
258−
259−-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove', without checking any invariants.
260−--
261−-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithMove' are preserved; they will not be checked.
262−unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
263−unsafePatchDMapWithMove = PatchDMapWithMove
264−
265−-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while checking invariants. If the invariants are satisfied, @Right p@ is returned
266−-- otherwise @Left errors@.
267−patchDMapWithMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
268−patchDMapWithMove dm =
269− case validationErrorsForPatchDMapWithMove dm of
270− [] -> Right $ unsafePatchDMapWithMove dm
271− errs -> Left errs
272−
273−-- |Map a natural transform @v -> v'@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
274−mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
275−mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $
276− DMap.map (\ni -> ni { _nodeInfo_from = g $ _nodeInfo_from ni }) p
277− where g :: forall a. From k v a -> From k v' a
278− g = \case
279− From_Insert v -> From_Insert $ f v
280− From_Delete -> From_Delete
281− From_Move k -> From_Move k
282−
283−-- |Traverse an effectful function @forall a. v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
284−traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
285−traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
286−
287−-- |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')@.
288−traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
289−traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
290− where g :: forall a. k a -> From k v a -> m (From k v' a)
291− g k = \case
292− From_Insert v -> From_Insert <$> f k v
293− From_Delete -> pure From_Delete
294− From_Move fromKey -> pure $ From_Move fromKey
295−
296−-- |Map a function which transforms @'From' k v a@ into a @'From' k v' a@ over a @'NodeInfo' k v a@.
297−nodeInfoMapFrom :: (From k v a -> From k v' a) -> NodeInfo k v a -> NodeInfo k v' a
298−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
299−
300−-- |Map an effectful function which transforms @'From' k v a@ into a @f ('From' k v' a)@ over a @'NodeInfo' k v a@.
301−nodeInfoMapFromM :: Functor f => (From k v a -> f (From k v' a)) -> NodeInfo k v a -> f (NodeInfo k v' a)
302−nodeInfoMapFromM f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
303−
304−-- |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
305−-- values.
306−weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) v'
307−weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
308− where g :: forall a. NodeInfo k v a -> MapWithMove.NodeInfo (Some k) v'
309− g ni = MapWithMove.NodeInfo
310− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
311− From_Insert v -> MapWithMove.From_Insert $ f v
312− From_Delete -> MapWithMove.From_Delete
313− From_Move k -> MapWithMove.From_Move $ Some.This k
314− , MapWithMove._nodeInfo_to = Some.This <$> getComposeMaybe (_nodeInfo_to ni)
315− }
316−
317−-- |"Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
318−-- dependency in the typing and all points are already @a@, hence the function to map each value to @v'@ is not higher rank.
319−patchDMapWithMoveToPatchMapWithMoveWith :: forall k v v' a. (v a -> v') -> PatchDMapWithMove (Const2 k a) v -> PatchMapWithMove k v'
320−patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
321− where g :: NodeInfo (Const2 k a) v a -> MapWithMove.NodeInfo k v'
322− g ni = MapWithMove.NodeInfo
323− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
324− From_Insert v -> MapWithMove.From_Insert $ f v
325− From_Delete -> MapWithMove.From_Delete
326− From_Move (Const2 k) -> MapWithMove.From_Move k
327− , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
328− }
329−
330−-- |"Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove ('Const2' k a)@; that is, turn a non-dependently-typed patch into a dependently typed
331−-- one but which always has a constant key type represented by 'Const2'. Apply the given function to each @v@ to produce a @v' a@.
332−-- Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
333−const2PatchDMapWithMoveWith :: forall k v v' a. (v -> v' a) -> PatchMapWithMove k v -> PatchDMapWithMove (Const2 k a) v'
334−const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
335− where g :: (k, MapWithMove.NodeInfo k v) -> DSum (Const2 k a) (NodeInfo (Const2 k a) v')
336− g (k, ni) = Const2 k :=> NodeInfo
337− { _nodeInfo_from = case MapWithMove._nodeInfo_from ni of
338− MapWithMove.From_Insert v -> From_Insert $ f v
339− MapWithMove.From_Delete -> From_Delete
340− MapWithMove.From_Move fromKey -> From_Move $ Const2 fromKey
341− , _nodeInfo_to = ComposeMaybe $ Const2 <$> MapWithMove._nodeInfo_to ni
342− }
343−
344−instance GCompare k => Patch (PatchDMapWithMove k v) where
345− type PatchTarget (PatchDMapWithMove k v) = DMap k v
346− 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?
347− where insertions = DMap.mapMaybeWithKey insertFunc p
348− insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
349− insertFunc _ ni = case _nodeInfo_from ni of
350− From_Insert v -> Just v
351− From_Move k -> DMap.lookup k old
352− From_Delete -> Nothing
353− deletions = DMap.mapMaybeWithKey deleteFunc p
354− deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
355− deleteFunc _ ni = case _nodeInfo_from ni of
356− From_Delete -> Just $ Constant ()
357− _ -> Nothing
358−
359−-- | Get the values that will be deleted or moved if the given patch is applied
360−-- to the given 'DMap'.
361−getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
362−getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
363− where f _ v ni = Pair v $ _nodeInfo_to ni
src/Reflex/Patch/IntMap.hsdeleted−49
@@ -1,49 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFoldable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE DeriveTraversable #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE TypeFamilies #-}
7−module Reflex.Patch.IntMap where
8−
9−import Data.IntMap.Strict (IntMap)
10−import qualified Data.IntMap.Strict as IntMap
11−import Data.Maybe
12−import Data.Semigroup
13−import Reflex.Patch.Class
14−
15−newtype PatchIntMap a = PatchIntMap (IntMap (Maybe a)) deriving (Functor, Foldable, Traversable, Monoid)
16−
17−instance Patch (PatchIntMap a) where
18− type PatchTarget (PatchIntMap a) = IntMap a
19− apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
20− let removes = IntMap.filter isNothing p
21− adds = IntMap.mapMaybe id p
22− in IntMap.union adds $ v `IntMap.difference` removes
23−
24−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
25−-- If the same key is modified by both patches, the one on the left will take
26−-- precedence.
27−instance Semigroup (PatchIntMap v) where
28− PatchIntMap a <> PatchIntMap b = PatchIntMap $ a `mappend` b --TODO: Add a semigroup instance for Map
29− -- PatchMap is idempotent, so stimes n is id for every n
30−#if MIN_VERSION_semigroups(0,17,0)
31− stimes = stimesIdempotentMonoid
32−#else
33− times1p n x = case compare n 0 of
34− LT -> error "stimesIdempotentMonoid: negative multiplier"
35− EQ -> mempty
36− GT -> x
37−#endif
38−
39−traverseIntMapPatchWithKey :: Applicative t => (Int -> a -> t b) -> PatchIntMap a -> t (PatchIntMap b)
40−traverseIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap <$> IntMap.traverseWithKey (\k mv -> traverse (f k) mv) m
41−
42−patchIntMapNewElements :: PatchIntMap a -> [a]
43−patchIntMapNewElements (PatchIntMap m) = catMaybes $ IntMap.elems m
44−
45−patchIntMapNewElementsMap :: PatchIntMap a -> IntMap a
46−patchIntMapNewElementsMap (PatchIntMap m) = IntMap.mapMaybe id m
47−
48−getDeletions :: PatchIntMap v -> IntMap v' -> IntMap v'
49−getDeletions (PatchIntMap m) v = IntMap.intersection v m
src/Reflex/Patch/Map.hsdeleted−64
@@ -1,64 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE TypeFamilies #-}
4−-- | 'Patch'es on 'Map' that consist only of insertions (including overwrites)
5−-- and deletions
6−module Reflex.Patch.Map where
7−
8−import Reflex.Patch.Class
9−
10−import Data.Map (Map)
11−import qualified Data.Map as Map
12−import Data.Maybe
13−import Data.Semigroup
14−
15−-- | A set of changes to a 'Map'. Any element may be inserted/updated or
16−-- deleted. Insertions are represented as values wrapped in 'Just', while
17−-- deletions are represented as 'Nothing's
18−newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
19− deriving (Show, Read, Eq, Ord)
20−
21−-- | Applying a 'PatchMap' will update the 'Map' by performing the insertions
22−-- and deletions specified
23−instance Ord k => Patch (PatchMap k v) where
24− type PatchTarget (PatchMap k v) = Map k v
25− {-# INLINABLE apply #-}
26− apply (PatchMap p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
27− where insertions = Map.mapMaybeWithKey (const id) p
28− deletions = Map.mapMaybeWithKey (const nothingToJust) p
29− nothingToJust = \case
30− Nothing -> Just ()
31− Just _ -> Nothing
32−
33−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
34−-- If the same key is modified by both patches, the one on the left will take
35−-- precedence.
36−instance Ord k => Semigroup (PatchMap k v) where
37− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
38− -- PatchMap is idempotent, so stimes n is id for every n
39−#if MIN_VERSION_semigroups(0,17,0)
40− stimes = stimesIdempotentMonoid
41−#else
42− times1p n x = case compare n 0 of
43− LT -> error "stimesIdempotentMonoid: negative multiplier"
44− EQ -> mempty
45− GT -> x
46−#endif
47−
48−-- | The empty 'PatchMap' contains no insertions or deletions
49−instance Ord k => Monoid (PatchMap k v) where
50− mempty = PatchMap mempty
51− mappend = (<>)
52−
53−-- | 'fmap'ping a 'PatchMap' will alter all of the values it will insert.
54−-- Deletions are unaffected.
55−instance Functor (PatchMap k) where
56− fmap f = PatchMap . fmap (fmap f) . unPatchMap
57−
58−-- | Returns all the new elements that will be added to the 'Map'
59−patchMapNewElements :: PatchMap k v -> [v]
60−patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
61−
62−-- | Returns all the new elements that will be added to the 'Map'
63−patchMapNewElementsMap :: PatchMap k v -> Map k v
64−patchMapNewElementsMap (PatchMap p) = Map.mapMaybe id p
src/Reflex/Patch/MapWithMove.hsdeleted−228
@@ -1,228 +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
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−-- | Create a 'PatchMapWithMove', validating it
45−patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
46−patchMapWithMove m = if valid then Just $ PatchMapWithMove m else Nothing
47− where valid = forwardLinks == backwardLinks
48− forwardLinks = Map.mapMaybe _nodeInfo_to m
49− backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, v) ->
50− case _nodeInfo_from v of
51− From_Move from -> Just (from, to)
52− _ -> Nothing
53−
54−-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
55−patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
56−patchMapWithMoveInsertAll m = PatchMapWithMove $ flip fmap m $ \v -> NodeInfo
57− { _nodeInfo_from = From_Insert v
58− , _nodeInfo_to = Nothing
59− }
60−
61−-- | Extract the internal representation of the 'PatchMapWithMove'
62−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
63−unPatchMapWithMove (PatchMapWithMove p) = p
64−
65−-- | Warning: when using this function, you must ensure that the invariants of
66−-- 'PatchMapWithMove' are preserved; they will not be checked.
67−unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
68−unsafePatchMapWithMove = PatchMapWithMove
69−
70−-- | Describe how a key's new value should be produced
71−data From k v
72− = From_Insert v -- ^ Insert the given value here
73− | From_Delete -- ^ Delete the existing value, if any, from here
74− | From_Move !k -- ^ Move the value here from the given key
75− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
76−
77−-- | Describe where a key's old value will go. If this is 'Just', that means
78−-- the key's old value will be moved to the given other key; if it is 'Nothing',
79−-- that means it will be deleted.
80−type To = Maybe
81−
82−-- | Apply the insertions, deletions, and moves to a given 'Map'
83−instance Ord k => Patch (PatchMapWithMove k v) where
84− type PatchTarget (PatchMapWithMove k v) = Map k v
85− 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?
86− where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
87− From_Insert v -> Just v
88− From_Move k -> Map.lookup k old
89− From_Delete -> Nothing
90− deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
91− From_Delete -> Just ()
92− _ -> Nothing
93−
94−-- | Returns all the new elements that will be added to the 'Map'
95−patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
96−patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
97−
98−patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
99−patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
100− where f ni = case _nodeInfo_from ni of
101− From_Insert v -> Just v
102− From_Move _ -> Nothing
103− From_Delete -> Nothing
104−
105−-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
106−-- its values using the given ordering function. The set keys of the 'Map' is
107−-- not changed.
108−patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
109−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
110− where unsorted = Map.toList m
111− sorted = sortBy (cmp `on` snd) unsorted
112− f (to, _) (from, _) = if to == from then Nothing else
113− Just (from, to)
114− reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
115− g (to, _) (from, _) = if to == from then Nothing else
116− let Just movingTo = Map.lookup from reverseMapping
117− in Just (to, NodeInfo (From_Move from) $ Just movingTo)
118−
119−-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
120−-- will produce a 'Map' with the same values as the second 'Map' but with the
121−-- values sorted with the given ordering function.
122−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
123−patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
124− where newList = Map.toList newByIndexUnsorted
125− newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
126−
127−-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
128−-- will produce the second 'Map'.
129−patchThatChangesMap :: (Ord k, Ord v) => Map k v -> Map k v -> PatchMapWithMove k v
130−patchThatChangesMap oldByIndex newByIndex = patch
131− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
132− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
133− let f k v = do
134− remainingValues <- get
135− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
136− then Map.delete v remainingValues
137− else Map.insert v remainingKeys remainingValues
138− case Map.lookup v remainingValues of
139− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
140− Just fromKs ->
141− if k `Set.member` fromKs
142− then do
143− putRemainingKeys $ Set.delete k fromKs
144− return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
145− else do
146− (fromK, remainingKeys) <- return . fromJust $ Set.minView fromKs -- There's an existing value, but it's not here; move it here
147− putRemainingKeys remainingKeys
148− return $ NodeInfo (From_Move fromK) $ Just undefined
149− Map.traverseWithKey f newByIndex
150− unusedOldKeys = fold unusedValuesByValue
151− pointlessMove k = \case
152− From_Move k' | k == k' -> True
153− _ -> False
154− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
155− then Just undefined
156− else Nothing
157− 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
158−
159−-- | Change the 'From' value of a 'NodeInfo'
160−nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
161−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
162−
163−-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
164−-- 'Applicative', 'Monad', etc.) action to get the new value
165−nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
166−nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
167−
168−-- | Set the 'To' field of a 'NodeInfo'
169−nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
170−nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
171−
172−-- |Helper data structure used for composing patches using the monoid instance.
173−data Fixup k v
174− = Fixup_Delete
175− | Fixup_Update (These (From k v) (To k))
176−
177−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
178−instance Ord k => Semigroup (PatchMapWithMove k v) where
179− PatchMapWithMove ma <> PatchMapWithMove mb = PatchMapWithMove m
180− where
181− connections = Map.toList $ Map.intersectionWithKey (\_ a b -> (_nodeInfo_to a, _nodeInfo_from b)) ma mb
182− h :: (k, (Maybe k, From k v)) -> [(k, Fixup k v)]
183− h (_, (mToAfter, editBefore)) = case (mToAfter, editBefore) of
184− (Just toAfter, From_Move fromBefore)
185− | fromBefore == toAfter
186− -> [(toAfter, Fixup_Delete)]
187− | otherwise
188− -> [ (toAfter, Fixup_Update (This editBefore))
189− , (fromBefore, Fixup_Update (That mToAfter))
190− ]
191− (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
192− (Just toAfter, _) -> [(toAfter, Fixup_Update (This editBefore))]
193− (Nothing, _) -> []
194− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
195− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
196− | This x <- a, That y <- b
197− = Fixup_Update $ These x y
198− | That y <- a, This x <- b
199− = Fixup_Update $ These x y
200− mergeFixups _ _ _ = error "PatchMapWithMove: incompatible fixups"
201− fixups = Map.fromListWithKey mergeFixups $ concatMap h connections
202− combineNodeInfos _ nia nib = NodeInfo
203− { _nodeInfo_from = _nodeInfo_from nia
204− , _nodeInfo_to = _nodeInfo_to nib
205− }
206− applyFixup _ ni = \case
207− Fixup_Delete -> Nothing
208− Fixup_Update u -> Just $ NodeInfo
209− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
210− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
211− }
212− m = Map.differenceWithKey applyFixup (Map.unionWithKey combineNodeInfos ma mb) fixups
213− getHere :: These a b -> Maybe a
214− getHere = \case
215− This a -> Just a
216− These a _ -> Just a
217− That _ -> Nothing
218− getThere :: These a b -> Maybe b
219− getThere = \case
220− This _ -> Nothing
221− These _ b -> Just b
222− That b -> Just b
223−
224−--TODO: Figure out how to implement this in terms of PatchDMapWithMove rather than duplicating it here
225−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
226−instance Ord k => Monoid (PatchMapWithMove k v) where
227− mempty = PatchMapWithMove mempty
228− mappend = (<>)
src/Reflex/PerformEvent/Base.hs+3−1
@@ -141,7 +141,7 @@ hostPerformEventT a = do
141 case mToPerform of
141 case mToPerform of
142 Nothing -> return [result']
142 Nothing -> return [result']
143 Just toPerform -> do
143 Just toPerform -> do
144− responses <- runHostFrame $ traverseRequesterData (\v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
145 mrt <- readRef responseTrigger
145 mrt <- readRef responseTrigger
146 let followupEventTriggers = case mrt of
146 let followupEventTriggers = case mrt of
147 Just rt -> [rt :=> Identity responses]
147 Just rt -> [rt :=> Identity responses]
@@ -164,6 +164,8 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
165 {-# INLINABLE headE #-}
165 {-# INLINABLE headE #-}
166 headE = PerformEventT . lift . headE
166 headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
167
169
168instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
169 type Ref (PerformEventT t m) = Ref (HostFrame t)
171 type Ref (PerformEventT t m) = Ref (HostFrame t)
src/Reflex/PerformEvent/Class.hs+6−2
@@ -5,11 +5,9 @@
5{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
14#ifdef USE_REFLEX_OPTIMIZER
12#ifdef USE_REFLEX_OPTIMIZER
15{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
13{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +21,7 @@ import Reflex.Class
23import Reflex.TriggerEvent.Class
21import Reflex.TriggerEvent.Class
24
22
25import Control.Monad.Reader
23import Control.Monad.Reader
24+import Control.Monad.Trans.Maybe (MaybeT (..))
26
25
27-- | 'PerformEvent' represents actions that can trigger other actions based on
26-- | 'PerformEvent' represents actions that can trigger other actions based on
28-- 'Event's.
27-- 'Event's.
@@ -62,3 +61,8 @@ instance PerformEvent t m => PerformEvent t (ReaderT r m) where
62 performEvent e = do
61 performEvent e = do
63 r <- ask
62 r <- ask
64 lift $ performEvent $ flip runReaderT r <$> e
63 lift $ performEvent $ flip runReaderT r <$> e
64+
65+instance PerformEvent t m => PerformEvent t (MaybeT m) where
66+ type Performable (MaybeT m) = MaybeT (Performable m)
67+ performEvent_ = lift . performEvent_ . fmapCheap (void . runMaybeT)
68+ performEvent = lift . fmap (fmapMaybe id) . performEvent . fmapCheap runMaybeT
src/Reflex/PostBuild/Base.hs+2−1
@@ -9,7 +9,6 @@
9{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
10{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE UndecidableInstances #-}
12{-# LANGUAGE UndecidableInstances #-}
14#ifdef USE_REFLEX_OPTIMIZER
13#ifdef USE_REFLEX_OPTIMIZER
15{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
14{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -84,6 +83,8 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
84 buildDynamic a0 = lift . buildDynamic a0
83 buildDynamic a0 = lift . buildDynamic a0
85 {-# INLINABLE headE #-}
84 {-# INLINABLE headE #-}
86 headE = lift . headE
85 headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
87
88
88instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
89instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
89 type Performable (PostBuildT t m) = Performable m
90 type Performable (PostBuildT t m) = Performable m
src/Reflex/PostBuild/Class.hs−2
@@ -4,10 +4,8 @@
4{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DataKinds #-}
5{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
11{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
12#ifdef USE_REFLEX_OPTIMIZER
10#ifdef USE_REFLEX_OPTIMIZER
13{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
src/Reflex/Profiled.hs+86−18
@@ -8,9 +8,17 @@
8{-# LANGUAGE StandaloneDeriving #-}
8{-# LANGUAGE StandaloneDeriving #-}
9{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE UndecidableInstances #-}
10{-# LANGUAGE UndecidableInstances #-}
11+{-# LANGUAGE PolyKinds #-}
12+{-# LANGUAGE TypeApplications #-}
13+{-# LANGUAGE RankNTypes #-}
14+-- |
15+-- Module:
16+-- Reflex.Profiled
17+-- Description:
18+-- This module contains an instance of the 'Reflex' class that provides
19+-- profiling/cost-center information.
11module Reflex.Profiled where
20module Reflex.Profiled where
12
21
13−import Control.Lens hiding (children)
14import Control.Monad
22import Control.Monad
15import Control.Monad.Exception
23import Control.Monad.Exception
16import Control.Monad.Fix
24import Control.Monad.Fix
@@ -18,8 +26,10 @@ import Control.Monad.Primitive
18import Control.Monad.Reader
26import Control.Monad.Reader
19import Control.Monad.Ref
27import Control.Monad.Ref
20import Control.Monad.State.Strict (StateT, execStateT, modify)
28import Control.Monad.State.Strict (StateT, execStateT, modify)
29+import Data.Bifunctor
21import Data.Coerce
30import Data.Coerce
22−import Data.Dependent.Map (DMap, GCompare)
31+import Data.Dependent.Map (DMap)
32+import Data.GADT.Compare (GCompare)
23import Data.FastMutableIntMap
33import Data.FastMutableIntMap
24import Data.IORef
34import Data.IORef
25import Data.List
35import Data.List
@@ -27,18 +37,27 @@ import Data.Map (Map)
27import qualified Data.Map.Strict as Map
37import qualified Data.Map.Strict as Map
28import Data.Monoid ((<>))
38import Data.Monoid ((<>))
29import Data.Ord
39import Data.Ord
40+import Data.Profunctor.Unsafe ((#.))
30import qualified Data.Semigroup as S
41import qualified Data.Semigroup as S
31import Data.Type.Coercion
42import Data.Type.Coercion
32import Foreign.Ptr
43import Foreign.Ptr
33import GHC.Foreign
44import GHC.Foreign
34import GHC.IO.Encoding
45import GHC.IO.Encoding
35import GHC.Stack
46import GHC.Stack
47+import Reflex.Adjustable.Class
48+import Reflex.BehaviorWriter.Class
36import Reflex.Class
49import Reflex.Class
50+import Reflex.DynamicWriter.Class
51+import Reflex.EventWriter.Class
37import Reflex.Host.Class
52import Reflex.Host.Class
53+import Reflex.NotReady.Class
38import Reflex.PerformEvent.Class
54import Reflex.PerformEvent.Class
55+import Reflex.PostBuild.Class
56+import Reflex.Query.Class
57+import Reflex.Requester.Class
58+import Reflex.TriggerEvent.Class
39
59
40import System.IO.Unsafe
60import System.IO.Unsafe
41−import Unsafe.Coerce
42
61
43data ProfiledTimeline t
62data ProfiledTimeline t
44
63
@@ -71,9 +90,9 @@ getCostCentreStack = go []
71 go (cc : l) parent
90 go (cc : l) parent
72
91
73toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
92toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
74−toCostCentreTree ccs n = do
93+toCostCentreTree ccs n =
75− ccList <- getCostCentreStack ccs
76− return $ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty) ccList
94+ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty)
95+ <$> getCostCentreStack ccs
77
96
78getCostCentreTree :: IO CostCentreTree
97getCostCentreTree :: IO CostCentreTree
79getCostCentreTree = do
98getCostCentreTree = do
@@ -127,27 +146,32 @@ instance Reflex t => Reflex (ProfiledTimeline t) where
127 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
146 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
128 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
147 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
129 pull = Behavior_Profiled . pull . coerce
148 pull = Behavior_Profiled . pull . coerce
130− merge :: forall k. GCompare k => DMap k (Event (ProfiledTimeline t)) -> Event (ProfiledTimeline t) (DMap k Identity)
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))
131− merge = Event_Profiled . merge . (unsafeCoerce :: DMap k (Event (ProfiledTimeline t)) -> DMap k (Event t))
152+ -> DMap k q -> Event (ProfiledTimeline t) (DMap k v)
132− fan (Event_Profiled e) = EventSelector $ coerce $ select (fan $ profileEvent e)
153+ mergeG nt = Event_Profiled #. mergeG (coerce nt)
133 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
154 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
134 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
155 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
135 current (Dynamic_Profiled d) = coerce $ current d
156 current (Dynamic_Profiled d) = coerce $ current d
136 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
157 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
137 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
158 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
138 unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
159 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)))
160+ mergeIncrementalG nt res = Event_Profiled $ mergeIncrementalG (coerce nt) (coerce res)
140− mergeIncrementalWithMove = Event_Profiled . mergeIncrementalWithMove . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMapWithMove k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMapWithMove k (Event t)))
161+ mergeIncrementalWithMoveG nt res = Event_Profiled $ mergeIncrementalWithMoveG (coerce nt) (coerce res)
141 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
162 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
142 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
163 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
143 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
164 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
144− behaviorCoercion (c :: Coercion a b) = case behaviorCoercion c :: Coercion (Behavior t a) (Behavior t b) of
165+ behaviorCoercion c =
145− Coercion -> unsafeCoerce (Coercion :: Coercion (Behavior (ProfiledTimeline t) a) (Behavior (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
166+ Coercion `trans` behaviorCoercion @t c `trans` Coercion
146− eventCoercion (c :: Coercion a b) = case eventCoercion c :: Coercion (Event t a) (Event t b) of
167+ eventCoercion c =
147− Coercion -> unsafeCoerce (Coercion :: Coercion (Event (ProfiledTimeline t) a) (Event (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
168+ Coercion `trans` eventCoercion @t c `trans` Coercion
169+ dynamicCoercion c =
148− dynamicCoercion (c :: Coercion a b) = case dynamicCoercion c :: Coercion (Dynamic t a) (Dynamic t b) of
170+ Coercion `trans` dynamicCoercion @t c `trans` Coercion
149− Coercion -> unsafeCoerce (Coercion :: Coercion (Dynamic (ProfiledTimeline t) a) (Dynamic (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
171+ incrementalCoercion c d =
172+ Coercion `trans` incrementalCoercion @t c d `trans` Coercion
150− mergeIntIncremental = Event_Profiled . mergeIntIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchIntMap (Event (ProfiledTimeline t) a)) -> Incremental t (PatchIntMap (Event t a)))
173+ mergeIntIncremental = Event_Profiled . mergeIntIncremental .
174+ coerceWith (Coercion `trans` incrementalCoercion Coercion Coercion `trans` Coercion)
151 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
175 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
152
176
153deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
177deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
@@ -160,10 +184,21 @@ instance MonadHold t m => MonadHold (ProfiledTimeline t) (ProfiledM m) where
160 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
184 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
161 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
185 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
162 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
186 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
187+ now = ProfiledM $ Event_Profiled <$> now
163
188
164instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
189instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
165 sample (Behavior_Profiled b) = ProfiledM $ sample b
190 sample (Behavior_Profiled b) = ProfiledM $ sample b
166
191
192+instance Adjustable t m => Adjustable (ProfiledTimeline t) (ProfiledM m) where
193+ runWithReplace a0 a' = (fmap . fmap) coerce . lift $
194+ runWithReplace (coerce a0) (coerce $ coerce <$> a')
195+ traverseIntMapWithKeyWithAdjust f dm0 dm' = (fmap . fmap) coerce . lift $
196+ traverseIntMapWithKeyWithAdjust (\k v -> coerce $ f k v) dm0 (coerce dm')
197+ traverseDMapWithKeyWithAdjust f dm0 dm' = (fmap . fmap) coerce . lift $
198+ traverseDMapWithKeyWithAdjust (\k v -> coerce $ f k v) dm0 (coerce dm')
199+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = (fmap . fmap) coerce . lift $
200+ traverseDMapWithKeyWithAdjustWithMove (\k v -> coerce $ f k v) dm0 (coerce dm')
201+
167instance MonadTrans ProfiledM where
202instance MonadTrans ProfiledM where
168 lift = ProfiledM
203 lift = ProfiledM
169
204
@@ -175,6 +210,39 @@ instance PerformEvent t m => PerformEvent (ProfiledTimeline t) (ProfiledM m) whe
175 performEvent_ = lift . performEvent_ . coerce
210 performEvent_ = lift . performEvent_ . coerce
176 performEvent = lift . fmap coerce . performEvent . coerce
211 performEvent = lift . fmap coerce . performEvent . coerce
177
212
213+instance TriggerEvent t m => TriggerEvent (ProfiledTimeline t) (ProfiledM m) where
214+ newTriggerEvent = first coerce <$> lift newTriggerEvent
215+ newTriggerEventWithOnComplete = first coerce <$> lift newTriggerEventWithOnComplete
216+ newEventWithLazyTriggerWithOnComplete f = coerce <$> lift (newEventWithLazyTriggerWithOnComplete f)
217+
218+instance PostBuild t m => PostBuild (ProfiledTimeline t) (ProfiledM m) where
219+ getPostBuild = coerce <$> lift getPostBuild
220+
221+instance NotReady t m => NotReady (ProfiledTimeline t) (ProfiledM m) where
222+ notReady = lift notReady
223+ notReadyUntil = lift . notReadyUntil . coerce
224+
225+instance BehaviorWriter t w m => BehaviorWriter (ProfiledTimeline t) w (ProfiledM m) where
226+ tellBehavior = lift . tellBehavior . coerce
227+
228+instance DynamicWriter t w m => DynamicWriter (ProfiledTimeline t) w (ProfiledM m) where
229+ tellDyn = lift . tellDyn . coerce
230+
231+instance EventWriter t w m => EventWriter (ProfiledTimeline t) w (ProfiledM m) where
232+ tellEvent = lift . tellEvent . coerce
233+
234+instance MonadQuery t q m => MonadQuery (ProfiledTimeline t) q (ProfiledM m) where
235+ tellQueryIncremental = lift . tellQueryIncremental . coerce
236+ askQueryResult = coerce <$> lift askQueryResult
237+ queryIncremental = fmap coerce . lift . queryIncremental . coerce
238+
239+instance Requester t m => Requester (ProfiledTimeline t) (ProfiledM m) where
240+ type Request (ProfiledM m) = Request m
241+ type Response (ProfiledM m) = Response m
242+
243+ requesting = fmap coerce . lift . requesting . coerce
244+ requesting_ = lift . requesting_ . coerce
245+
178instance MonadRef m => MonadRef (ProfiledM m) where
246instance MonadRef m => MonadRef (ProfiledM m) where
179 type Ref (ProfiledM m) = Ref m
247 type Ref (ProfiledM m) = Ref m
180 newRef = lift . newRef
248 newRef = lift . newRef
src/Reflex/Pure.hs+38−27
@@ -5,6 +5,9 @@
5{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE PolyKinds #-}
10+
8#ifdef USE_REFLEX_OPTIMIZER
11#ifdef USE_REFLEX_OPTIMIZER
9{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
10#endif
13#endif
@@ -13,11 +16,13 @@
13-- * MonadSample (Pure t) ((->) t)
16-- * MonadSample (Pure t) ((->) t)
14-- * MonadHold (Pure t) ((->) t)
17-- * MonadHold (Pure t) ((->) t)
15{-# OPTIONS_GHC -fno-warn-orphans #-}
18{-# OPTIONS_GHC -fno-warn-orphans #-}
16−
19+-- |
20+-- Module: Reflex.Pure
21+-- Description:
17−-- | This module provides a pure implementation of Reflex, which is intended to
22+-- This module provides a pure implementation of Reflex, which is intended to
18−-- serve as a reference for the semantics of the Reflex class. All
23+-- serve as a reference for the semantics of the Reflex class. All
19−-- implementations of Reflex should produce the same results as this
24+-- implementations of Reflex should produce the same results as this
20−-- implementation, although performance and laziness/strictness may differ.
25+-- implementation, although performance and laziness/strictness may differ.
21module Reflex.Pure
26module Reflex.Pure
22 ( Pure
27 ( Pure
23 , Behavior (..)
28 , Behavior (..)
@@ -26,14 +31,10 @@ module Reflex.Pure
26 , Incremental (..)
31 , Incremental (..)
27 ) where
32 ) where
28
33
29−#if !MIN_VERSION_base(4,8,0)
30−import Control.Applicative
31−#endif
32−
33import Control.Monad
34import Control.Monad
34−import Data.Dependent.Map (DMap, GCompare)
35+import Data.Dependent.Map (DMap)
36+import Data.GADT.Compare (GCompare)
35import qualified Data.Dependent.Map as DMap
37import qualified Data.Dependent.Map as DMap
36−import Data.Functor.Identity
37import Data.IntMap (IntMap)
38import Data.IntMap (IntMap)
38import qualified Data.IntMap as IntMap
39import qualified Data.IntMap as IntMap
39import Data.Maybe
40import Data.Maybe
@@ -41,14 +42,15 @@ import Data.MemoTrie
41import Data.Monoid
42import Data.Monoid
42import Data.Type.Coercion
43import Data.Type.Coercion
43import Reflex.Class
44import Reflex.Class
45+import Data.Kind (Type)
44
46
45-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
47-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
46−-- with the type @t@.
48+-- with the type @/t/@.
47−data Pure t
49+data Pure (t :: Type)
48
50
49−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
51+-- | The 'Enum' instance of @/t/@ must be dense: for all @/x :: t/@, there must not exist
50−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
52+-- any @/y :: t/@ such that @/'pred' x < y < x/@. The 'HasTrie' instance will be used
51−-- exclusively to memoize functions of t, not for any of its other capabilities.
53+-- exclusively to memoize functions of @/t/@, not for any of its other capabilities.
52instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
54instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
53
55
54 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
56 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
@@ -77,17 +79,19 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
77 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
79 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
78 -- warning because the GCompare instance is not used; however, removing the
80 -- warning because the GCompare instance is not used; however, removing the
79 -- GCompare instance produces a different warning, due to that constraint
81 -- 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.
81
83
82− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
84+ --mergeG :: GCompare k => (forall a. q a -> Event (Pure t) (v a))
85+ -- -> DMap k q -> Event (Pure t) (DMap k v)
83− merge events = Event $ memo $ \t ->
86+ mergeG nt events = Event $ memo $ \t ->
84− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
87+ let currentOccurrences = DMap.mapMaybeWithKey (\_ q -> case nt q of Event a -> a t) events
85 in if DMap.null currentOccurrences
88 in if DMap.null currentOccurrences
86 then Nothing
89 then Nothing
87 else Just currentOccurrences
90 else Just currentOccurrences
88
91
92+-- The instance signature doeesn't compile, leave commented for documentation
89− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
93+-- fanG :: GCompare k => Event (Pure t) (DMap k v) -> EventSelectorG (Pure t) k v
90− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
94+ fanG e = EventSelectorG $ \k -> Event $ \t -> unEvent e t >>= DMap.lookup k
91
95
92 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
96 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
93 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
97 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
110 --a) -> Incremental (Pure t) p a
114 --a) -> Incremental (Pure t) p a
111 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
115 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
112
116
113− mergeIncremental = mergeIncrementalImpl
117+ mergeIncrementalG = mergeIncrementalImpl
114− mergeIncrementalWithMove = mergeIncrementalImpl
118+ mergeIncrementalWithMoveG = mergeIncrementalImpl
115
119
116 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
120 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
117
121
@@ -126,14 +130,17 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
126 behaviorCoercion Coercion = Coercion
130 behaviorCoercion Coercion = Coercion
127 eventCoercion Coercion = Coercion
131 eventCoercion Coercion = Coercion
128 dynamicCoercion Coercion = Coercion
132 dynamicCoercion Coercion = Coercion
133+ incrementalCoercion Coercion Coercion = Coercion
129
134
130 fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
135 fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
131
136
132 mergeIntIncremental = mergeIntIncrementalImpl
137 mergeIntIncremental = mergeIntIncrementalImpl
133
138
134−mergeIncrementalImpl :: (PatchTarget p ~ DMap k (Event (Pure t)), GCompare k) => Incremental (Pure t) p -> Event (Pure t) (DMap k Identity)
139+mergeIncrementalImpl :: (PatchTarget p ~ DMap k q, GCompare k)
140+ => (forall a. q a -> Event (Pure t) (v a))
141+ -> Incremental (Pure t) p -> Event (Pure t) (DMap k v)
135−mergeIncrementalImpl i = Event $ \t ->
142+mergeIncrementalImpl nt i = Event $ \t ->
136− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ unIncremental i t
143+ let results = DMap.mapMaybeWithKey (\_ q -> case nt q of Event e -> e t) $ fst $ unIncremental i t
137 in if DMap.null results
144 in if DMap.null results
138 then Nothing
145 then Nothing
139 else Just results
146 else Just results
@@ -204,3 +211,7 @@ instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
204 Just x -> fromMaybe lastValue $ apply x lastValue
211 Just x -> fromMaybe lastValue $ apply x lastValue
205
212
206 headE = slowHeadE
213 headE = slowHeadE
214+ now t = Event $ guard . (t ==)
215+
216+
217+
src/Reflex/Query/Base.hs+49−42
@@ -1,7 +1,6 @@
1{-# LANGUAGE FlexibleInstances #-}
1{-# LANGUAGE FlexibleInstances #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3{-# LANGUAGE InstanceSigs #-}
3{-# LANGUAGE InstanceSigs #-}
4−{-# LANGUAGE KindSignatures #-}
5{-# LANGUAGE LambdaCase #-}
4{-# LANGUAGE LambdaCase #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE RankNTypes #-}
6{-# LANGUAGE RankNTypes #-}
@@ -17,28 +16,32 @@ module Reflex.Query.Base
17 , mapQueryResult
16 , mapQueryResult
18 , dynWithQueryT
17 , dynWithQueryT
19 , withQueryT
18 , withQueryT
19+ , mapQueryT
20 ) where
20 ) where
21
21
22import Control.Applicative (liftA2)
22import Control.Applicative (liftA2)
23import Control.Monad.Exception
23import Control.Monad.Exception
24import Control.Monad.Fix
24import Control.Monad.Fix
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
25import Control.Monad.Reader
27import Control.Monad.Reader
26import Control.Monad.Ref
28import Control.Monad.Ref
27import Control.Monad.State.Strict
29import Control.Monad.State.Strict
28import Data.Align
30import Data.Align
29−import Data.Dependent.Map (DMap, DSum (..))
31+import Data.Dependent.Map (DMap)
30import qualified Data.Dependent.Map as DMap
32import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
31import Data.Foldable
34import Data.Foldable
32import Data.Functor.Compose
35import Data.Functor.Compose
33import Data.Functor.Misc
36import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
34import Data.IntMap (IntMap)
38import Data.IntMap (IntMap)
35import qualified Data.IntMap as IntMap
39import qualified Data.IntMap as IntMap
36import Data.Map (Map)
40import Data.Map (Map)
37import qualified Data.Map as Map
41import qualified Data.Map as Map
38import Data.Monoid ((<>))
42import Data.Monoid ((<>))
39import qualified Data.Semigroup as S
43import qualified Data.Semigroup as S
40−import Data.Some (Some)
44+import Data.Some (Some(Some))
41−import qualified Data.Some as Some
42import Data.These
45import Data.These
43
46
44import Reflex.Class
47import Reflex.Class
@@ -47,7 +50,7 @@ import Reflex.DynamicWriter.Class
47import Reflex.EventWriter.Base
50import Reflex.EventWriter.Base
48import Reflex.EventWriter.Class
51import Reflex.EventWriter.Class
49import Reflex.Host.Class
52import Reflex.Host.Class
50−import qualified Reflex.Patch.MapWithMove as MapWithMove
53+import qualified Data.Patch.MapWithMove as MapWithMove
51import Reflex.PerformEvent.Class
54import Reflex.PerformEvent.Class
52import Reflex.PostBuild.Class
55import Reflex.PostBuild.Class
53import Reflex.Query.Class
56import Reflex.Query.Class
@@ -73,26 +76,19 @@ getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
73getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
76getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
74getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
77getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
75
78
76−{-
79+maskMempty :: (Eq a, Monoid a) => a -> Maybe a
77−let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
80+maskMempty x = if x == mempty then Nothing else Just x
78− sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
81+
79− bs' = fmapCheap snd $ r'
80− patches = unsafeBuildIncremental (sampleBs bs0) $
81− flip pushCheap bs' $ \bs -> do
82− p <- (~~) <$> sampleBs bs <*> sample (currentIncremental patches)
83− return (Just (AdditivePatch p))
84−-}
85−
86−instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adjustable t m) => Adjustable t (QueryT t q m) where
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
87 runWithReplace (QueryT a0) a' = do
83 runWithReplace (QueryT a0) a' = do
88 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
84 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
89 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
85 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
90 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
86 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
91 bs' = fmapCheap snd $ r'
87 bs' = fmapCheap snd $ r'
92 bbs <- hold bs0 bs'
88 bbs <- hold bs0 bs'
93− let patches = flip pushAlwaysCheap bs' $ \newBs -> do
89+ let patches = flip pushCheap bs' $ \newBs -> do
94 oldBs <- sample bbs
90 oldBs <- sample bbs
95− (~~) <$> sampleBs newBs <*> sampleBs oldBs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
96 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
92 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
97 QueryT $ lift $ tellEvent patches
93 QueryT $ lift $ tellEvent patches
98 return (r0, fmapCheap fst r')
94 return (r0, fmapCheap fst r')
@@ -142,7 +138,7 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
142 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
138 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
143 return (liftedResult0, liftedResult')
139 return (liftedResult0, liftedResult')
144
140
145− 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'))
146 traverseDMapWithKeyWithAdjust f dm0 dm' = do
142 traverseDMapWithKeyWithAdjust f dm0 dm' = do
147 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
143 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
148 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
144 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -151,10 +147,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
151 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
147 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
152 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
148 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
153 liftedBs0 :: Map (Some k) [Behavior t q]
149 liftedBs0 :: Map (Some k) [Behavior t q]
154− 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
155 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
151 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
156 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
152 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
157− 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
158 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
154 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
159 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
155 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
160 accumBehaviors :: forall m'. MonadHold t m'
156 accumBehaviors :: forall m'. MonadHold t m'
@@ -170,24 +166,24 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
170 let p k bs = case Map.lookup k bs0 of
166 let p k bs = case Map.lookup k bs0 of
171 Nothing -> case bs of
167 Nothing -> case bs of
172 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
168 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
173− Nothing -> return mempty
169+ Nothing -> return Nothing
174 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
170 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
175− Just newBs -> sampleBs newBs
171+ Just newBs -> maskMempty <$> sampleBs newBs
176 Just oldBs -> case bs of
172 Just oldBs -> case bs of
177 -- 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
173 -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
178− Nothing -> negateG <$> sampleBs oldBs
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
179 -- 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
175 -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
180 -- composed with the sampling the child's new state.
176 -- composed with the sampling the child's new state.
181− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
182 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
178 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
183 -- child patches and wrap them in AdditivePatch.
179 -- child patches and wrap them in AdditivePatch.
184− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
180+ patch <- fold <$> Map.traverseWithKey p bs'
185− return (apply pbs bs0, Just patch)
181+ return (apply pbs bs0, AdditivePatch <$> patch)
186 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
182 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
187 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
183 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
188 return (liftedResult0, liftedResult')
184 return (liftedResult0, liftedResult')
189
185
190− 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'))
191 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
187 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
192 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
188 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
193 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
189 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -195,10 +191,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
195 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
191 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
196 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
192 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
197 liftedBs0 :: Map (Some k) [Behavior t q]
193 liftedBs0 :: Map (Some k) [Behavior t q]
198− 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
199 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
195 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
200 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
196 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
201− 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 -}
202 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
198 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
203 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
199 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
204 accumBehaviors' :: forall m'. MonadHold t m'
200 accumBehaviors' :: forall m'. MonadHold t m'
@@ -215,28 +211,28 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
215 p k bs = case Map.lookup k bs0 of
211 p k bs = case Map.lookup k bs0 of
216 Nothing -> case MapWithMove._nodeInfo_from bs of
212 Nothing -> case MapWithMove._nodeInfo_from bs of
217 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
213 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
218− MapWithMove.From_Delete -> return mempty
214+ MapWithMove.From_Delete -> return Nothing
219 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
215 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
220− MapWithMove.From_Insert newBs -> sampleBs newBs
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
221 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
217 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
222− Nothing -> return mempty
218+ Nothing -> return Nothing
223− Just newBs -> sampleBs newBs
219+ Just newBs -> maskMempty <$> sampleBs newBs
224 Just oldBs -> case MapWithMove._nodeInfo_from bs of
220 Just oldBs -> case MapWithMove._nodeInfo_from bs of
225 -- 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
221 -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
226− MapWithMove.From_Delete -> negateG <$> sampleBs oldBs
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
227 -- 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
223 -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
228 -- composed with the sampling the child's new state.
224 -- composed with the sampling the child's new state.
229− MapWithMove.From_Insert newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
225+ MapWithMove.From_Insert newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
230 MapWithMove.From_Move k'
226 MapWithMove.From_Move k'
231− | k' == k -> return mempty
227+ | k' == k -> return Nothing
232 | otherwise -> case Map.lookup k' bs0 of
228 | otherwise -> case Map.lookup k' bs0 of
233 -- If we are moving from a non-existent key, that is a delete
229 -- If we are moving from a non-existent key, that is a delete
234− Nothing -> negateG <$> sampleBs oldBs
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
235− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
236 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
232 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
237 -- child patches and wrap them in AdditivePatch.
233 -- child patches and wrap them in AdditivePatch.
238− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
234+ patch <- fold <$> Map.traverseWithKey p bs'
239− return (apply pbs bs0, Just patch)
235+ return (apply pbs bs0, AdditivePatch <$> patch)
240 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
236 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
241 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
237 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
242 return (liftedResult0, liftedResult')
238 return (liftedResult0, liftedResult')
@@ -244,6 +240,13 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
244instance MonadTrans (QueryT t q) where
240instance MonadTrans (QueryT t q) where
245 lift = QueryT . lift . lift . lift
241 lift = QueryT . lift . lift . lift
246
242
243+instance MFunctor (QueryT t q) where
244+ hoist = mapQueryT
245+
246+instance PrimMonad m => PrimMonad (QueryT t q m) where
247+ type PrimState (QueryT t q m) = PrimState m
248+ primitive = lift . primitive
249+
247instance PostBuild t m => PostBuild t (QueryT t q m) where
250instance PostBuild t m => PostBuild t (QueryT t q m) where
248 getPostBuild = lift getPostBuild
251 getPostBuild = lift getPostBuild
249
252
@@ -291,6 +294,10 @@ withQueryT f a = do
291 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
294 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
292 return result
295 return result
293
296
297+-- | Maps a function over a 'QueryT' that can change the underlying monad
298+mapQueryT :: (forall b. m b -> n b) -> QueryT t q m a -> QueryT t q n a
299+mapQueryT f (QueryT a) = QueryT $ mapStateT (mapEventWriterT (mapReaderT f)) a
300+
294-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
301-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
295dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
302dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
296 => Dynamic t (QueryMorphism q q')
303 => Dynamic t (QueryMorphism q q')
@@ -335,5 +342,5 @@ instance Requester t m => Requester t (QueryT t q m) where
335instance EventWriter t w m => EventWriter t w (QueryT t q m) where
342instance EventWriter t w m => EventWriter t w (QueryT t q m) where
336 tellEvent = lift . tellEvent
343 tellEvent = lift . tellEvent
337
344
338−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
339 tellDyn = lift . tellDyn
346 tellDyn = lift . tellDyn
src/Reflex/Query/Class.hs+68−9
@@ -1,11 +1,18 @@
1+{-# LANGUAGE CPP #-}
1{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE UndecidableInstances #-}
8{-# LANGUAGE UndecidableInstances #-}
9+-- |
10+-- Module:
11+-- Reflex.Query.Class
12+-- Description:
13+-- A class that ties together queries to some data source and their results,
14+-- providing methods for requesting data from the source and accumulating
15+-- streamed results.
9module Reflex.Query.Class
16module Reflex.Query.Class
10 ( Query (..)
17 ( Query (..)
11 , QueryMorphism (..)
18 , QueryMorphism (..)
@@ -15,6 +22,7 @@ module Reflex.Query.Class
15 , MonadQuery (..)
22 , MonadQuery (..)
16 , tellQueryDyn
23 , tellQueryDyn
17 , queryDyn
24 , queryDyn
25+ , subQuery
18 , mapQuery
26 , mapQuery
19 , mapQueryResult
27 , mapQueryResult
20 ) where
28 ) where
@@ -27,11 +35,18 @@ import Data.Data
27import Data.Ix
35import Data.Ix
28import Data.Map.Monoidal (MonoidalMap)
36import Data.Map.Monoidal (MonoidalMap)
29import qualified Data.Map.Monoidal as MonoidalMap
37import qualified Data.Map.Monoidal as MonoidalMap
30−import Data.Semigroup
38+import Data.Semigroup (Semigroup(..))
31import Foreign.Storable
39import Foreign.Storable
40+import Data.Void
41+import Data.Monoid hiding ((<>))
42+import Control.Applicative
32
43
33import Reflex.Class
44import Reflex.Class
34
45
46+-- | A 'Query' can be thought of as a declaration of interest in some set of data.
47+-- A 'QueryResult' is the set of data associated with that interest set.
48+-- The @crop@ function provides a way to determine what part of a given 'QueryResult'
49+-- is relevant to a given 'Query'.
35class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
50class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
36 type QueryResult a :: *
51 type QueryResult a :: *
37 crop :: a -> QueryResult a -> QueryResult a
52 crop :: a -> QueryResult a -> QueryResult a
@@ -40,8 +55,39 @@ instance (Ord k, Query v) => Query (MonoidalMap k v) where
40 type QueryResult (MonoidalMap k v) = MonoidalMap k (QueryResult v)
55 type QueryResult (MonoidalMap k v) = MonoidalMap k (QueryResult v)
41 crop q r = MonoidalMap.intersectionWith (flip crop) r q
56 crop q r = MonoidalMap.intersectionWith (flip crop) r q
42
57
58+-- | the result of two queries is both results.
59+instance (Query a, Query b) => Query (a, b) where
60+ type QueryResult (a, b) = (QueryResult a, QueryResult b)
61+ crop (x, x') (y, y') = (crop x y, crop x' y')
62+
63+-- | Trivial queries have trivial results.
64+instance Query () where
65+ type QueryResult () = ()
66+ crop _ _ = ()
67+
68+-- | The result of an absurd query is trivial; If you can ask the question, the
69+-- answer cannot tell you anything you didn't already know.
70+--
71+-- 'QueryResult Void = @Void@' seems like it would also work, but that has
72+-- problems of robustness. In some applications, an unasked question can still
73+-- be answered, so it is important that the result is inhabited even when the
74+-- question isn't. Applications that wish to prevent this can mandate that the
75+-- query result be paired with the query: then the whole response will be
76+-- uninhabited as desired.
77+instance Query Void where
78+ type QueryResult Void = ()
79+ crop = absurd
80+
81+#if MIN_VERSION_base(4,12,0)
82+-- | We can lift queries into monoidal containers.
83+-- But beware of Applicatives whose monoid is different from (pure mempty, liftA2 mappend)
84+instance (Query q, Applicative f) => Query (Ap f q) where
85+ type QueryResult (Ap f q) = Ap f (QueryResult q)
86+ crop = liftA2 crop
87+#endif
88+
43−-- | NB: QueryMorphism's must be group homomorphisms when acting on the query type
89+-- | 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
90+-- and compatible with the query relationship when acting on the query result.
45data QueryMorphism q q' = QueryMorphism
91data QueryMorphism q q' = QueryMorphism
46 { _queryMorphism_mapQuery :: q -> q'
92 { _queryMorphism_mapQuery :: q -> q'
47 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
93 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
@@ -54,13 +100,16 @@ instance Category QueryMorphism where
54 , _queryMorphism_mapQueryResult = mapQueryResult qm' . mapQueryResult qm
100 , _queryMorphism_mapQueryResult = mapQueryResult qm' . mapQueryResult qm
55 }
101 }
56
102
103+-- | Apply a 'QueryMorphism' to a 'Query'
57mapQuery :: QueryMorphism q q' -> q -> q'
104mapQuery :: QueryMorphism q q' -> q -> q'
58mapQuery = _queryMorphism_mapQuery
105mapQuery = _queryMorphism_mapQuery
59
106
107+-- | Map a 'QueryMorphism' to a 'QueryResult'
60mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
108mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
61mapQueryResult = _queryMorphism_mapQueryResult
109mapQueryResult = _queryMorphism_mapQueryResult
62
110
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'
64newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
113newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
65 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
114 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
66
115
@@ -76,24 +125,34 @@ instance Group SelectedCount where
76
125
77instance Additive SelectedCount
126instance Additive SelectedCount
78
127
128+-- | The Semigroup\/Monoid\/Group instances for a Query containing 'SelectedCount's should use
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.
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.
80combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
131combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
81combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
132combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
82
133
134+-- | A class that allows sending of 'Query's and retrieval of 'QueryResult's. See 'queryDyn' for a commonly
135+-- used interface.
83−class (Group q, Additive q, Query q) => MonadQuery t q m | m -> q t where
136+class (Group q, Additive q, Query q, Monad m) => MonadQuery t q m | m -> q t where
84 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
137 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
85 askQueryResult :: m (Dynamic t (QueryResult q))
138 askQueryResult :: m (Dynamic t (QueryResult q))
86 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
139 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
87
140
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
89 tellQueryIncremental = lift . tellQueryIncremental
142 tellQueryIncremental = lift . tellQueryIncremental
90 askQueryResult = lift askQueryResult
143 askQueryResult = lift askQueryResult
91 queryIncremental = lift . queryIncremental
144 queryIncremental = lift . queryIncremental
92
145
146+-- | Produce and send an 'Incremental' 'Query' from a 'Dynamic' 'Query'.
93tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
147tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
94tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
148tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
95
149
150+-- | Retrieve 'Dynamic'ally updating 'QueryResult's for a 'Dynamic'ally updating 'Query'.
96−queryDyn :: (Reflex t, Monad m, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
151+queryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
97queryDyn q = do
152queryDyn q = do
98 tellQueryDyn q
153 tellQueryDyn q
99 zipDynWith crop q <$> askQueryResult
154 zipDynWith crop q <$> askQueryResult
155+
156+-- | Use a query morphism to operate on a smaller version of a query.
157+subQuery :: (Reflex t, MonadQuery t q2 m) => QueryMorphism q1 q2 -> Dynamic t q1 -> m (Dynamic t (QueryResult q1))
158+subQuery (QueryMorphism f g) x = fmap g <$> queryDyn (fmap f x)
src/Reflex/Requester/Base.hs+196−18
@@ -1,6 +1,7 @@
1-- | This module provides 'RequesterT', the standard implementation of
1-- | This module provides 'RequesterT', the standard implementation of
2-- 'Requester'.
2-- 'Requester'.
3{-# LANGUAGE AllowAmbiguousTypes #-}
3{-# LANGUAGE AllowAmbiguousTypes #-}
4+{-# LANGUAGE ApplicativeDo #-}
4{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
5{-# LANGUAGE EmptyDataDecls #-}
6{-# LANGUAGE EmptyDataDecls #-}
6{-# LANGUAGE ExistentialQuantification #-}
7{-# LANGUAGE ExistentialQuantification #-}
@@ -21,14 +22,21 @@
21module Reflex.Requester.Base
22module Reflex.Requester.Base
22 ( RequesterT (..)
23 ( RequesterT (..)
23 , runRequesterT
24 , runRequesterT
25+ , withRequesterT
24 , runWithReplaceRequesterTWith
26 , runWithReplaceRequesterTWith
25 , traverseIntMapWithKeyWithAdjustRequesterTWith
27 , traverseIntMapWithKeyWithAdjustRequesterTWith
26 , traverseDMapWithKeyWithAdjustRequesterTWith
28 , traverseDMapWithKeyWithAdjustRequesterTWith
27 , RequesterData
29 , RequesterData
28 , RequesterDataKey
30 , RequesterDataKey
29 , traverseRequesterData
31 , traverseRequesterData
32+ , forRequesterData
30 , requesterDataToList
33 , requesterDataToList
31 , singletonRequesterData
34 , singletonRequesterData
35+ , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
37+ , multiEntry
38+ , unMultiEntry
39+ , requesting'
32 ) where
40 ) where
33
41
34import Reflex.Class
42import Reflex.Class
@@ -43,13 +51,17 @@ import Reflex.TriggerEvent.Class
43import Control.Applicative (liftA2)
51import Control.Applicative (liftA2)
44import Control.Monad.Exception
52import Control.Monad.Exception
45import Control.Monad.Identity
53import Control.Monad.Identity
54+import Control.Monad.Morph
55+import Control.Monad.Primitive
46import Control.Monad.Reader
56import Control.Monad.Reader
47import Control.Monad.Ref
57import Control.Monad.Ref
48import Control.Monad.State.Strict
58import Control.Monad.State.Strict
49import Data.Bits
59import Data.Bits
50import Data.Coerce
60import Data.Coerce
61+import Data.Constraint
51−import Data.Dependent.Map (DMap, DSum (..))
62+import Data.Dependent.Map (DMap)
52import qualified Data.Dependent.Map as DMap
63import qualified Data.Dependent.Map as DMap
64+import Data.Dependent.Sum (DSum (..))
53import Data.Functor.Compose
65import Data.Functor.Compose
54import Data.Functor.Misc
66import Data.Functor.Misc
55import Data.IntMap.Strict (IntMap)
67import Data.IntMap.Strict (IntMap)
@@ -59,8 +71,7 @@ import qualified Data.Map as Map
59import Data.Monoid ((<>))
71import Data.Monoid ((<>))
60import Data.Proxy
72import Data.Proxy
61import qualified Data.Semigroup as S
73import qualified Data.Semigroup as S
62−import Data.Some (Some)
74+import Data.Some (Some(Some))
63−import qualified Data.Some as Some
64import Data.Type.Equality
75import Data.Type.Equality
65import Data.Unique.Tag
76import Data.Unique.Tag
66
77
@@ -73,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
73
84
74newtype RequesterData f = RequesterData (TagMap (Entry f))
85newtype RequesterData f = RequesterData (TagMap (Entry f))
75
86
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
76data RequesterDataKey a where
90data RequesterDataKey a where
77 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
91 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
78 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
92 RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
79− 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
80 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
94 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
81
95
82singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
96singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
83singletonRequesterData rdk v = case rdk of
97singletonRequesterData rdk v = case rdk of
84 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
98 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
85 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
99 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
86− 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+ }
87 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
88
105
106+mergeRequesterData :: RequesterData f -> RequesterData f -> RequesterData f
107+mergeRequesterData (RequesterData a) (RequesterData b) = RequesterData $ mergeTagMap a b
108+
109+mergeTagMap :: forall f. TagMap (Entry f) -> TagMap (Entry f) -> TagMap (Entry f)
110+mergeTagMap (TagMap m) (TagMap n) =
111+ TagMap $ IntMap.unionWithKey (g' combiner) m n
112+ where
113+ combiner :: forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a
114+ combiner k (Entry a) (Entry b) = Entry $ case myKeyType k of
115+ MyTagType_Single -> a
116+ MyTagType_Multi -> IntMap.unionWith mergeRequesterData a b
117+ MyTagType_Multi2 -> case _multi2Contents_dict a of
118+ Dict -> Multi2Contents
119+ { _multi2Contents_values = Map.unionWith (IntMap.unionWith mergeRequesterData) (_multi2Contents_values a) (_multi2Contents_values b)
120+ , _multi2Contents_dict = Dict
121+ }
122+ MyTagType_Multi3 -> IntMap.unionWith (IntMap.unionWith mergeRequesterData) a b
123+ g' :: (forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a) -> Int -> Any -> Any -> Any
124+ g' f rawKey a b =
125+ let k = MyTag rawKey :: MyTag a
126+ fromAny :: Any -> Entry f a
127+ fromAny = unsafeCoerce
128+ toAny :: Entry f a -> Any
129+ toAny = unsafeCoerce
130+ in toAny $ f k (fromAny a) (fromAny b)
131+
89requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
90requesterDataToList (RequesterData m) = do
133requesterDataToList (RequesterData m) = do
91 k :=> Entry e <- tagMapToList m
134 k :=> Entry e <- tagMapToList m
@@ -95,11 +138,12 @@ requesterDataToList (RequesterData m) = do
95 (k', e') <- IntMap.toList e
138 (k', e') <- IntMap.toList e
96 k'' :=> e'' <- requesterDataToList e'
139 k'' :=> e'' <- requesterDataToList e'
97 return $ RequesterDataKey_Multi k k' k'' :=> e''
140 return $ RequesterDataKey_Multi k k' k'' :=> e''
98− MyTagType_Multi2 -> do
141+ MyTagType_Multi2 -> case _multi2Contents_dict e of
142+ Dict -> do
99− (k', e') <- Map.toList e
143+ (k', e') <- Map.toList $ _multi2Contents_values e
100− (k'', e'') <- IntMap.toList e'
144+ (k'', e'') <- IntMap.toList e'
101− k''' :=> e''' <- requesterDataToList e''
145+ k''' :=> e''' <- requesterDataToList e''
102− return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
146+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
103 MyTagType_Multi3 -> do
147 MyTagType_Multi3 -> do
104 (k', e') <- IntMap.toList e
148 (k', e') <- IntMap.toList e
105 (k'', e'') <- IntMap.toList e'
149 (k'', e'') <- IntMap.toList e'
@@ -127,9 +171,19 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
127 go k (Entry request) = Entry <$> case myKeyType k of
171 go k (Entry request) = Entry <$> case myKeyType k of
128 MyTagType_Single -> f request
172 MyTagType_Single -> f request
129 MyTagType_Multi -> traverse (traverseRequesterData f) request
173 MyTagType_Multi -> traverse (traverseRequesterData f) request
174+ MyTagType_Multi2 -> case request of
175+ Multi2Contents { _multi2Contents_values = request', _multi2Contents_dict = Dict } -> do
130− MyTagType_Multi2 -> traverse (traverse (traverseRequesterData f)) request
176+ v <- traverse (traverse (traverseRequesterData f)) request'
177+ pure $ Multi2Contents
178+ { _multi2Contents_values = v
179+ , _multi2Contents_dict = Dict
180+ }
131 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
132
182
183+-- | 'traverseRequesterData' with its arguments flipped
184+forRequesterData :: forall request response m. Applicative m => RequesterData request -> (forall a. request a -> m (response a)) -> m (RequesterData response)
185+forRequesterData r f = traverseRequesterData f r
186+
133data MyTagType :: * -> * where
187data MyTagType :: * -> * where
134 MyTagType_Single :: MyTagType (Single a)
188 MyTagType_Single :: MyTagType (Single a)
135 MyTagType_Multi :: MyTagType Multi
189 MyTagType_Multi :: MyTagType Multi
@@ -167,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
167type family EntryContents request a where
221type family EntryContents request a where
168 EntryContents request (Single a) = request a
222 EntryContents request (Single a) = request a
169 EntryContents request Multi = IntMap (RequesterData request)
223 EntryContents request Multi = IntMap (RequesterData request)
170− EntryContents request (Multi2 k) = Map (Some k) (IntMap (RequesterData request))
224+ EntryContents request (Multi2 k) = Multi2Contents k request
171 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
172
226
227+data Multi2Contents k request = Multi2Contents
228+ { _multi2Contents_dict :: {-# UNPACK #-} !(Dict (GCompare k)) -- This is a Dict instead of an existential context because we only want to use it in certain circumstances
229+ , _multi2Contents_values :: {-# UNPACK #-} !(Map (Some k) (IntMap (RequesterData request)))
230+ }
231+
173newtype Entry request x = Entry { unEntry :: EntryContents request x }
232newtype Entry request x = Entry { unEntry :: EntryContents request x }
174
233
175{-# INLINE singleEntry #-}
234{-# INLINE singleEntry #-}
@@ -239,6 +298,10 @@ deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
239deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
240deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
241
300
301+instance PrimMonad m => PrimMonad (RequesterT t request response m) where
302+ type PrimState (RequesterT t request response m) = PrimState m
303+ primitive = lift . primitive
304+
242-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
305-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
243instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
306instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
244 mempty = pure mempty
307 mempty = pure mempty
@@ -252,7 +315,6 @@ instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response
252-- requests are made, and responses should be provided in the input 'Event'.
315-- requests are made, and responses should be provided in the input 'Event'.
253-- The 'Tag' keys will be used to return the responses to the same place the
316-- The 'Tag' keys will be used to return the responses to the same place the
254-- requests were issued.
317-- requests were issued.
255−
256runRequesterT :: (Reflex t, Monad m)
318runRequesterT :: (Reflex t, Monad m)
257 => RequesterT t request response m a
319 => RequesterT t request response m a
258 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
320 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
@@ -262,6 +324,20 @@ runRequesterT (RequesterT a) responses = do
262 coerceEvent responses
324 coerceEvent responses
263 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
325 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
264
326
327+-- | Map a function over the request and response of a 'RequesterT'
328+withRequesterT
329+ :: (Reflex t, MonadFix m)
330+ => (forall x. req x -> req' x) -- ^ The function to map over the request
331+ -> (forall x. rsp' x -> rsp x) -- ^ The function to map over the response
332+ -> RequesterT t req rsp m a -- ^ The internal 'RequesterT' whose input and output will be transformed
333+ -> RequesterT t req' rsp' m a -- ^ The resulting 'RequesterT'
334+withRequesterT freq frsp child = do
335+ rec let rsp = fmap (runIdentity . traverseRequesterData (Identity . frsp)) rsp'
336+ (a, req) <- lift $ runRequesterT child rsp
337+ rsp' <- fmap (flip selectInt 0 . fanInt . fmapCheap unMultiEntry) $ requesting' $
338+ fmapCheap (multiEntry . IntMap.singleton 0) $ fmap (runIdentity . traverseRequesterData (Identity . freq)) req
339+ return a
340+
265instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
341instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
266 type Request (RequesterT t request response m) = request
342 type Request (RequesterT t request response m) = request
267 type Response (RequesterT t request response m) = response
343 type Response (RequesterT t request response m) = response
@@ -281,7 +357,7 @@ tagRequest req = do
281 return t
357 return t
282
358
283{-# INLINE responseFromTag #-}
359{-# INLINE responseFromTag #-}
284−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))
285responseFromTag (MyTagWrap t) = do
361responseFromTag (MyTagWrap t) = do
286 responses :: EventSelectorInt t Any <- RequesterT ask
362 responses :: EventSelectorInt t Any <- RequesterT ask
287 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -289,6 +365,9 @@ responseFromTag (MyTagWrap t) = do
289instance MonadTrans (RequesterT t request response) where
365instance MonadTrans (RequesterT t request response) where
290 lift = RequesterT . lift . lift
366 lift = RequesterT . lift . lift
291
367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
292instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
293 type Performable (RequesterT t request response m) = Performable m
372 type Performable (RequesterT t request response m) = Performable m
294 performEvent_ = lift . performEvent_
373 performEvent_ = lift . performEvent_
@@ -365,7 +444,7 @@ traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIn
365 pack = Entry
444 pack = Entry
366 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
445 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
367 f' k (n, v) = do
446 f' k (n, v) = do
368− (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?
369 return (fmapCheap (IntMap.singleton n) myRequests, result)
448 return (fmapCheap (IntMap.singleton n) myRequests, result)
370 ndm' <- numberOccurrencesFrom 1 dm'
449 ndm' <- numberOccurrencesFrom 1 dm'
371 (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
450 (children0, children') <- base f' (fmap ((,) 0) dm0) $ fmap (\(n, dm) -> fmap ((,) n) dm) ndm' --TODO: Avoid this somehow, probably by adding some sort of per-cohort information passing to Adjustable
@@ -408,12 +487,12 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
408 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
409 responses = fanMap $ fmapCheap unpack response
488 responses = fanMap $ fmapCheap unpack response
410 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
411− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
412 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
491 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
413− pack = Entry
492+ pack m = Entry $ Multi2Contents { _multi2Contents_values = m, _multi2Contents_dict = Dict }
414 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
415 f' k (Compose (n, v)) = do
494 f' k (Compose (n, v)) = do
416− (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))
417 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
496 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
418 ndm' <- numberOccurrencesFrom 1 dm'
497 ndm' <- numberOccurrencesFrom 1 dm'
419 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
498 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
@@ -427,3 +506,102 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
427 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
506 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
428 requests <- holdIncremental requests0 requests'
507 requests <- holdIncremental requests0 requests'
429 return (result0, result')
508 return (result0, result')
509+
510+data Decoder rawResponse response =
511+ forall a. Decoder (RequesterDataKey a) (rawResponse -> response a)
512+
513+matchResponsesWithRequests
514+ :: forall t rawRequest rawResponse request response m.
515+ ( MonadFix m
516+ , MonadHold t m
517+ , Reflex t
518+ )
519+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
520+ -- ^ Given a request (from 'Requester'), produces the wire format of the
521+ -- request and a function used to process the associated response
522+ -> Event t (RequesterData request)
523+ -- ^ The outgoing requests
524+ -> Event t (Int, rawResponse)
525+ -- ^ The incoming responses, tagged by an identifying key
526+ -> m ( Event t (Map Int rawRequest)
527+ , Event t (RequesterData response)
528+ )
529+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
530+ -- by the 'RequesterData' key of the associated outgoing request
531+matchResponsesWithRequests f send recv = matchResponseMapWithRequests f send $ uncurry Map.singleton <$> recv
532+
533+-- | Matches incoming responses with previously-sent requests
534+-- and uses the provided request "decoder" function to process
535+-- incoming responses.
536+matchResponseMapWithRequests
537+ :: forall t rawRequest rawResponse request response m.
538+ ( MonadFix m
539+ , MonadHold t m
540+ , Reflex t
541+ )
542+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
543+ -- ^ Given a request (from 'Requester'), produces the wire format of the
544+ -- request and a function used to process the associated response
545+ -> Event t (RequesterData request)
546+ -- ^ The outgoing requests
547+ -> Event t (Map Int rawResponse)
548+ -- ^ A map of incoming responses, tagged by an identifying key
549+ -> m ( Event t (Map Int rawRequest)
550+ , Event t (RequesterData response)
551+ )
552+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
553+ -- by the 'RequesterData' key of the associated outgoing request
554+matchResponseMapWithRequests f send recv = do
555+ rec nextId <- hold 1 $ fmap (\(next, _, _) -> next) outgoing
556+ waitingFor :: Incremental t (PatchMap Int (Decoder rawResponse response)) <-
557+ holdIncremental mempty $ leftmost
558+ [ fmap (\(_, outstanding, _) -> outstanding) outgoing
559+ , snd <$> incoming
560+ ]
561+ let outgoing = processOutgoing nextId send
562+ incoming = processIncoming waitingFor recv
563+ return (fmap (\(_, _, rawReqs) -> rawReqs) outgoing, fst <$> incoming)
564+ where
565+ -- Tags each outgoing request with an identifying integer key
566+ -- and returns the next available key, a map of response decoders
567+ -- for requests for which there are outstanding responses, and the
568+ -- raw requests to be sent out.
569+ processOutgoing
570+ :: Behavior t Int
571+ -- The next available key
572+ -> Event t (RequesterData request)
573+ -- The outgoing request
574+ -> Event t ( Int
575+ , PatchMap Int (Decoder rawResponse response)
576+ , Map Int rawRequest )
577+ -- The new next-available-key, a map of requests expecting responses, and the tagged raw requests
578+ processOutgoing nextId out = flip pushAlways out $ \dm -> do
579+ oldNextId <- sample nextId
580+ let (result, newNextId) = flip runState oldNextId $ forM (requesterDataToList dm) $ \(k :=> v) -> do
581+ n <- get
582+ put $ succ n
583+ let (rawReq, rspF) = f v
584+ return (n, rawReq, Decoder k rspF)
585+ patchWaitingFor = PatchMap $ Map.fromList $
586+ (\(n, _, dec) -> (n, Just dec)) <$> result
587+ toSend = Map.fromList $ (\(n, rawReq, _) -> (n, rawReq)) <$> result
588+ return (newNextId, patchWaitingFor, toSend)
589+ -- Looks up the each incoming raw response in a map of response
590+ -- decoders and returns the decoded response and a patch that can
591+ -- be used to clear the ID of the consumed response out of the queue
592+ -- of expected responses.
593+ processIncoming
594+ :: Incremental t (PatchMap Int (Decoder rawResponse response))
595+ -- A map of outstanding expected responses
596+ -> Event t (Map Int rawResponse)
597+ -- A incoming response paired with its identifying key
598+ -> Event t (RequesterData response, PatchMap Int v)
599+ -- The decoded response and a patch that clears the outstanding responses queue
600+ processIncoming waitingFor inc = flip push inc $ \rspMap -> do
601+ wf <- sample $ currentIncremental waitingFor
602+ let match rawRsp (Decoder k rspF) =
603+ let rsp = rspF rawRsp
604+ in singletonRequesterData k rsp
605+ matches = Map.intersectionWith match rspMap wf
606+ pure $ if Map.null matches then Nothing else Just
607+ (Map.foldl' mergeRequesterData emptyRequesterData matches, PatchMap $ Nothing <$ matches)
src/Reflex/Requester/Class.hs−1
@@ -6,7 +6,6 @@
6{-# LANGUAGE CPP #-}
6{-# LANGUAGE CPP #-}
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE TypeFamilies #-}
12{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
src/Reflex/Spider.hs+5−2
@@ -1,6 +1,9 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2+-- |
3+-- Module:
4+-- Reflex.Spider
5+-- Description:
2−-- | This module exports all of the user-facing functionality of the 'Spider'
6+-- This module exports all of the user-facing functionality of the 'Spider' 'Reflex' engine
3−-- 'Reflex' engine
4module Reflex.Spider
7module Reflex.Spider
5 ( Spider
8 ( Spider
6 , SpiderTimeline
9 , SpiderTimeline
src/Reflex/Spider/Internal.hs+743−451
@@ -9,17 +9,22 @@
9{-# LANGUAGE GADTs #-}
9{-# LANGUAGE GADTs #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11{-# LANGUAGE LambdaCase #-}
11{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MultiParamTypeClasses #-}
13−{-# LANGUAGE MultiWayIf #-}
14{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
15{-# LANGUAGE RoleAnnotations #-}
13{-# LANGUAGE RoleAnnotations #-}
16{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE ScopedTypeVariables #-}
17{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeFamilies #-}
18{-# LANGUAGE TypeOperators #-}
16{-# LANGUAGE TypeOperators #-}
19{-# LANGUAGE UndecidableInstances #-}
17{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
20#ifdef USE_REFLEX_OPTIMIZER
24#ifdef USE_REFLEX_OPTIMIZER
21{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
25{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
22#endif
26#endif
27+{-# OPTIONS_GHC -Wunused-binds #-}
23-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
28-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
24-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
29-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
25module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
30module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
@@ -33,12 +38,17 @@ import Control.Monad hiding (forM, forM_, mapM, mapM_)
33import Control.Monad.Exception
38import Control.Monad.Exception
34import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
39import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
35import Control.Monad.Primitive
40import 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
37import Control.Monad.Ref
44import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
38import Data.Align
47import Data.Align
39import Data.Coerce
48import Data.Coerce
40−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
41import qualified Data.Dependent.Map as DMap
50import qualified Data.Dependent.Map as DMap
51+import Data.Dependent.Sum (DSum (..))
42import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
52import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
43import qualified Data.FastMutableIntMap as FastMutableIntMap
53import qualified Data.FastMutableIntMap as FastMutableIntMap
44import Data.Foldable hiding (concat, elem, sequence_)
54import Data.Foldable hiding (concat, elem, sequence_)
@@ -49,54 +59,73 @@ import Data.GADT.Compare
49import Data.IntMap.Strict (IntMap)
59import Data.IntMap.Strict (IntMap)
50import qualified Data.IntMap.Strict as IntMap
60import qualified Data.IntMap.Strict as IntMap
51import Data.IORef
61import Data.IORef
52−import Data.Maybe
62+import Data.Kind (Type)
63+import Data.Maybe hiding (mapMaybe)
53−import Data.Monoid ((<>))
64+import Data.Monoid (mempty, (<>))
54import Data.Proxy
65import Data.Proxy
55import Data.These
66import Data.These
56import Data.Traversable
67import Data.Traversable
57−import GHC.Exts
68+import Data.Type.Equality ((:~:)(Refl))
69+import Data.Witherable (Filterable, mapMaybe)
70+import GHC.Exts hiding (toList)
58import GHC.IORef (IORef (..))
71import GHC.IORef (IORef (..))
59import GHC.Stack
72import GHC.Stack
60import Reflex.FastWeak
73import Reflex.FastWeak
61−import Reflex.FunctorMaybe
62import System.IO.Unsafe
74import System.IO.Unsafe
63import System.Mem.Weak
75import System.Mem.Weak
64import Unsafe.Coerce
76import Unsafe.Coerce
65
77
78+#ifdef MIN_VERSION_semialign
79+#if MIN_VERSION_these(0,8,0)
80+import Data.These.Combinators (justThese)
81+#endif
82+#if MIN_VERSION_semialign(1,1,0)
83+import Data.Zip (Zip (..))
84+#endif
85+#endif
86+
66#ifdef DEBUG_CYCLES
87#ifdef DEBUG_CYCLES
67import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
88import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
68import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
91import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
69import qualified Data.List.NonEmpty as NonEmpty
92import qualified Data.List.NonEmpty as NonEmpty
70−import Data.Monoid (mempty)
71import Data.Tree (Forest, Tree (..), drawForest)
93import Data.Tree (Forest, Tree (..), drawForest)
72−#endif
94+import Data.List (isPrefixOf)
73
95
74−import Data.FastWeakBag (FastWeakBag)
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
75import qualified Data.FastWeakBag as FastWeakBag
97import qualified Data.FastWeakBag as FastWeakBag
98+
76import Data.Reflection
99import Data.Reflection
77−import Data.Some (Some)
100+import Data.Some (Some(Some))
78−import qualified Data.Some as Some
79import Data.Type.Coercion
101import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
80import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
103import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
81import qualified Data.WeakBag as WeakBag
104import qualified Data.WeakBag as WeakBag
82import qualified Reflex.Class
105import qualified Reflex.Class
83import qualified Reflex.Class as R
106import qualified Reflex.Class as R
84import qualified Reflex.Host.Class
107import qualified Reflex.Host.Class
85import Reflex.NotReady.Class
108import Reflex.NotReady.Class
86−import Reflex.Patch
109+import Data.Patch
87−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111+import Reflex.PerformEvent.Base (PerformEventT)
88
112
89#ifdef DEBUG_TRACE_EVENTS
113#ifdef DEBUG_TRACE_EVENTS
90import qualified Data.ByteString.Char8 as BS8
114import qualified Data.ByteString.Char8 as BS8
91import System.IO (stderr)
115import System.IO (stderr)
116+import Data.List (isPrefixOf)
92#endif
117#endif
93
118
94−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
95
122
123+#ifdef DEBUG_TRACE_EVENTS
96withStackOneLine :: (BS8.ByteString -> a) -> a
124withStackOneLine :: (BS8.ByteString -> a) -> a
97withStackOneLine expr = unsafePerformIO $ do
125withStackOneLine expr = unsafePerformIO $ do
98 stack <- currentCallStack
126 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"
100
129
101#endif
130#endif
102
131
@@ -107,28 +136,42 @@ debugInvalidateHeight :: Bool
107debugInvalidate :: Bool
136debugInvalidate :: Bool
108
137
109#ifdef DEBUG
138#ifdef DEBUG
110−
111#define DEBUG_NODEIDS
139#define DEBUG_NODEIDS
112
140
141+#ifdef DEBUG_TRACE_PROPAGATION
113debugPropagate = True
142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
114
146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
115debugInvalidateHeight = False
150debugInvalidateHeight = False
151+#endif
116
152
153+#ifdef DEBUG_TRACE_INVALIDATION
117debugInvalidate = True
154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
118
158
119class HasNodeId a where
159class HasNodeId a where
120 getNodeId :: a -> Int
160 getNodeId :: a -> Int
121
161
122−instance HasNodeId (Hold x p a) where
162+instance HasNodeId (CacheSubscribed x a) where
163+ getNodeId = _cacheSubscribed_nodeId
164+
165+instance HasNodeId (FanInt x a) where
123− getNodeId = holdNodeId
166+ getNodeId = _fanInt_nodeId
124
167
125−instance HasNodeId (PushSubscribed x a b) where
168+instance HasNodeId (Hold x p) where
126− getNodeId = pushSubscribedNodeId
169+ getNodeId = holdNodeId
127
170
128instance HasNodeId (SwitchSubscribed x a) where
171instance HasNodeId (SwitchSubscribed x a) where
129 getNodeId = switchSubscribedNodeId
172 getNodeId = switchSubscribedNodeId
130
173
131−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
132 getNodeId = fanSubscribedNodeId
175 getNodeId = fanSubscribedNodeId
133
176
134instance HasNodeId (CoincidenceSubscribed x a) where
177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -142,41 +185,16 @@ instance HasNodeId (Pull x a) where
142
185
143{-# INLINE showNodeId #-}
186{-# INLINE showNodeId #-}
144showNodeId :: HasNodeId a => a -> String
187showNodeId :: HasNodeId a => a -> String
145−showNodeId = ("#"<>) . show . getNodeId
188+showNodeId = showNodeId' . getNodeId
146−
189+
147−showSubscriberType :: Subscriber x a -> String
190+showNodeId' :: Int -> String
148−showSubscriberType = \case
191+showNodeId' = ("#"<>) . show
149− SubscriberPush _ _ -> "SubscriberPush"
192+
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"
173
193
174#else
194#else
175
195
176debugPropagate = False
196debugPropagate = False
177−
178debugInvalidateHeight = False
197debugInvalidateHeight = False
179−
180debugInvalidate = False
198debugInvalidate = False
181
199
182-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -184,6 +202,10 @@ debugInvalidate = False
184showNodeId :: a -> String
202showNodeId :: a -> String
185showNodeId _ = ""
203showNodeId _ = ""
186
204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
187#endif
209#endif
188
210
189#ifdef DEBUG_NODEIDS
211#ifdef DEBUG_NODEIDS
@@ -193,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
193
215
194newNodeId :: IO Int
216newNodeId :: IO Int
195newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
196−
197−{-# NOINLINE unsafeNodeId #-}
198−unsafeNodeId :: a -> Int
199−unsafeNodeId a = unsafePerformIO $ do
200− touch a
201− newNodeId
202#endif
218#endif
203
219
204--------------------------------------------------------------------------------
220--------------------------------------------------------------------------------
@@ -235,9 +251,9 @@ subscribeAndRead = unEvent
235-- caching; if the computation function is very cheap, this is (much) more
251-- caching; if the computation function is very cheap, this is (much) more
236-- efficient than 'push'
252-- efficient than 'push'
237{-# INLINE [1] pushCheap #-}
253{-# 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
239pushCheap !f e = Event $ \sub -> do
255pushCheap !f e = Event $ \sub -> do
240− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
241 { subscriberPropagate = \a -> do
257 { subscriberPropagate = \a -> do
242 mb <- f a
258 mb <- f a
243 mapM_ (subscriberPropagate sub) mb
259 mapM_ (subscriberPropagate sub) mb
@@ -256,10 +272,10 @@ terminalSubscriber p = Subscriber
256
272
257-- | Subscribe to an Event only for the duration of one occurrence
273-- | Subscribe to an Event only for the duration of one occurrence
258{-# INLINE subscribeAndReadHead #-}
274{-# 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)
260subscribeAndReadHead e sub = do
276subscribeAndReadHead e sub = do
261 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
262− (subscription, occ) <- subscribeAndRead e $ sub
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
263 { subscriberPropagate = \a -> do
279 { subscriberPropagate = \a -> do
264 liftIO $ unsubscribe =<< readIORef subscriptionRef
280 liftIO $ unsubscribe =<< readIORef subscriptionRef
265 subscriberPropagate sub a
281 subscriberPropagate sub a
@@ -270,24 +286,42 @@ subscribeAndReadHead e sub = do
270 return (subscription, occ)
286 return (subscription, occ)
271
287
272--TODO: Make this lazy in its input event
288--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)
274headE originalE = do
290headE originalE = do
275 parent <- liftIO $ newIORef $ Just originalE
291 parent <- liftIO $ newIORef $ Just originalE
276 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
277 let clearParent = liftIO $ writeIORef parent Nothing
293 let clearParent = liftIO $ writeIORef parent Nothing
278− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
279 when (isJust occ) clearParent
295 when (isJust occ) clearParent
280− return $ Event $ \sub -> do
296+ return $ Event $ \sub ->
281 liftIO (readIORef parent) >>= \case
297 liftIO (readIORef parent) >>= \case
282− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
298+ Nothing -> subscribeAndReadNever
283 Just e -> subscribeAndReadHead e sub
299 Just e -> subscribeAndReadHead e sub
284
300
285data CacheSubscribed x a
301data CacheSubscribed x a
286 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
287 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
288 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
289 }
308 }
290
309
310+nowSpiderEventM :: (HasSpiderTimeline x) => EventM x (R.Event (SpiderTimeline x) ())
311+nowSpiderEventM =
312+ SpiderEvent <$> now
313+
314+now :: (MonadIO m, Defer (Some Clear) m, HasSpiderTimeline x
315+ ) => m (Event x ())
316+now = do
317+ nowOrNot <- liftIO $ newIORef $ Just ()
318+ scheduleClear nowOrNot
319+ return . Event $ \_ -> do
320+ occ <- liftIO . readIORef $ nowOrNot
321+ return ( EventSubscription (return ()) eventSubscribedNow
322+ , occ
323+ )
324+
291-- | Construct an 'Event' whose value is guaranteed not to be recomputed
325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
292-- repeatedly
326-- repeatedly
293--
327--
@@ -302,27 +336,33 @@ cacheEvent e =
302#else
336#else
303 Event $
337 Event $
304#endif
338#endif
339+ unsafePerformIO $ do
305− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
306− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
341+ <- newIORef emptyFastWeak
307− in \sub -> {-# SCC "cacheEvent" #-} do
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
308#ifdef DEBUG_TRACE_EVENTS
343#ifdef DEBUG_TRACE_EVENTS
309 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
310#endif
345#endif
311 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
312 Just subscribedTicket -> return subscribedTicket
347 Just subscribedTicket -> return subscribedTicket
313 Nothing -> do
348 Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
314 subscribers <- liftIO FastWeakBag.empty
352 subscribers <- liftIO FastWeakBag.empty
315 occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
353 occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
354+#ifdef DEBUG_NODEIDS
355+ (parentSub, occ) <- subscribeAndRead e $ debugSubscriber' ("cacheEvent" <> showNodeId' nodeId) $ Subscriber
356+#else
316 (parentSub, occ) <- subscribeAndRead e $ Subscriber
357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
358+#endif
317− { subscriberPropagate = \a -> do
359+ { subscriberPropagate = \a -> do
318− liftIO $ writeIORef occRef $ Just a
360+ liftIO $ writeIORef occRef (Just a)
319− scheduleClear occRef
361+ scheduleClear occRef
320− propagateFast a subscribers
362+ propagateFast a subscribers
321− , subscriberInvalidateHeight = \old -> do
322− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
363+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
323− , subscriberRecalculateHeight = \new -> do
324− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
364+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
325− }
365+ }
326 when (isJust occ) $ do
366 when (isJust occ) $ do
327 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
328 scheduleClear occRef
368 scheduleClear occRef
@@ -330,29 +370,45 @@ cacheEvent e =
330 { _cacheSubscribed_subscribers = subscribers
370 { _cacheSubscribed_subscribers = subscribers
331 , _cacheSubscribed_parent = parentSub
371 , _cacheSubscribed_parent = parentSub
332 , _cacheSubscribed_occurrence = occRef
372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
333 }
376 }
334 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
335 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
336 return subscribedTicket
379 return subscribedTicket
337− liftIO $ do
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
338− subscribed <- getFastWeakTicketValue subscribedTicket
385+ subscribed <- getFastWeakTicketValue subscribedTicket
339− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
386+ ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
340− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
387+ occ <- readIORef $ _cacheSubscribed_occurrence subscribed
388+
389+ let parentSub = _cacheSubscribed_parent subscribed
341− let es = EventSubscription
390+ es = EventSubscription
342− { _eventSubscription_unsubscribe = do
391+ { _eventSubscription_unsubscribe = do
343− FastWeakBag.remove ticket
392+ FastWeakBag.remove ticket
393+
344− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
394+ isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
345− when isEmpty $ do
395+ when isEmpty $ do
346− writeIORef mSubscribedRef emptyFastWeak
396+ writeIORef mSubscribedRef emptyFastWeak
347− unsubscribe $ _cacheSubscribed_parent subscribed
397+ unsubscribe parentSub
348− touch ticket
398+ touch ticket
349− touch subscribedTicket
399+ touch subscribedTicket
350− , _eventSubscription_subscribed = EventSubscribed
400+ , _eventSubscription_subscribed = EventSubscribed
351− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
401+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
352− , eventSubscribedRetained = toAny subscribedTicket
402+ , eventSubscribedRetained = toAny subscribedTicket
403+#ifdef DEBUG_CYCLES
404+ , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
405+ , eventSubscribedHasOwnHeightRef = False
406+ , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
407+#endif
353− }
408+ }
354− }
409+ }
355− return (es, occ)
410+ return (es, occ)
411+
356
412
357subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
358subscribe e s = fst <$> subscribeAndRead e s
414subscribe e s = fst <$> subscribeAndRead e s
@@ -364,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
364 let es = tag subd
420 let es = tag subd
365 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
366
422
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
368eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
369
425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
370eventNever :: Event x a
429eventNever :: Event x a
371−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
372
431
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)
374eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
375
434
376eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -405,16 +464,6 @@ data Subscriber x a = Subscriber
405 , subscriberRecalculateHeight :: !(Height -> IO ())
464 , subscriberRecalculateHeight :: !(Height -> IO ())
406 }
465 }
407
466
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−
418newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
419newSubscriberHold h = return $ Subscriber
468newSubscriberHold h = return $ Subscriber
420 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -422,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
422 , subscriberRecalculateHeight = \_ -> return ()
471 , subscriberRecalculateHeight = \_ -> return ()
423 }
472 }
424
473
425−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
474+newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
426−newSubscriberFan subscribed = return $ Subscriber
475+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
427 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
428 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
477 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"
430 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
431 scheduleClear $ fanSubscribedOccurrence subscribed
480 scheduleClear $ fanSubscribedOccurrence subscribed
432− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
433 propagate v $ _fanSubscribedChildren_list subsubs
482 propagate v $ _fanSubscribedChildren_list subsubs
434 return $ Constant ()
483 return $ Constant ()
435 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
436 return ()
485 return ()
437 , subscriberInvalidateHeight = \old -> do
486 , subscriberInvalidateHeight = \old -> do
438− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
439 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
440− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
441− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
442 , subscriberRecalculateHeight = \new -> do
489 , subscriberRecalculateHeight = \new -> do
443− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
444 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
445− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
446− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
447 }
492 }
448
493
449newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
450−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
451 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
452− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
453 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
454 scheduleClear $ switchSubscribedOccurrence subscribed
498 scheduleClear $ switchSubscribedOccurrence subscribed
455 propagate a $ switchSubscribedSubscribers subscribed
499 propagate a $ switchSubscribedSubscribers subscribed
456 , subscriberInvalidateHeight = \_ -> do
500 , subscriberInvalidateHeight = \_ -> do
457− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
458 oldHeight <- readIORef $ switchSubscribedHeight subscribed
501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
459 when (oldHeight /= invalidHeight) $ do
502 when (oldHeight /= invalidHeight) $ do
460 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
461− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
462− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
463− , subscriberRecalculateHeight = \new -> do
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
464− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
465− updateSwitchHeight new subscribed
466− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
467− }
506+ }
468
507
469newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
470−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
471 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
472− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
473 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
474 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
475 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
476 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
477 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
478 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
479 scheduleClear $ coincidenceSubscribedInnerParent subscribed
518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
480 case occ of
519 case occ of
481− Nothing -> do
520+ Nothing ->
482 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
483 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
484− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
485− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
486 Just o -> do -- Since it's already firing, no need to adjust height
525 Just o -> do -- Since it's already firing, no need to adjust height
487 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
488 scheduleClear $ coincidenceSubscribedOccurrence subscribed
527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
489 propagate o $ coincidenceSubscribedSubscribers subscribed
528 propagate o $ coincidenceSubscribedSubscribers subscribed
490− , subscriberInvalidateHeight = \_ -> do
491− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
492− invalidateCoincidenceHeight subscribed
529+ , subscriberInvalidateHeight = \_ -> 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
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
497− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
498 }
531 }
499
532
500newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
501−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
502 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
503− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
504 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
505 case occ of
537 case occ of
506 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -508,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
508 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
509 scheduleClear $ coincidenceSubscribedOccurrence subscribed
541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
510 propagate a $ coincidenceSubscribedSubscribers subscribed
542 propagate a $ coincidenceSubscribedSubscribers subscribed
511− , subscriberInvalidateHeight = \_ -> do
512− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
513− invalidateCoincidenceHeight subscribed
543+ , subscriberInvalidateHeight = \_ -> 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
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
518− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
519 }
545 }
520
546
521invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -525,18 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
525recalculateSubscriberHeight = flip subscriberRecalculateHeight
551recalculateSubscriberHeight = flip subscriberRecalculateHeight
526
552
527-- | Propagate everything at the current height
553-- | Propagate everything at the current height
528−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
554+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
529−propagate a subscribers = withIncreasedDepth $ do
555+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
530 -- 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
556 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
531 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
557 --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
533
559
534-- | Propagate everything at the current height
560-- | Propagate everything at the current height
535−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
561+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
536−propagateFast a subscribers = withIncreasedDepth $ do
562+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
537 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
563 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
538 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
539− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
540
566
541--------------------------------------------------------------------------------
567--------------------------------------------------------------------------------
542-- EventSubscribed
568-- EventSubscribed
@@ -545,11 +571,16 @@ propagateFast a subscribers = withIncreasedDepth $ do
545toAny :: a -> Any
571toAny :: a -> Any
546toAny = unsafeCoerce
572toAny = unsafeCoerce
547
573
574+-- Why do we use Any here, instead of just giving eventSubscribedRetained an
575+-- existential type? Sadly, GHC does not currently know how to unbox types
576+-- with existentially quantified fields. So instead we just coerce values
577+-- to type Any on the way in. Since we never coerce them back, this is
578+-- perfectly safe.
548data EventSubscribed x = EventSubscribed
579data EventSubscribed x = EventSubscribed
549 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
550 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
551#ifdef DEBUG_CYCLES
582#ifdef DEBUG_CYCLES
552− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
553 , eventSubscribedHasOwnHeightRef :: !Bool
584 , eventSubscribedHasOwnHeightRef :: !Bool
554 , eventSubscribedWhoCreated :: !(IO [String])
585 , eventSubscribedWhoCreated :: !(IO [String])
555#endif
586#endif
@@ -576,13 +607,23 @@ eventSubscribedNever = EventSubscribed
576 , eventSubscribedWhoCreated = return ["never"]
607 , eventSubscribedWhoCreated = return ["never"]
577#endif
608#endif
578 }
609 }
610+eventSubscribedNow :: EventSubscribed x
611+eventSubscribedNow = EventSubscribed
612+ { eventSubscribedHeightRef = zeroRef
613+ , eventSubscribedRetained = toAny ()
614+#ifdef DEBUG_CYCLES
615+ , eventSubscribedGetParents = return []
616+ , eventSubscribedHasOwnHeightRef = False
617+ , eventSubscribedWhoCreated = return ["now"]
618+#endif
619+ }
579
620
580−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
581eventSubscribedFan !subscribed = EventSubscribed
622eventSubscribedFan !subscribed = EventSubscribed
582 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
583 , eventSubscribedRetained = toAny subscribed
624 , eventSubscribedRetained = toAny subscribed
584#ifdef DEBUG_CYCLES
625#ifdef DEBUG_CYCLES
585− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
586 , eventSubscribedHasOwnHeightRef = False
627 , eventSubscribedHasOwnHeightRef = False
587 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
588#endif
629#endif
@@ -595,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
595#ifdef DEBUG_CYCLES
636#ifdef DEBUG_CYCLES
596 , eventSubscribedGetParents = do
637 , eventSubscribedGetParents = do
597 s <- readIORef $ switchSubscribedCurrentParent subscribed
638 s <- readIORef $ switchSubscribedCurrentParent subscribed
598− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
599 , eventSubscribedHasOwnHeightRef = True
640 , eventSubscribedHasOwnHeightRef = True
600 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
601#endif
642#endif
@@ -608,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
608#ifdef DEBUG_CYCLES
649#ifdef DEBUG_CYCLES
609 , eventSubscribedGetParents = do
650 , eventSubscribedGetParents = do
610 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
611− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
612− innerParents = maybeToList $ fmap Some.This innerSubscription
653+ innerParents = maybeToList $ innerSubscription
613 return $ outerParent : innerParents
654 return $ outerParent : innerParents
614 , eventSubscribedHasOwnHeightRef = True
655 , eventSubscribedHasOwnHeightRef = True
615 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -623,15 +664,15 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
623whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
624whoCreatedEventSubscribed = eventSubscribedWhoCreated
665whoCreatedEventSubscribed = eventSubscribedWhoCreated
625
666
626−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
627walkInvalidHeightParents s0 = do
668walkInvalidHeightParents 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
629 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
630 when (h == invalidHeight) $ do
671 when (h == invalidHeight) $ do
631 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
632− modify (Some.This s :)
673+ modify (s :)
633 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
634− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
635 return subscribers
676 return subscribers
636#endif
677#endif
637
678
@@ -659,7 +700,7 @@ behaviorPull !p = Behavior $ do
659 val <- liftIO $ readIORef $ pullValue p
700 val <- liftIO $ readIORef $ pullValue p
660 case val of
701 case val of
661 Just subscribed -> do
702 Just subscribed -> do
662− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
663 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
664 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
665 return $ pullSubscribedValue subscribed
706 return $ pullSubscribedValue subscribed
@@ -668,7 +709,7 @@ behaviorPull !p = Behavior $ do
668 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
669 parentsRef <- liftIO $ newIORef []
710 parentsRef <- liftIO $ newIORef []
670 holdInits <- askBehaviorHoldInits
711 holdInits <- askBehaviorHoldInits
671− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
672 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
673 parents <- liftIO $ readIORef parentsRef
714 parents <- liftIO $ readIORef parentsRef
674 let subscribed = PullSubscribed
715 let subscribed = PullSubscribed
@@ -678,7 +719,7 @@ behaviorPull !p = Behavior $ do
678 , pullSubscribedParents = parents
719 , pullSubscribedParents = parents
679 }
720 }
680 liftIO $ writeIORef (pullValue p) $ Just subscribed
721 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)) :))
682 return a
723 return a
683
724
684behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -689,7 +730,7 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
689readHoldTracked h = do
730readHoldTracked h = do
690 result <- liftIO $ readIORef $ holdValue h
731 result <- liftIO $ readIORef $ holdValue h
691 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
732 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)) :))
693 liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
734 liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
694 return result
735 return result
695
736
@@ -703,42 +744,46 @@ readBehaviorUntracked b = do
703-- Dynamic
744-- Dynamic
704--------------------------------------------------------------------------------
745--------------------------------------------------------------------------------
705
746
747+type DynamicS x p = Dynamic x (PatchTarget p) p
748+
706−data Dynamic x p = Dynamic
749+data Dynamic x target p = Dynamic
707− { dynamicCurrent :: !(Behavior x (PatchTarget p))
750+ { dynamicCurrent :: !(Behavior x target)
708− , dynamicUpdated :: !(Event x p)
751+ , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
709 }
752 }
710
753
754+deriving instance (HasSpiderTimeline x) => Functor (Dynamic x target)
755+
756+
757+
758+
711−dynamicHold :: Hold x p -> Dynamic x p
759+dynamicHold :: Hold x p -> DynamicS x p
712dynamicHold !h = Dynamic
760dynamicHold !h = Dynamic
713 { dynamicCurrent = behaviorHold h
761 { dynamicCurrent = behaviorHold h
714 , dynamicUpdated = eventHold h
762 , dynamicUpdated = eventHold h
715 }
763 }
716
764
717−dynamicHoldIdentity :: Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
718dynamicHoldIdentity = dynamicHold
766dynamicHoldIdentity = dynamicHold
719
767
720−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
721dynamicConst !a = Dynamic
769dynamicConst !a = Dynamic
722 { dynamicCurrent = behaviorConst a
770 { dynamicCurrent = behaviorConst a
723 , dynamicUpdated = eventNever
771 , dynamicUpdated = eventNever
724 }
772 }
725
773
726−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
727dynamicDyn !d = Dynamic
775dynamicDyn !d = Dynamic
728 { dynamicCurrent = behaviorDyn d
776 { dynamicCurrent = behaviorDyn d
729 , dynamicUpdated = eventDyn d
777 , dynamicUpdated = eventDyn d
730 }
778 }
731
779
732−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
733dynamicDynIdentity = dynamicDyn
781dynamicDynIdentity = dynamicDyn
734
782
735--------------------------------------------------------------------------------
783--------------------------------------------------------------------------------
736-- Combinators
784-- Combinators
737--------------------------------------------------------------------------------
785--------------------------------------------------------------------------------
738
786
739−--TODO: Figure out why certain things are not 'representational', then make them
740−--representational so we can use coerce
741−
742--type role Hold representational
787--type role Hold representational
743data Hold x p
788data Hold x p
744 = Hold { holdValue :: !(IORef (PatchTarget p))
789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -759,20 +804,25 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
759
804
760-- | Stores all global data relevant to a particular Spider timeline; only one
805-- | Stores all global data relevant to a particular Spider timeline; only one
761-- value should exist for each type @x@
806-- value should exist for each type @x@
807+newtype SpiderTimelineEnv x = STE {unSTE :: SpiderTimelineEnv' x}
808+-- We implement SpiderTimelineEnv with a newtype wrapper so
809+-- we can get the coercions we want safely.
810+type role SpiderTimelineEnv nominal
811+
762−data SpiderTimelineEnv x = SpiderTimelineEnv
812+data SpiderTimelineEnv' x = SpiderTimelineEnv
763 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
764 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
765#ifdef DEBUG
815#ifdef DEBUG
766 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
767#endif
817#endif
768 }
818 }
769−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
770
820
771instance Eq (SpiderTimelineEnv x) where
821instance Eq (SpiderTimelineEnv x) where
772 _ == _ = True -- Since only one exists of each type
822 _ == _ = True -- Since only one exists of each type
773
823
774instance GEq SpiderTimelineEnv where
824instance 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)
776 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
777 else Nothing
827 else Nothing
778
828
@@ -782,9 +832,9 @@ data EventEnv x
782 , eventEnvDynInits :: !(IORef [SomeDynInit x])
832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
783 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
784 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
785− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
786− , eventEnvIntClears :: !(IORef [SomeIntClear])
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
787− , eventEnvRootClears :: !(IORef [SomeRootClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
788 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
789 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
790 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -795,7 +845,7 @@ runEventM :: EventM x a -> IO a
795runEventM = unEventM
845runEventM = unEventM
796
846
797asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
847asksEventEnv :: 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))
799
849
800class MonadIO m => Defer a m where
850class MonadIO m => Defer a m where
801 getDeferralQueue :: m (IORef [a])
851 getDeferralQueue :: m (IORef [a])
@@ -856,29 +906,29 @@ putCurrentHeight h = do
856 heightRef <- asksEventEnv eventEnvCurrentHeight
906 heightRef <- asksEventEnv eventEnvCurrentHeight
857 liftIO $ writeIORef heightRef $! h
907 liftIO $ writeIORef heightRef $! h
858
908
859−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
860 {-# INLINE getDeferralQueue #-}
910 {-# INLINE getDeferralQueue #-}
861 getDeferralQueue = asksEventEnv eventEnvClears
911 getDeferralQueue = asksEventEnv eventEnvClears
862
912
863{-# INLINE scheduleClear #-}
913{-# INLINE scheduleClear #-}
864−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
865−scheduleClear r = defer $ SomeClear r
915+scheduleClear r = defer $ Some $ Clear r
866
916
867−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
868 {-# INLINE getDeferralQueue #-}
918 {-# INLINE getDeferralQueue #-}
869 getDeferralQueue = asksEventEnv eventEnvIntClears
919 getDeferralQueue = asksEventEnv eventEnvIntClears
870
920
871{-# INLINE scheduleIntClear #-}
921{-# INLINE scheduleIntClear #-}
872−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
873−scheduleIntClear r = defer $ SomeIntClear r
923+scheduleIntClear r = defer $ Some $ IntClear r
874
924
875−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
876 {-# INLINE getDeferralQueue #-}
926 {-# INLINE getDeferralQueue #-}
877 getDeferralQueue = asksEventEnv eventEnvRootClears
927 getDeferralQueue = asksEventEnv eventEnvRootClears
878
928
879{-# INLINE scheduleRootClear #-}
929{-# INLINE scheduleRootClear #-}
880−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
881−scheduleRootClear r = defer $ SomeRootClear r
931+scheduleRootClear r = defer $ Some $ RootClear r
882
932
883instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
884 {-# INLINE getDeferralQueue #-}
934 {-# INLINE getDeferralQueue #-}
@@ -933,9 +983,9 @@ getHoldEventSubscription h = do
933
983
934type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
935
985
936−--type role BehaviorM representational
937-- BehaviorM can sample behaviors
986-- 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))
939
989
940instance Monad (BehaviorM x) where
990instance Monad (BehaviorM x) where
941 {-# INLINE (>>=) #-}
991 {-# INLINE (>>=) #-}
@@ -944,14 +994,16 @@ instance Monad (BehaviorM x) where
944 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
945 {-# INLINE return #-}
995 {-# INLINE return #-}
946 return x = BehaviorM $ return x
996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
947 {-# INLINE fail #-}
998 {-# INLINE fail #-}
948 fail s = BehaviorM $ fail s
999 fail s = BehaviorM $ fail s
1000+#endif
949
1001
950data BehaviorSubscribed x a
1002data BehaviorSubscribed x a
951 = forall p. BehaviorSubscribedHold (Hold x p)
1003 = forall p. BehaviorSubscribedHold (Hold x p)
952 | BehaviorSubscribedPull (PullSubscribed x a)
1004 | BehaviorSubscribedPull (PullSubscribed x a)
953
1005
954−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
955
1007
956--type role PullSubscribed representational
1008--type role PullSubscribed representational
957data PullSubscribed x a
1009data PullSubscribed x a
@@ -986,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
986#endif
1038#endif
987 }
1039 }
988
1040
989−data Root x (k :: * -> *)
1041+data Root x k
990 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
991 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
992 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
1044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -1005,7 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
1005newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1006
1058
1007-- EventM can do everything BehaviorM can, plus create holds
1059-- 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)
1009
1061
1010newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1011
1063
@@ -1030,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
1030heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1031
1083
1032heightBagAdd :: Height -> HeightBag -> HeightBag
1084heightBagAdd :: 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
1034
1087
1035heightBagRemove :: Height -> HeightBag -> HeightBag
1088heightBagRemove :: Height -> HeightBag -> HeightBag
1036heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
1089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1039,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
1039 0 -> IntMap.delete h c
1092 0 -> IntMap.delete h c
1040 _ -> IntMap.insert h (pred old) c
1093 _ -> IntMap.insert h (pred old) c
1041
1094
1095+heightBagRemoveMaybe :: Height -> HeightBag -> Maybe HeightBag
1096+heightBagRemoveMaybe (Height h) b@(HeightBag s c) = heightBagVerify . removed <$> IntMap.lookup h c where
1097+ removed old = HeightBag (pred s) $ case old of
1098+ 0 -> IntMap.delete h c
1099+ _ -> IntMap.insert h (pred old) c
1100+
1101+
1042heightBagMax :: HeightBag -> Height
1102heightBagMax :: HeightBag -> Height
1043heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1044 Just ((h, _), _) -> Height h
1104 Just ((h, _), _) -> Height h
@@ -1056,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
1056heightBagVerify = id
1116heightBagVerify = id
1057#endif
1117#endif
1058
1118
1059−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1119+data FanSubscribedChildren x k v a = FanSubscribedChildren
1060− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1120+ { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1061− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1121+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1062− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
1122+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
1063 }
1123 }
1064
1124
1065−data FanSubscribed (x :: *) k
1125+data FanSubscribed x k v
1066− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1126+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1067− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1127+ , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1068− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
1128+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
1069 , fanSubscribedParent :: !(EventSubscription x)
1129 , fanSubscribedParent :: !(EventSubscription x)
1070#ifdef DEBUG_NODEIDS
1130#ifdef DEBUG_NODEIDS
1071 , fanSubscribedNodeId :: Int
1131 , fanSubscribedNodeId :: Int
1072#endif
1132#endif
1073 }
1133 }
1074
1134
1075−data Fan x k
1135+data Fan x k v
1076− = Fan { fanParent :: !(Event x (DMap k Identity))
1136+ = Fan { fanParent :: !(Event x (DMap k v))
1077− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1137+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1078 }
1138 }
1079
1139
1080data SwitchSubscribed x a
1140data SwitchSubscribed x a
@@ -1128,24 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
1128newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1129newInvalidatorPull p = return $! InvalidatorPull p
1189newInvalidatorPull p = return $! InvalidatorPull p
1130
1190
1131−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1132− fmapMaybe f = push $ return . f
1192+ mapMaybe f = push $ return . f
1133
1193
1134instance HasSpiderTimeline x => Align (Event x) where
1194instance HasSpiderTimeline x => Align (Event x) where
1135 nil = eventNever
1195 nil = eventNever
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 $
1136− align ea eb = fmapMaybe dmapToThese $ merge $ dynamicConst $ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
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
1137
1208
1138data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
1209data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
1139 | BuildDyn !(EventM x (PatchTarget p), Event x p)
1210 | BuildDyn !(EventM x (PatchTarget p), Event x p)
1140 | HoldDyn !(Hold x p)
1211 | HoldDyn !(Hold x p)
1141
1212
1142−newtype Dyn x p = Dyn { unDyn :: IORef (DynType x p) }
1213+newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
1143
1214
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)
1145newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1146
1217
1147--TODO: Avoid the duplication between this and R.zipDynWith
1218--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)
1149zipDynWith f da db =
1220zipDynWith f da db =
1150 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1151 ec = flip push eab $ \o -> do
1222 ec = flip push eab $ \o -> do
@@ -1168,18 +1239,12 @@ buildDynamic readV0 v' = do
1168 return d
1239 return d
1169
1240
1170unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1171−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ UnsafeDyn x
1242+unsafeBuildDynamic readV0 v' =
1172− where x = (readV0, v')
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
1173
1244
1174-- ResultM can read behaviors and events
1245-- ResultM can read behaviors and events
1175type ResultM = EventM
1246type ResultM = EventM
1176
1247
1177−{-# NOINLINE unsafeNewIORef #-}
1178−unsafeNewIORef :: a -> b -> IORef b
1179−unsafeNewIORef a b = unsafePerformIO $ do
1180− touch a
1181− newIORef b
1182−
1183instance HasSpiderTimeline x => Functor (Event x) where
1248instance HasSpiderTimeline x => Functor (Event x) where
1184 fmap f = push $ return . Just . f
1249 fmap f = push $ return . Just . f
1185
1250
@@ -1192,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
1192
1257
1193{-# INLINABLE pull #-}
1258{-# INLINABLE pull #-}
1194pull :: BehaviorM x a -> Behavior x a
1259pull :: BehaviorM x a -> Behavior x a
1195−pull a = behaviorPull $ Pull
1260+pull a = unsafePerformIO $ do
1196− { pullCompute = a
1261+ ref <- newIORef Nothing
1197− , pullValue = unsafeNewIORef a Nothing
1198#ifdef DEBUG_NODEIDS
1262#ifdef DEBUG_NODEIDS
1199− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
1200#endif
1264#endif
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1201− }
1271+ }
1202
1272
1203{-# INLINABLE switch #-}
1273{-# INLINABLE switch #-}
1204switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1205−switch a = eventSwitch $ Switch
1277+ pure $ eventSwitch $ Switch
1206− { switchParent = a
1278+ { switchParent = a
1207− , switchSubscribed = unsafeNewIORef a Nothing
1279+ , switchSubscribed = ref
1208− }
1280+ }
1209
1281
1210coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1211−coincidence a = eventCoincidence $ Coincidence
1285+ pure $ eventCoincidence $ Coincidence
1212− { coincidenceParent = a
1286+ { coincidenceParent = a
1213− , coincidenceSubscribed = unsafeNewIORef a Nothing
1287+ , coincidenceSubscribed = ref
1214− }
1288+ }
1215
1289
1216-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1217run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1218run roots after = do
1292run roots after = do
1219 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1220 let t = spiderTimeline :: SpiderTimelineEnv x
1294 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
1222 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1223 occBefore <- liftIO $ do
1297 occBefore <- liftIO $ do
1224 occBefore <- readIORef occRef
1298 occBefore <- readIORef occRef
@@ -1256,11 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1256 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1257 EQ -> a
1331 EQ -> a
1258
1332
1259−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
1260
1334
1261−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
1262
1336
1263−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
1264
1338
1265data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1266
1340
@@ -1272,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
1272 x' <- evaluate x
1346 x' <- evaluate x
1273 mkWeakPtr x' $
1347 mkWeakPtr x' $
1274 if debugFinalize
1348 if debugFinalize
1275− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
1276 else Nothing
1350 else Nothing
1277
1351
1278type WeakList a = [Weak a]
1352type WeakList a = [Weak a]
1279
1353
1280−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
1281#ifdef DEBUG
1359#ifdef DEBUG
1360+
1361+debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1362+debugSubscriber description = return . debugSubscriber' description
1363+
1364+debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1365+debugSubscriber' description subscribed = Subscriber
1366+ {
1367+ subscriberPropagate = \m -> do
1368+ tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1369+ subscriberPropagate subscribed m
1370+ , subscriberInvalidateHeight = \old -> do
1371+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1372+ subscriberInvalidateHeight subscribed old
1373+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1374+ , subscriberRecalculateHeight = \new -> do
1375+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1376+ subscriberRecalculateHeight subscribed new
1377+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1378+ }
1379+
1380+
1282−withIncreasedDepth :: CanTrace x m => m a -> m a
1381+{-# INLINE withIncreasedDepth #-}
1382+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1283−withIncreasedDepth a = do
1383+withIncreasedDepth _ a = do
1284− spiderTimeline <- askSpiderTimelineEnv
1285− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
1384+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
1286 result <- a
1385 result <- a
1287− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
1288 return result
1387 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)
1295
1388
1296{-# INLINE tracePropagate #-}
1389{-# INLINE tracePropagate #-}
1297tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1298−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
1299
1392
1300{-# INLINE traceInvalidate #-}
1393{-# INLINE traceInvalidate #-}
1301traceInvalidate :: String -> IO ()
1394traceInvalidate :: 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
1303
1400
1304−{-# INLINE traceWhen #-}
1401+{-# INLINE trace #-}
1305−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1402+trace :: (CanTrace x m) => proxy x -> String -> m ()
1306−traceWhen p b message = traceMWhen p b $ return message
1403+trace p message = traceM p $ return message
1307
1404
1308−{-# INLINE traceMWhen #-}
1405+{-# INLINE traceM #-}
1309−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1406+traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1310−traceMWhen _ b getMessage = when b $ do
1407+traceM _ getMessage = do
1311 message <- getMessage
1408 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+
1315#else
1412#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+
1317#endif
1448#endif
1318− liftIO $ putStrLn $ replicate d ' ' <> message
1319
1449
1320whoCreatedIORef :: IORef a -> IO [String]
1450whoCreatedIORef :: IORef a -> IO [String]
1321whoCreatedIORef (IORef a) = whoCreated $! a
1451whoCreatedIORef (IORef a) = whoCreated $! a
1322
1452
1323−#ifdef DEBUG_CYCLES
1324groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1325groupByHead = \case
1454groupByHead = \case
1326 [] -> []
1455 [] -> []
@@ -1331,20 +1460,54 @@ groupByHead = \case
1331 | otherwise -> (x, xs :| []) : l
1460 | otherwise -> (x, xs :| []) : l
1332
1461
1333listsToForest :: Eq a => [[a]] -> Forest a
1462listsToForest :: 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+
1335#endif
1495#endif
1336
1496
1497+
1337{-# INLINE propagateSubscriberHold #-}
1498{-# INLINE propagateSubscriberHold #-}
1338propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1339propagateSubscriberHold h a = do
1500propagateSubscriberHold h a = do
1340− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
1341 invalidators <- liftIO $ readIORef $ holdInvalidators h
1502 invalidators <- liftIO $ readIORef $ holdInvalidators h
1342 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
1343 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1344 case {-# SCC "apply" #-} apply a v of
1506 case {-# SCC "apply" #-} apply a v of
1345 Nothing -> return ()
1507 Nothing -> return ()
1346 Just v' -> do
1508 Just v' -> do
1509+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1347− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1510+ tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
1348 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1349 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1350 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1352,25 +1515,25 @@ propagateSubscriberHold h a = do
1352data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1353
1516
1354runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1355−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
1356
1519
1357askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1358askInvalidator = do
1521askInvalidator = do
1359− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
1360 case m of
1523 case m of
1361 Nothing -> return Nothing
1524 Nothing -> return Nothing
1362 Just (!wi, _) -> return $ Just wi
1525 Just (!wi, _) -> return $ Just wi
1363
1526
1364askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1365askParentsRef = do
1528askParentsRef = do
1366− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
1367 case m of
1530 case m of
1368 Nothing -> return Nothing
1531 Nothing -> return Nothing
1369 Just (_, !p) -> return $ Just p
1532 Just (_, !p) -> return $ Just p
1370
1533
1371askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1372askBehaviorHoldInits = do
1535askBehaviorHoldInits = do
1373− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
1374 return his
1537 return his
1375
1538
1376{-# INLINE getDynHold #-}
1539{-# INLINE getDynHold #-}
@@ -1398,7 +1561,7 @@ getDynHold d = do
1398zeroRef :: IORef Height
1561zeroRef :: IORef Height
1399zeroRef = unsafePerformIO $ newIORef zeroHeight
1562zeroRef = unsafePerformIO $ newIORef zeroHeight
1400
1563
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)
1402getRootSubscribed k r sub = do
1565getRootSubscribed k r sub = do
1403 mSubscribed <- readIORef $ rootSubscribed r
1566 mSubscribed <- readIORef $ rootSubscribed r
1404 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1412,9 +1575,14 @@ getRootSubscribed k r sub = do
1412 let !cached = rootSubscribed r
1575 let !cached = rootSubscribed r
1413 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1414 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1578+
1415− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
1416 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1417 writeIORef uninitRef $! uninit
1582 writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
1418 let !subscribed = RootSubscribed
1586 let !subscribed = RootSubscribed
1419 { rootSubscribedKey = k
1587 { rootSubscribedKey = k
1420 , rootSubscribedCachedSubscribed = cached
1588 , rootSubscribedCachedSubscribed = cached
@@ -1423,7 +1591,7 @@ getRootSubscribed k r sub = do
1423 , rootSubscribedUninit = uninit
1591 , rootSubscribedUninit = uninit
1424 , rootSubscribedWeakSelf = weakSelf
1592 , rootSubscribedWeakSelf = weakSelf
1425#ifdef DEBUG_NODEIDS
1593#ifdef DEBUG_NODEIDS
1426− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
1427#endif
1595#endif
1428 }
1596 }
1429 -- If we die at the same moment that all our children die, they will
1597 -- If we die at the same moment that all our children die, they will
@@ -1459,6 +1627,9 @@ data FanInt x a = FanInt
1459 { _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
1627 { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1460 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1461 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
1462 }
1633 }
1463
1634
1464newFanInt :: IO (FanInt x a)
1635newFanInt :: IO (FanInt x a)
@@ -1466,38 +1637,39 @@ newFanInt = do
1466 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
1637 subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1467 subscriptionRef <- newIORef $ error "fanInt: no subscription"
1638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
1468 occRef <- newIORef $ error "fanInt: no occurrence"
1639 occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
1469 return $ FanInt
1643 return $ FanInt
1470 { _fanInt_subscribers = subscribers
1644 { _fanInt_subscribers = subscribers
1471 , _fanInt_subscriptionRef = subscriptionRef
1645 , _fanInt_subscriptionRef = subscriptionRef
1472 , _fanInt_occRef = occRef
1646 , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
1473 }
1650 }
1474
1651
1475−{-# NOINLINE unsafeNewFanInt #-}
1476−unsafeNewFanInt :: b -> FanInt x a
1477−unsafeNewFanInt b = unsafePerformIO $ do
1478− touch b
1479− newFanInt
1480−
1481fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1482−fanInt p =
1653+fanInt p = unsafePerformIO $ do
1483− let self = unsafeNewFanInt p
1654+ self <- newFanInt
1484− in EventSelectorInt $ \k -> Event $ \sub -> do
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
1485 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1486 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1487− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
1488 { subscriberPropagate = \m -> do
1660 { subscriberPropagate = \m -> do
1489 liftIO $ writeIORef (_fanInt_occRef self) m
1661 liftIO $ writeIORef (_fanInt_occRef self) m
1490 scheduleIntClear $ _fanInt_occRef self
1662 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?
1663+ FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1492− FastWeakBag.traverse b $ \s -> do
1664+ FastWeakBag.traverse_ b $ \s ->
1493 subscriberPropagate s v
1665 subscriberPropagate s v
1494− , subscriberInvalidateHeight = \old -> do
1666+ , subscriberInvalidateHeight = \old ->
1495− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1496− FastWeakBag.traverse b $ \s -> do
1668+ FastWeakBag.traverse_ b $ \s ->
1497 subscriberInvalidateHeight s old
1669 subscriberInvalidateHeight s old
1498− , subscriberRecalculateHeight = \new -> do
1670+ , subscriberRecalculateHeight = \new ->
1499− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1500− FastWeakBag.traverse b $ \s -> do
1672+ FastWeakBag.traverse_ b $ \s ->
1501 subscriberRecalculateHeight s new
1673 subscriberRecalculateHeight s new
1502 }
1674 }
1503 liftIO $ do
1675 liftIO $ do
@@ -1511,13 +1683,28 @@ fanInt p =
1511 FastMutableIntMap.insert (_fanInt_subscribers self) k b
1683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
1512 return b
1684 return b
1513 Just b -> return b
1685 Just b -> return b
1514− t <- liftIO $ FastWeakBag.insert sub b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
1515 currentOcc <- readIORef (_fanInt_occRef self)
1687 currentOcc <- readIORef (_fanInt_occRef self)
1516− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1688+
1689+ subscribed <- fanIntSubscribed ticket self
1517− return (EventSubscription (FastWeakBag.remove t) $! EventSubscribed heightRef $! toAny (_fanInt_subscriptionRef self, t), IntMap.lookup k currentOcc)
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+
1518
1705
1519{-# INLINABLE getFanSubscribed #-}
1706{-# 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))
1521getFanSubscribed k f sub = do
1708getFanSubscribed k f sub = do
1522 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1523 case mSubscribed of
1710 case mSubscribed of
@@ -1535,13 +1722,16 @@ getFanSubscribed k f sub = do
1535 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1536 occRef <- liftIO $ newIORef parentOcc
1723 occRef <- liftIO $ newIORef parentOcc
1537 when (isJust parentOcc) $ scheduleClear occRef
1724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
1538 let subscribed = FanSubscribed
1728 let subscribed = FanSubscribed
1539 { fanSubscribedCachedSubscribed = fanSubscribed f
1729 { fanSubscribedCachedSubscribed = fanSubscribed f
1540 , fanSubscribedOccurrence = occRef
1730 , fanSubscribedOccurrence = occRef
1541 , fanSubscribedParent = subscription
1731 , fanSubscribedParent = subscription
1542 , fanSubscribedSubscribers = subscribersRef
1732 , fanSubscribedSubscribers = subscribersRef
1543#ifdef DEBUG_NODEIDS
1733#ifdef DEBUG_NODEIDS
1544− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
1545#endif
1735#endif
1546 }
1736 }
1547 let !self = (k, subscribed)
1737 let !self = (k, subscribed)
@@ -1551,7 +1741,7 @@ getFanSubscribed k f sub = do
1551 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1552 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1553
1743
1554−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
1555cleanupFanSubscribed (k, subscribed) = do
1745cleanupFanSubscribed (k, subscribed) = do
1556 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1557 let reducedSubscribers = DMap.delete k subscribers
1747 let reducedSubscribers = DMap.delete k subscribers
@@ -1563,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
1563 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1564
1754
1565{-# INLINE subscribeFanSubscribed #-}
1755{-# 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
1567subscribeFanSubscribed k subscribed sub = do
1757subscribeFanSubscribed k subscribed sub = do
1568 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1569 case DMap.lookup k subscribers of
1759 case DMap.lookup k subscribers of
@@ -1601,6 +1791,9 @@ getSwitchSubscribed s sub = do
1601 when (isJust parentOcc) $ scheduleClear occRef
1791 when (isJust parentOcc) $ scheduleClear occRef
1602 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1603 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
1604 let !subscribed = SwitchSubscribed
1797 let !subscribed = SwitchSubscribed
1605 { switchSubscribedCachedSubscribed = switchSubscribed s
1798 { switchSubscribedCachedSubscribed = switchSubscribed s
1606 , switchSubscribedOccurrence = occRef
1799 , switchSubscribedOccurrence = occRef
@@ -1613,7 +1806,7 @@ getSwitchSubscribed s sub = do
1613 , switchSubscribedCurrentParent = subscriptionRef
1806 , switchSubscribedCurrentParent = subscriptionRef
1614 , switchSubscribedWeakSelf = weakSelf
1807 , switchSubscribedWeakSelf = weakSelf
1615#ifdef DEBUG_NODEIDS
1808#ifdef DEBUG_NODEIDS
1616− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
1617#endif
1810#endif
1618 }
1811 }
1619 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1658,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
1658 scheduleClear innerSubdRef
1851 scheduleClear innerSubdRef
1659 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1660 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
1661 let subscribed = CoincidenceSubscribed
1857 let subscribed = CoincidenceSubscribed
1662 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1663 , coincidenceSubscribedOccurrence = occRef
1859 , coincidenceSubscribedOccurrence = occRef
@@ -1668,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
1668 , coincidenceSubscribedInnerParent = innerSubdRef
1864 , coincidenceSubscribedInnerParent = innerSubdRef
1669 , coincidenceSubscribedWeakSelf = weakSelf
1865 , coincidenceSubscribedWeakSelf = weakSelf
1670#ifdef DEBUG_NODEIDS
1866#ifdef DEBUG_NODEIDS
1671− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
1672#endif
1868#endif
1673 }
1869 }
1674 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1685,57 +1881,72 @@ cleanupCoincidenceSubscribed subscribed = do
1685subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1686subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1687
1883
1688−{-# INLINE merge #-}
1884+{-# INLINE mergeG #-}
1689−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1885+mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
1886+ => (forall a. q a -> Event x (v a))
1887+ -> DynamicS x (PatchDMap k q) -> Event x (DMap k v)
1690−merge d = cacheEvent (mergeCheap d)
1888+mergeG nt d = cacheEvent (mergeCheap nt d)
1691
1889
1692{-# INLINE mergeWithMove #-}
1890{-# INLINE mergeWithMove #-}
1693−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1891+mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
1892+ => (forall a. q a -> Event x (v a))
1893+ -> DynamicS x (PatchDMapWithMove k q) -> Event x (DMap k v)
1694−mergeWithMove d = cacheEvent (mergeCheapWithMove d)
1894+mergeWithMove nt d = cacheEvent (mergeCheapWithMove nt d)
1695
1895
1696{-# INLINE [1] mergeCheap #-}
1896{-# INLINE [1] mergeCheap #-}
1897+mergeCheap
1697−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
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)
1698−mergeCheap = mergeCheap' getInitialSubscribers updateMe destroy
1902+mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
1699 where
1903 where
1700− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
1701 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1702 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1703 (mOldSubd, newPs) <- case me of
1907 (mOldSubd, newPs) <- case me of
1704 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1705 Just e -> do
1909 Just e -> do
1706 let s = subscriber $ return k
1910 let s = subscriber $ return k
1707− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
1708 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1709 let newParent = MergeSubscribedParent subscription
1913 let newParent = MergeSubscribedParent subscription
1710 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1711 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1712 forM_ mOldSubd $ \oldSubd -> do
1916 forM_ mOldSubd $ \oldSubd -> do
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1713− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
1714 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1715 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1716 foldM f ([], oldParents) $ DMap.toList p
1922 foldM f ([], oldParents) $ DMap.toList p
1923+
1717− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
1718 getInitialSubscribers initialParents subscriber = do
1925 getInitialSubscribers initialParents subscriber = do
1719 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1720 let s = subscriber $ return k
1927 let s = subscriber $ return k
1721− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1722 height <- liftIO $ getEventSubscribedHeight parentSubd
1929 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)
1724 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1725 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1726 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1727 )
1934 )
1935+
1728 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1729 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1730
1938
1731{-# INLINE [1] mergeCheapWithMove #-}
1939{-# INLINE [1] mergeCheapWithMove #-}
1732−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1940+mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
1941+ => (forall a. q a -> Event x (v a))
1942+ -> DynamicS x (PatchDMapWithMove k q)
1943+ -> Event x (DMap k v)
1733−mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1944+mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
1734 where
1945 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)
1736 updateMe subscriber heightBagRef oldParents p = do
1947 updateMe subscriber heightBagRef oldParents p = do
1737 -- Prepare new parents for insertion
1948 -- 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)
1739 subscribeParent k e = do
1950 subscribeParent k e = do
1740 keyRef <- liftIO $ newIORef k
1951 keyRef <- liftIO $ newIORef k
1741 let s = subscriber $ liftIO $ readIORef keyRef
1952 let s = subscriber $ liftIO $ readIORef keyRef
@@ -1744,73 +1955,82 @@ mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1744 newParentHeight <- getEventSubscribedHeight subd
1955 newParentHeight <- getEventSubscribedHeight subd
1745 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1746 return $ MergeSubscribedParentWithMove subscription keyRef
1957 return $ MergeSubscribedParentWithMove subscription keyRef
1747− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
1748 -- Collect old parents for deletion and update the keys of moved parents
1959 -- 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
1750 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1751 Nothing -> do
1962 Nothing -> do
1752− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
1753 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1754 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1755 Just toKey -> do
1968 Just toKey -> do
1756 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1757 return Nothing
1970 return Nothing
1971+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1758− toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1972+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1973+
1759 return (toDelete, applyAlways p' oldParents)
1974 return (toDelete, applyAlways p' oldParents)
1760− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
1761 getInitialSubscribers initialParents subscriber = do
1976 getInitialSubscribers initialParents subscriber = do
1762 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1763 keyRef <- liftIO $ newIORef k
1978 keyRef <- liftIO $ newIORef k
1764 let s = subscriber $ liftIO $ readIORef keyRef
1979 let s = subscriber $ liftIO $ readIORef keyRef
1765− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1766 height <- liftIO $ getEventSubscribedHeight parentSubd
1981 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)
1768 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1769 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1770 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1771 )
1986 )
1987+
1772 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1773 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1774
1990
1775−type MergeUpdateFunc k x p s
1991+type MergeUpdateFunc k v x p s
1776− = (forall a. EventM x (k a) -> Subscriber x a)
1992+ = (forall a. EventM x (k a) -> Subscriber x (v a))
1777 -> IORef HeightBag
1993 -> IORef HeightBag
1778 -> DMap k s
1994 -> DMap k s
1779 -> p
1995 -> p
1780 -> EventM x ([EventSubscription x], DMap k s)
1996 -> EventM x ([EventSubscription x], DMap k s)
1781
1997
1998+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1999+
1782−type MergeInitFunc k x s
2000+type MergeInitFunc k v q x s
1783− = DMap k (Event x)
2001+ = DMap k q
1784− -> (forall a. EventM x (k a) -> Subscriber x a)
2002+ -> (forall a. EventM x (k a) -> Subscriber x (v a))
1785− -> EventM x (DMap k Identity, [Height], DMap k s)
2003+ -> EventM x (DMap k v, [Height], DMap k s)
1786
2004
1787type MergeDestroyFunc k s
2005type MergeDestroyFunc k s
1788 = DMap k s
2006 = DMap k s
1789 -> IO ()
2007 -> IO ()
1790
2008
1791−data Merge x k s = Merge
2009+data Merge x k v s = Merge
1792 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
2010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
1793 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
2011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
1794 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
2012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1795− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
1796− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
1797 }
2015 }
1798
2016
1799−invalidateMergeHeight :: Merge x k s -> IO ()
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
1800invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
2018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
1801
2019
1802invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
2020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
1803invalidateMergeHeight' heightRef sub = do
2021invalidateMergeHeight' heightRef sub = do
1804 oldHeight <- readIORef heightRef
2022 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
1806 writeIORef heightRef $! invalidHeight
2025 writeIORef heightRef $! invalidHeight
1807 subscriberInvalidateHeight sub oldHeight
2026 subscriberInvalidateHeight sub oldHeight
1808
2027
1809−
1810−revalidateMergeHeight :: Merge x k s -> IO ()
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
1811revalidateMergeHeight m = do
2029revalidateMergeHeight m = do
1812 currentHeight <- readIORef $ _merge_heightRef m
2030 currentHeight <- readIORef $ _merge_heightRef m
2031+
1813− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2032+ -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2033+ when (currentHeight == invalidHeight) $ do
1814 heights <- readIORef $ _merge_heightBagRef m
2034 heights <- readIORef $ _merge_heightBagRef m
1815 parents <- readIORef $ _merge_parentsRef m
2035 parents <- readIORef $ _merge_parentsRef m
1816 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
2036 -- 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
1818 LT -> return ()
2038 LT -> return ()
1819 EQ -> do
2039 EQ -> do
1820 let height = succHeight $ heightBagMax heights
2040 let height = succHeight $ heightBagMax heights
1821− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
1822 writeIORef (_merge_heightRef m) $! height
2042 writeIORef (_merge_heightRef m) $! height
1823 subscriberRecalculateHeight (_merge_sub m) height
2043 subscriberRecalculateHeight (_merge_sub m) height
1824 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
2044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
1825
2045
1826−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
1827scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
2047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
1828 vals <- liftIO $ readIORef $ _merge_accumRef m
2048 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
1830 --TODO: Assert that m is not empty
2052 --TODO: Assert that m is not empty
1831 subscriberPropagate (_merge_sub m) vals
2053 subscriberPropagate (_merge_sub m) vals
1832
2054
2055+checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2056+checkCycle subscribed = liftIO $ do
2057+ height <- readIORef (eventSubscribedHeightRef subscribed)
2058+
2059+ -- currentHeight <- getCurrentHeight
2060+ -- when (height <= currentHeight) $ if height /= invalidHeight
2061+ -- then do
2062+ -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2063+ -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2064+ -- else liftIO $
2065+ when (height == invalidHeight) $
2066+#ifdef DEBUG_CYCLES
2067+ do
2068+ nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2069+ stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2070+ throwIO (EventLoopException stacks)
2071+#else
2072+ throwIO EventLoopException
2073+#endif
2074+
2075+
1833−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
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)
1834−mergeSubscriber m getKey = Subscriber
2077+mergeSubscriber subscribed m getKey = Subscriber
1835 { subscriberPropagate = \a -> do
2078 { subscriberPropagate = \a -> do
1836 oldM <- liftIO $ readIORef $ _merge_accumRef m
2079 oldM <- liftIO $ readIORef $ _merge_accumRef m
1837 k <- getKey
2080 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
1839 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
2082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
1840 liftIO $ writeIORef (_merge_accumRef m) $! newM
2083 liftIO $ writeIORef (_merge_accumRef m) $! newM
1841 when (DMap.null oldM) $ do -- Only schedule the firing once
2084 when (DMap.null oldM) $ do -- Only schedule the firing once
1842 height <- liftIO $ readIORef $ _merge_heightRef m
2085 height <- liftIO $ readIORef $ _merge_heightRef m
1843− --TODO: assertions about height
2086+ checkCycle subscribed
1844− currentHeight <- getCurrentHeight
2087+
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
1859 scheduleMergeSelf m height
2088 scheduleMergeSelf m height
1860 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
2089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
1861 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
2090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1866,30 +2095,45 @@ mergeSubscriber m getKey = Subscriber
1866 }
2095 }
1867
2096
1868--TODO: Be able to run as much of this as possible promptly
2097--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
2098+updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
1870−updateMerge m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2099+updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
1871 where updateMe = do
2100 where updateMe = do
1872 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
2101 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
1874 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
2103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
1875 return subscriptionsToKill
2104 return subscriptionsToKill
1876
2105
1877−{-# INLINE mergeCheap' #-}
2106+{-# INLINE mergeGCheap' #-}
2107+mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
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)
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)
1879−mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
2109+mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
1880 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
1881 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
2111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
1882 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
2112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
1883 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
2113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
1884 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
2114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
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+
1885− let m = Merge
2129+ m = Merge
1886 { _merge_parentsRef = parentsRef
2130 { _merge_parentsRef = parentsRef
1887 , _merge_heightBagRef = heightBagRef
2131 , _merge_heightBagRef = heightBagRef
1888 , _merge_heightRef = heightRef
2132 , _merge_heightRef = heightRef
1889 , _merge_sub = sub
2133 , _merge_sub = sub
1890 , _merge_accumRef = accumRef
2134 , _merge_accumRef = accumRef
1891 }
2135 }
1892− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
1893 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
2137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1894 myHeight = if invalidHeight `elem` heights
2138 myHeight = if invalidHeight `elem` heights
1895 then invalidHeight
2139 then invalidHeight
@@ -1898,50 +2142,57 @@ mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
1898 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
2142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1899 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
2143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1900 else (Nothing, dm)
2144 else (Nothing, dm)
1901− unless (DMap.null accum) $ do
1902− scheduleMergeSelf m myHeight
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
1903 liftIO $ writeIORef accumRef $! accum
2146 liftIO $ writeIORef accumRef $! accum
1904 liftIO $ writeIORef heightRef $! myHeight
2147 liftIO $ writeIORef heightRef $! myHeight
1905 liftIO $ writeIORef heightBagRef $! myHeightBag
2148 liftIO $ writeIORef heightBagRef $! myHeightBag
1906− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1907 liftIO $ writeIORef parentsRef $! initialParentState
2149 liftIO $ writeIORef parentsRef $! initialParentState
1908 defer $ SomeMergeInit $ do
2150 defer $ SomeMergeInit $ do
1909− let s = Subscriber
2151+ let changeSubscriber = Subscriber
1910 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1911− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
1912− defer $ updateMerge m updateFunc a
2154+ defer $ updateMerge subscribed m updateFunc a
1913 , subscriberInvalidateHeight = \_ -> return ()
2155 , subscriberInvalidateHeight = \_ -> return ()
1914 , subscriberRecalculateHeight = \_ -> return ()
2156 , subscriberRecalculateHeight = \_ -> return ()
1915 }
2157 }
1916− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2158+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
1917− forM_ change $ \c -> defer $ updateMerge m updateFunc c
2159+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
1918 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
1919 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
1920 -- its subscription.
2162 -- its subscription.
1921− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
1922 let unsubscribeAll = destroy =<< readIORef parentsRef
2164 let unsubscribeAll = destroy =<< readIORef parentsRef
1923− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1924− , occ
1925− )
1926
2165
2166+ return (EventSubscription unsubscribeAll subscribed, occ)
2167+
2168+
1927−mergeInt :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2169+mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
1928mergeInt = cacheEvent . mergeIntCheap
2170mergeInt = cacheEvent . mergeIntCheap
1929
2171
1930{-# INLINABLE mergeIntCheap #-}
2172{-# 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)
1932mergeIntCheap d = Event $ \sub -> do
2174mergeIntCheap d = Event $ \sub -> do
1933 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
1934 accum <- liftIO $ FastMutableIntMap.newEmpty
2176 accum <- liftIO $ FastMutableIntMap.newEmpty
1935 heightRef <- liftIO $ newIORef zeroHeight
2177 heightRef <- liftIO $ newIORef zeroHeight
1936 heightBagRef <- liftIO $ newIORef heightBagEmpty
2178 heightBagRef <- liftIO $ newIORef heightBagEmpty
1937 parents <- liftIO $ FastMutableIntMap.newEmpty
2179 parents <- liftIO $ FastMutableIntMap.newEmpty
2180+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2181+ let subscribed = EventSubscribed
2182+ { eventSubscribedHeightRef = heightRef
2183+ , eventSubscribedRetained = toAny (parents, changeSubdRef)
2184+#ifdef DEBUG_CYCLES
2185+ , eventSubscribedGetParents = fmap (_eventSubscription_subscribed . snd) <$> FastMutableIntMap.toList parents
2186+ , eventSubscribedHasOwnHeightRef = False
2187+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2188+#endif
2189+ }
1938 let scheduleSelf = do
2190 let scheduleSelf = do
1939 height <- liftIO $ readIORef $ heightRef
2191 height <- liftIO $ readIORef $ heightRef
1940 scheduleMerge' height heightRef $ do
2192 scheduleMerge' height heightRef $ do
1941 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
2193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
1942 subscriberPropagate sub vals
2194 subscriberPropagate sub vals
1943− invalidateMyHeight = do
1944− invalidateMergeHeight' heightRef sub
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
1945 recalculateMyHeight = do
2196 recalculateMyHeight = do
1946 currentHeight <- readIORef heightRef
2197 currentHeight <- readIORef heightRef
1947 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?
2198 when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
@@ -1951,12 +2202,14 @@ mergeIntCheap d = Event $ \sub -> do
1951 LT -> return ()
2202 LT -> return ()
1952 EQ -> do
2203 EQ -> do
1953 let height = succHeight $ heightBagMax heights
2204 let height = succHeight $ heightBagMax heights
1954− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
1955 writeIORef heightRef $! height
2206 writeIORef heightRef $! height
1956 subscriberRecalculateHeight sub height
2207 subscriberRecalculateHeight sub height
1957 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
2208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
1958 mySubscriber k = Subscriber
2209 mySubscriber k = Subscriber
1959 { subscriberPropagate = \a -> do
2210 { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
1960 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
1961 liftIO $ FastMutableIntMap.insert accum k a
2214 liftIO $ FastMutableIntMap.insert accum k a
1962 when wasEmpty scheduleSelf
2215 when wasEmpty scheduleSelf
@@ -1990,7 +2243,6 @@ mergeIntCheap d = Event $ \sub -> do
1990 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
1991 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
1992 return Nothing
2245 return Nothing
1993− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1994 defer $ SomeMergeInit $ do
2246 defer $ SomeMergeInit $ do
1995 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
1996 where
2248 where
@@ -2004,35 +2256,39 @@ mergeIntCheap d = Event $ \sub -> do
2004 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2005 liftIO $ for_ oldParents $ \oldParent -> do
2257 liftIO $ for_ oldParents $ \oldParent -> do
2006 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
2007 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2008 return $ IntMap.elems oldParents
2262 return $ IntMap.elems oldParents
2009− let s = Subscriber
2263+ let changeSubscriber = Subscriber
2010 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2011 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2012 defer $ updateMe a
2266 defer $ updateMe a
2013 , subscriberInvalidateHeight = \_ -> return ()
2267 , subscriberInvalidateHeight = \_ -> return ()
2014 , subscriberRecalculateHeight = \_ -> return ()
2268 , subscriberRecalculateHeight = \_ -> return ()
2015 }
2269 }
2016− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2017 forM_ change $ \c -> defer $ updateMe c
2271 forM_ change $ \c -> defer $ updateMe c
2018 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2019 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2020 -- its subscription.
2274 -- its subscription.
2021− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2022 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2277+
2278+
2023− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
2024− , occ
2025− )
2026
2280
2027newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2281newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2282+newtype EventSelectorG x k v = EventSelectorG { selectG :: forall a. k a -> Event x (v a) }
2028
2283
2029−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2284+fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
2030−fan e =
2285+fanG e = unsafePerformIO $ do
2286+ ref <- newIORef Nothing
2031 let f = Fan
2287 let f = Fan
2032 { fanParent = e
2288 { fanParent = e
2033− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
2034 }
2290 }
2035− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
2036
2292
2037runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2038runHoldInits holdInitRef dynInitRef mergeInitRef = do
2294runHoldInits holdInitRef dynInitRef mergeInitRef = do
@@ -2086,36 +2342,36 @@ clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeI
2086-- | Run an event action outside of a frame
2342-- | Run an event action outside of a frame
2087runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2088runFrame a = SpiderHost $ do
2344runFrame a = SpiderHost $ do
2089− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
2090 let go = do
2346 let go = do
2091 result <- a
2347 result <- a
2092 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
2348 runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
2093 return result
2349 return result
2094 result <- runEventM go
2350 result <- runEventM go
2095 toClear <- readIORef $ eventEnvClears env
2351 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
2097 toClearInt <- readIORef $ eventEnvIntClears env
2353 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
2099 toClearRoot <- readIORef $ eventEnvRootClears env
2355 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
2101 toAssign <- readIORef $ eventEnvAssignments env
2357 toAssign <- readIORef $ eventEnvAssignments env
2102 toReconnectRef <- newIORef []
2358 toReconnectRef <- newIORef []
2103 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2104 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2105 writeIORef vRef v
2361 writeIORef vRef v
2106− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
2107 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2108 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2109 writeIORef (eventEnvMergeUpdates env) []
2365 writeIORef (eventEnvMergeUpdates env) []
2110− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
2111 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2112− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
2113 toReconnect <- readIORef toReconnectRef
2369 toReconnect <- readIORef toReconnectRef
2114 clearEventEnv env
2370 clearEventEnv env
2115 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2116 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2117 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2118− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2119 finalize wi
2375 finalize wi
2120 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2121 wi' <- mkWeakPtrWithDebug i "wi'"
2377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2129,7 +2385,7 @@ runFrame a = SpiderHost $ do
2129 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
2385 subscription <- unSpiderHost $ runFrame $ {-# SCC "subscribeSwitch" #-} subscribe e sub --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
2130 {-
2386 {-
2131 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2387 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
2133 EventRoot _ -> "EventRoot"
2389 EventRoot _ -> "EventRoot"
2134 EventNever -> "EventNever"
2390 EventNever -> "EventNever"
2135 _ -> "something else"
2391 _ -> "something else"
@@ -2144,7 +2400,7 @@ runFrame a = SpiderHost $ do
2144 myHeight <- readIORef $ switchSubscribedHeight subscribed
2400 myHeight <- readIORef $ switchSubscribedHeight subscribed
2145 when (parentHeight /= myHeight) $ do
2401 when (parentHeight /= myHeight) $ do
2146 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2147− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2148 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
2404 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
2149 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2150 unsubscribe subscription
2406 unsubscribe subscription
@@ -2185,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
2185 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2186 when (oldHeight /= invalidHeight) $ do
2442 when (oldHeight /= invalidHeight) $ do
2187 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2188− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2189
2445
2190updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2191updateSwitchHeight new subscribed = do
2447updateSwitchHeight new subscribed = do
@@ -2193,7 +2449,7 @@ updateSwitchHeight new subscribed = do
2193 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2194 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2195 writeIORef (switchSubscribedHeight subscribed) $! new
2451 writeIORef (switchSubscribedHeight subscribed) $! new
2196− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2197
2453
2198recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2199recalculateCoincidenceHeight subscribed = do
2455recalculateCoincidenceHeight subscribed = do
@@ -2202,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
2202 height <- calculateCoincidenceHeight subscribed
2458 height <- calculateCoincidenceHeight subscribed
2203 when (height /= invalidHeight) $ do
2459 when (height /= invalidHeight) $ do
2204 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2205− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2206
2462
2207calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2208calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
2464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -2264,6 +2520,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Event
2264 {-# INLINABLE headE #-}
2520 {-# INLINABLE headE #-}
2265 headE = R.slowHeadE
2521 headE = R.slowHeadE
2266-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2522-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
2267
2525
2268instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
2526instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
2269 {-# INLINABLE sample #-}
2527 {-# INLINABLE sample #-}
@@ -2285,6 +2543,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
2285 {-# INLINABLE headE #-}
2543 {-# INLINABLE headE #-}
2286 headE = R.slowHeadE
2544 headE = R.slowHeadE
2287-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2545-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
2288
2549
2289instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
2550instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
2290 {-# INLINE return #-}
2551 {-# INLINE return #-}
@@ -2293,11 +2554,13 @@ instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x))
2293 x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
2554 x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
2294 {-# INLINE (>>) #-}
2555 {-# INLINE (>>) #-}
2295 (>>) = (*>)
2556 (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
2296 {-# INLINE fail #-}
2558 {-# INLINE fail #-}
2297 fail _ = error "Dynamic does not support 'fail'"
2559 fail _ = error "Dynamic does not support 'fail'"
2560+#endif
2298
2561
2299{-# INLINABLE newJoinDyn #-}
2562{-# 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)
2301newJoinDyn d =
2564newJoinDyn d =
2302 let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2565 let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2303 eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
2566 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
2346 buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2609 buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2347 {-# INLINABLE headE #-}
2610 {-# INLINABLE headE #-}
2348 headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2611 headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
2349
2615
2350instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2616instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2351 sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2617 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
2362 {-# INLINABLE headE #-}
2628 {-# INLINABLE headE #-}
2363 headE = R.slowHeadE
2629 headE = R.slowHeadE
2364-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2630-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
2365
2633
2366instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2634instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2367 {-# INLINABLE sample #-}
2635 {-# INLINABLE sample #-}
@@ -2382,6 +2650,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Refle
2382 buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2650 buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2383 {-# INLINABLE headE #-}
2651 {-# INLINABLE headE #-}
2384 headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2652 headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
2385
2655
2386--------------------------------------------------------------------------------
2656--------------------------------------------------------------------------------
2387-- Deprecated items
2657-- Deprecated items
@@ -2419,13 +2689,13 @@ instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline
2419 touch h
2689 touch h
2420 return result
2690 return result
2421
2691
2422−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2423 newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2693 newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2424 newFanEventWithTrigger f = SpiderHost $ do
2694 newFanEventWithTrigger f = SpiderHost $ do
2425 es <- newFanEventWithTriggerIO f
2695 es <- newFanEventWithTriggerIO f
2426 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2696 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2427
2697
2428−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2429 newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2699 newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2430 newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2700 newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2431 es <- newFanEventWithTriggerIO f
2701 es <- newFanEventWithTriggerIO f
@@ -2447,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
2447#ifdef DEBUG
2717#ifdef DEBUG
2448 depthRef <- newIORef 0
2718 depthRef <- newIORef 0
2449#endif
2719#endif
2450− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
2451 { _spiderTimeline_lock = lock
2721 { _spiderTimeline_lock = lock
2452 , _spiderTimeline_eventEnv = env
2722 , _spiderTimeline_eventEnv = env
2453#ifdef DEBUG
2723#ifdef DEBUG
@@ -2457,19 +2727,19 @@ unsafeNewSpiderTimelineEnv = do
2457
2727
2458-- | Create a new SpiderTimelineEnv
2728-- | Create a new SpiderTimelineEnv
2459newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2460−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
2461
2731
2462−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
2463
2733
2464instance Reifies s (SpiderTimelineEnv x) =>
2734instance Reifies s (SpiderTimelineEnv x) =>
2465 HasSpiderTimeline (LocalSpiderTimeline x s) where
2735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2466− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
2467
2737
2468localSpiderTimeline
2738localSpiderTimeline
2469− :: Proxy s
2739+ :: proxy s
2470 -> SpiderTimelineEnv x
2740 -> SpiderTimelineEnv x
2471 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2472−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
2473
2743
2474-- | Pass a new timeline to the given function.
2744-- | Pass a new timeline to the given function.
2475withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
@@ -2477,18 +2747,18 @@ withSpiderTimeline k = do
2477 env <- unsafeNewSpiderTimelineEnv
2747 env <- unsafeNewSpiderTimelineEnv
2478 reify env $ \s -> k $ localSpiderTimeline s env
2748 reify env $ \s -> k $ localSpiderTimeline s env
2479
2749
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)
2481
2751
2482type ComputeM = EventM
2752type ComputeM = EventM
2483
2753
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)
2485
2755
2486instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2487 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2488 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2489 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2759 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)
2760+ newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2491− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
2761+ newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
2492 type PullM (SpiderTimeline x) = SpiderPullM x
2762 type PullM (SpiderTimeline x) = SpiderPullM x
2493 type PushM (SpiderTimeline x) = SpiderPushM x
2763 type PushM (SpiderTimeline x) = SpiderPushM x
2494 {-# INLINABLE never #-}
2764 {-# INLINABLE never #-}
@@ -2501,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2501 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2502 {-# INLINABLE pull #-}
2772 {-# INLINABLE pull #-}
2503 pull = SpiderBehavior . pull . coerce
2773 pull = SpiderBehavior . pull . coerce
2504− {-# INLINABLE merge #-}
2774+ {-# INLINABLE fanG #-}
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))
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
2508 {-# INLINABLE switch #-}
2783 {-# INLINABLE switch #-}
2509 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2510 {-# INLINABLE coincidence #-}
2785 {-# INLINABLE coincidence #-}
@@ -2512,15 +2787,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2512 {-# INLINABLE current #-}
2787 {-# INLINABLE current #-}
2513 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2514 {-# INLINABLE updated #-}
2789 {-# INLINABLE updated #-}
2515− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
2516 {-# INLINABLE unsafeBuildDynamic #-}
2791 {-# INLINABLE unsafeBuildDynamic #-}
2517 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2518 {-# INLINABLE unsafeBuildIncremental #-}
2793 {-# INLINABLE unsafeBuildIncremental #-}
2519 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2520− {-# INLINABLE mergeIncremental #-}
2795+ {-# INLINABLE mergeIncrementalG #-}
2521− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2796+ mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2522− {-# INLINABLE mergeIncrementalWithMove #-}
2797+ {-# INLINABLE mergeIncrementalWithMoveG #-}
2523− mergeIncrementalWithMove = SpiderEvent . mergeWithMove . (unsafeCoerce :: Dynamic x (PatchDMapWithMove k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMapWithMove k (Event x))) . unSpiderIncremental
2798+ mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
2524 {-# INLINABLE currentIncremental #-}
2799 {-# INLINABLE currentIncremental #-}
2525 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2526 {-# INLINABLE updatedIncremental #-}
2801 {-# INLINABLE updatedIncremental #-}
@@ -2531,9 +2806,10 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2531 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2532 eventCoercion Coercion = Coercion
2807 eventCoercion Coercion = Coercion
2533 behaviorCoercion Coercion = Coercion
2808 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
2535 {-# INLINABLE mergeIntIncremental #-}
2811 {-# 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
2537 {-# INLINABLE fanInt #-}
2813 {-# INLINABLE fanInt #-}
2538 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2539
2815
@@ -2558,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
2558 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2559
2835
2560-- | The monad for actions that manipulate a Spider timeline identified by @x@
2836-- | The monad for actions that manipulate a Spider timeline identified by @x@
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)
2562
2838
2563instance Monad (SpiderHost x) where
2839instance Monad (SpiderHost x) where
2564 {-# INLINABLE (>>=) #-}
2840 {-# INLINABLE (>>=) #-}
@@ -2567,8 +2843,14 @@ instance Monad (SpiderHost x) where
2567 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2568 {-# INLINABLE return #-}
2844 {-# INLINABLE return #-}
2569 return x = SpiderHost $ return x
2845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
2570 {-# INLINABLE fail #-}
2847 {-# INLINABLE fail #-}
2848+ fail = MonadFail.fail
2849+#endif
2850+
2851+instance MonadFail (SpiderHost x) where
2852+ {-# INLINABLE fail #-}
2571− fail s = SpiderHost $ fail s
2853+ fail s = SpiderHost $ MonadFail.fail s
2572
2854
2573-- | Run an action affecting the global Spider timeline; this will be guarded by
2855-- | Run an action affecting the global Spider timeline; this will be guarded by
2574-- a mutex for that timeline
2856-- a mutex for that timeline
@@ -2580,7 +2862,7 @@ runSpiderHost (SpiderHost a) = a
2580runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2581runSpiderHostForTimeline (SpiderHost a) _ = a
2863runSpiderHostForTimeline (SpiderHost a) _ = a
2582
2864
2583−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2865+newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2584 deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2866 deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2585
2867
2586instance Monad (SpiderHostFrame x) where
2868instance Monad (SpiderHostFrame x) where
@@ -2590,19 +2872,21 @@ instance Monad (SpiderHostFrame x) where
2590 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2591 {-# INLINABLE return #-}
2873 {-# INLINABLE return #-}
2592 return x = SpiderHostFrame $ return x
2874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
2593 {-# INLINABLE fail #-}
2876 {-# INLINABLE fail #-}
2594 fail s = SpiderHostFrame $ fail s
2877 fail s = SpiderHostFrame $ fail s
2878+#endif
2595
2879
2596instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2880instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2597 notReadyUntil _ = pure ()
2881 notReadyUntil _ = pure ()
2598 notReady = pure ()
2882 notReady = pure ()
2599
2883
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)
2601newEventWithTriggerIO f = do
2885newEventWithTriggerIO f = do
2602 es <- newFanEventWithTriggerIO $ \Refl -> f
2886 es <- newFanEventWithTriggerIO $ \Refl -> f
2603 return $ select es Refl
2887 return $ select es Refl
2604
2888
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)
2606newFanEventWithTriggerIO f = do
2890newFanEventWithTriggerIO f = do
2607 occRef <- newIORef DMap.empty
2891 occRef <- newIORef DMap.empty
2608 subscribedRef <- newIORef DMap.empty
2892 subscribedRef <- newIORef DMap.empty
@@ -2636,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
2636instance PrimMonad (SpiderHostFrame x) where
2920instance PrimMonad (SpiderHostFrame x) where
2637 type PrimState (SpiderHostFrame x) = PrimState IO
2921 type PrimState (SpiderHostFrame x) = PrimState IO
2638 primitive = SpiderHostFrame . EventM . primitive
2922 primitive = SpiderHostFrame . EventM . primitive
2923+
2924+instance NotReady (SpiderTimeline x) (SpiderHost x) where
2925+ notReadyUntil _ = return ()
2926+ notReady = return ()
2927+
2928+instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
2929+ notReadyUntil _ = return ()
2930+ notReady = return ()
src/Reflex/Time.hs+113−13
@@ -1,5 +1,7 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveGeneric #-}
4+{-# LANGUAGE DeriveTraversable #-}
3{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE RecursiveDo #-}
7{-# LANGUAGE RecursiveDo #-}
@@ -9,6 +11,11 @@
9#ifdef USE_TEMPLATE_HASKELL
11#ifdef USE_TEMPLATE_HASKELL
10{-# LANGUAGE TemplateHaskell #-}
12{-# LANGUAGE TemplateHaskell #-}
11#endif
13#endif
14+-- |
15+-- Module:
16+-- Reflex.Time
17+-- Description:
18+-- Clocks, timers, and other time-related functions.
12module Reflex.Time where
19module Reflex.Time where
13
20
14import Reflex.Class
21import Reflex.Class
@@ -24,46 +31,50 @@ import Control.Monad
24import Control.Monad.Fix
31import Control.Monad.Fix
25import Control.Monad.IO.Class
32import Control.Monad.IO.Class
26import Data.Align
33import Data.Align
34+import Data.Data (Data)
27import Data.Fixed
35import Data.Fixed
36+import Data.Semigroup (Semigroup(..))
28import Data.Sequence (Seq, (|>))
37import Data.Sequence (Seq, (|>))
29import qualified Data.Sequence as Seq
38import qualified Data.Sequence as Seq
30import Data.These
39import Data.These
31import Data.Time.Clock
40import Data.Time.Clock
32import Data.Typeable
41import Data.Typeable
42+import GHC.Generics (Generic)
33import System.Random
43import System.Random
34
44
45+-- | Metadata associated with a timer "tick"
35data TickInfo
46data TickInfo
36 = TickInfo { _tickInfo_lastUTC :: UTCTime
47 = TickInfo { _tickInfo_lastUTC :: UTCTime
37 -- ^ UTC time immediately after the last tick.
48 -- ^ UTC time immediately after the last tick.
38 , _tickInfo_n :: Integer
49 , _tickInfo_n :: Integer
39− -- ^ Number of time periods since t0
50+ -- ^ Number of time periods or ticks since the start of the timer
40 , _tickInfo_alreadyElapsed :: NominalDiffTime
51 , _tickInfo_alreadyElapsed :: NominalDiffTime
41− -- ^ Amount of time already elapsed in the current tick period.
52+ -- ^ Amount of time that has elapsed in the current tick period.
42 }
53 }
43 deriving (Eq, Ord, Show, Typeable)
54 deriving (Eq, Ord, Show, Typeable)
44
55
56+-- | Fires an 'Event' once every time provided interval elapses, approximately.
57+-- The provided 'UTCTime' is used bootstrap the determination of how much time has elapsed with each tick.
45−-- | Special case of 'tickLossyFrom' that uses the post-build event to start the
58+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread.
46−-- tick thread.
47tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
59tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
48tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
60tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
49
61
50−-- | Special case of 'tickLossyFrom' that uses the post-build event to start the
62+-- | Fires an 'Event' once every time provided interval elapses, approximately.
51−-- tick thread and the time of the post-build as the tick basis time.
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.
52tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
64tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
53tickLossyFromPostBuildTime dt = do
65tickLossyFromPostBuildTime dt = do
54 postBuild <- getPostBuild
66 postBuild <- getPostBuild
55 postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
67 postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
56 tickLossyFrom' $ (dt,) <$> postBuildTime
68 tickLossyFrom' $ (dt,) <$> postBuildTime
57
69
58−-- | Send events over time with the given basis time and interval
59−-- If the system starts running behind, occurrences will be dropped rather than buffered
70+-- | Fires an 'Event' approximately each time the provided interval elapses. If the system starts running behind, occurrences will be dropped rather than buffered.
60−-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the basis time
71+-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the provided initial time.
61tickLossyFrom
72tickLossyFrom
62 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
73 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
63 => NominalDiffTime
74 => NominalDiffTime
64 -- ^ The length of a tick interval
75 -- ^ The length of a tick interval
65 -> UTCTime
76 -> UTCTime
66− -- ^ The basis time from which intervals count
77+ -- ^ The basis time from which intervals count and with which the initial calculation of elapsed time will be made.
67 -> Event t a
78 -> Event t a
68 -- ^ Event that starts a tick generation thread. Usually you want this to
79 -- ^ Event that starts a tick generation thread. Usually you want this to
69 -- be something like the result of getPostBuild that only fires once. But
80 -- be something like the result of getPostBuild that only fires once. But
@@ -71,12 +82,12 @@ tickLossyFrom
71 -> m (Event t TickInfo)
82 -> m (Event t TickInfo)
72tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
83tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
73
84
74−-- | Generalization of tickLossyFrom that takes dt and t0 in the event.
85+-- | Generalization of tickLossyFrom that takes the delay and initial time as an 'Event'.
75tickLossyFrom'
86tickLossyFrom'
76 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
87 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
77 => Event t (NominalDiffTime, UTCTime)
88 => Event t (NominalDiffTime, UTCTime)
78 -- ^ Event that starts a tick generation thread. Usually you want this to
89 -- ^ Event that starts a tick generation thread. Usually you want this to
79− -- be something like the result of getPostBuild that only fires once. But
90+ -- be something like the result of 'getPostBuild' that only fires once. But
80 -- there could be uses for starting multiple timer threads.
91 -- there could be uses for starting multiple timer threads.
81 -> m (Event t TickInfo)
92 -> m (Event t TickInfo)
82tickLossyFrom' e = do
93tickLossyFrom' e = do
@@ -87,12 +98,16 @@ tickLossyFrom' e = do
87 Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
98 Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
88 cb (tick, pair)
99 cb (tick, pair)
89
100
101+-- | Like 'tickLossy', but immediately calculates the first tick and provides a 'Dynamic' that is updated as ticks fire.
90clockLossy :: (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)
102clockLossy :: (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)
91clockLossy dt t0 = do
103clockLossy dt t0 = do
92 initial <- liftIO $ getCurrentTick dt t0
104 initial <- liftIO $ getCurrentTick dt t0
93 e <- tickLossy dt t0
105 e <- tickLossy dt t0
94 holdDyn initial e
106 holdDyn initial e
95
107
108+-- | Generates a 'TickInfo', given the specified interval and timestamp. The 'TickInfo' will include the
109+-- current time, the number of ticks that have elapsed since the timestamp, and the amount of time that
110+-- has elapsed since the start time of this tick.
96getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
111getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
97getCurrentTick dt t0 = do
112getCurrentTick dt t0 = do
98 t <- getCurrentTime
113 t <- getCurrentTime
@@ -266,6 +281,92 @@ throttle t e = do
266 delayed <- delay t outE
281 delayed <- delay t outE
267 return outE
282 return outE
268
283
284+data ThrottleState b
285+ = ThrottleState_Immediate
286+ | ThrottleState_Buffered (ThrottleBuffer b)
287+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
288+
289+data ThrottleBuffer b
290+ = ThrottleBuffer_Empty -- Empty conflicts with lens, and hiding it would require turning
291+ -- on PatternSynonyms
292+ | ThrottleBuffer_Full b
293+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
294+
295+instance Semigroup b => Semigroup (ThrottleBuffer b) where
296+ x <> y = case x of
297+ ThrottleBuffer_Empty -> y
298+ ThrottleBuffer_Full b1 -> case y of
299+ ThrottleBuffer_Empty -> x
300+ ThrottleBuffer_Full b2 -> ThrottleBuffer_Full $ b1 <> b2
301+ {-# INLINE (<>) #-}
302+
303+instance Semigroup b => Monoid (ThrottleBuffer b) where
304+ mempty = ThrottleBuffer_Empty
305+ {-# INLINE mempty #-}
306+ mappend = (<>)
307+ {-# INLINE mappend #-}
308+
309+-- | Throttle an input event, ensuring that the output event doesn't occur more often than you are ready for it. If the input event occurs too
310+-- frequently, the output event will contain semigroup-based summaries of the input firings that happened since the last output firing.
311+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
312+-- The first parameter is a function that receives access to the output event, and should construct an event that fires when the receiver is
313+-- ready for more input. For example, using @delay 20@ would give a simple time-based throttle.
314+--
315+-- NB: The provided lag function must *actually* delay the event.
316+throttleBatchWithLag :: (MonadFix m, MonadHold t m, PerformEvent t m, Semigroup a) => (Event t () -> m (Event t ())) -> Event t a -> m (Event t a)
317+-- Invariants:
318+-- * Immediate mode must turn off whenever output is produced.
319+-- * Output must be produced whenever immediate mode turns from on to off.
320+-- * Immediate mode can only go from off to on when the delayed event fires.
321+-- * Every input firing must go into either an immediate output firing or the
322+-- buffer, but not both.
323+-- * An existing full buffer must either stay in the buffer or go to output,
324+-- but not both.
325+throttleBatchWithLag lag e = do
326+ let f state x = case x of -- (Just $ newState, out)
327+ This a -> -- If only the input event fires
328+ case state of
329+ ThrottleState_Immediate -> -- and we're in immediate mode
330+ -- Immediate mode turns off, and the buffer is empty.
331+ -- We fire the output event with the input event value immediately.
332+ (Just $ ThrottleState_Buffered $ ThrottleBuffer_Empty, Just a)
333+ ThrottleState_Buffered b -> -- and we're not in immediate mode
334+ -- Immediate mode remains off, and we accumulate the input value.
335+ -- We don't fire the output event.
336+ (Just $ ThrottleState_Buffered $ b <> ThrottleBuffer_Full a, Nothing)
337+ That _ -> -- If only the delayed output event fires,
338+ case state of
339+ ThrottleState_Immediate -> -- and we're in immediate mode
340+ -- Nothing happens.
341+ (Nothing, Nothing)
342+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
343+ -- Immediate mode turns back on, and the buffer remains empty.
344+ -- We don't fire.
345+ (Just ThrottleState_Immediate, Nothing)
346+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
347+ -- Immediate mode remains off, and the buffer is cleared.
348+ -- We fire with the buffered value.
349+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just b)
350+ These a _ -> -- If both the input and delayed output event fire simultaneously:
351+ case state of
352+ ThrottleState_Immediate -> -- and we're in immediate mode
353+ -- Immediate mode turns off, and the buffer is empty.
354+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
355+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
356+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
357+ -- Immediate mode stays off, and the buffer remains empty.
358+ -- We fire with the input event's value.
359+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
360+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
361+ -- Immediate mode remains off, and the buffer is cleared.
362+ -- We fire with everything including the buffered value.
363+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just (b <> a))
364+ rec (_stateDyn, outE) <- mapAccumMaybeDyn f
365+ ThrottleState_Immediate -- We start in immediate mode with an empty buffer.
366+ (align e delayed)
367+ delayed <- lag (void outE)
368+ return outE
369+
269#ifdef USE_TEMPLATE_HASKELL
370#ifdef USE_TEMPLATE_HASKELL
270makeLensesWith (lensRules & simpleLenses .~ True) ''TickInfo
371makeLensesWith (lensRules & simpleLenses .~ True) ''TickInfo
271#else
372#else
@@ -281,4 +382,3 @@ tickInfo_alreadyElapsed :: Lens' TickInfo NominalDiffTime
281tickInfo_alreadyElapsed f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 x2 y) <$> f x3
382tickInfo_alreadyElapsed f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 x2 y) <$> f x3
282{-# INLINE tickInfo_alreadyElapsed #-}
383{-# INLINE tickInfo_alreadyElapsed #-}
283#endif
384#endif
284−
src/Reflex/TriggerEvent/Base.hs+2
@@ -122,6 +122,8 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
122 buildDynamic a0 = lift . buildDynamic a0
122 buildDynamic a0 = lift . buildDynamic a0
123 {-# INLINABLE headE #-}
123 {-# INLINABLE headE #-}
124 headE = lift . headE
124 headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
125
127
126instance Adjustable t m => Adjustable t (TriggerEventT t m) where
128instance Adjustable t m => Adjustable t (TriggerEventT t m) where
127 {-# INLINABLE runWithReplace #-}
129 {-# INLINABLE runWithReplace #-}
src/Reflex/TriggerEvent/Class.hs+6−1
@@ -2,7 +2,6 @@
2-- new 'Event's that can be triggered from 'IO'.
2-- new 'Event's that can be triggered from 'IO'.
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE UndecidableInstances #-}
5{-# LANGUAGE UndecidableInstances #-}
7module Reflex.TriggerEvent.Class
6module Reflex.TriggerEvent.Class
8 ( TriggerEvent (..)
7 ( TriggerEvent (..)
@@ -13,6 +12,7 @@ import Reflex.Class
13import Control.Monad.Reader
12import Control.Monad.Reader
14import Control.Monad.State
13import Control.Monad.State
15import qualified Control.Monad.State.Strict as Strict
14import qualified Control.Monad.State.Strict as Strict
15+import Control.Monad.Trans.Maybe (MaybeT)
16
16
17--TODO: Shouldn't have IO hard-coded
17--TODO: Shouldn't have IO hard-coded
18-- | 'TriggerEvent' represents actions that can create 'Event's that can be
18-- | '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
48 newTriggerEvent = lift newTriggerEvent
48 newTriggerEvent = lift newTriggerEvent
49 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
49 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
50 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
50 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
51+
52+instance TriggerEvent t m => TriggerEvent t (MaybeT m) where
53+ newTriggerEvent = lift newTriggerEvent
54+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
55+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
src/Reflex/Widget/Basic.hs+1−1
@@ -13,7 +13,7 @@ import Data.Map (Map)
13
13
14import Reflex.Class
14import Reflex.Class
15import Reflex.Adjustable.Class
15import Reflex.Adjustable.Class
16−import Reflex.Patch.MapWithMove
16+import Data.Patch.MapWithMove
17
17
18
18
19-- | Build sortable content in such a way that re-sorting it can cause minimal
19-- | Build sortable content in such a way that re-sorting it can cause minimal
src/Reflex/Workflow.hs+13−1
@@ -1,7 +1,13 @@
1{-# LANGUAGE RecursiveDo #-}
1{-# LANGUAGE RecursiveDo #-}
2{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
3+-- |
4+-- Module:
5+-- Reflex.Workflow
6+-- Description:
7+-- Provides a convenient way to describe a series of interrelated widgets that
8+-- can send data to, invoke, and replace one another. Useful for modeling user interface
9+-- "workflows."
3module Reflex.Workflow (
10module Reflex.Workflow (
4− -- * Workflows
5 Workflow (..)
11 Workflow (..)
6 , workflow
12 , workflow
7 , workflowView
13 , workflowView
@@ -18,21 +24,27 @@ import Reflex.Network
18import Reflex.NotReady.Class
24import Reflex.NotReady.Class
19import Reflex.PostBuild.Class
25import Reflex.PostBuild.Class
20
26
27+-- | A widget in a workflow
28+-- When the 'Event' returned by a 'Workflow' fires, the current 'Workflow' is replaced by the one inside the firing 'Event'. A series of 'Workflow's must share the same return type.
21newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
29newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
22
30
31+-- | Runs a 'Workflow' and returns the 'Dynamic' result of the 'Workflow' (i.e., a 'Dynamic' of the value produced by the current 'Workflow' node, and whose update 'Event' fires whenever one 'Workflow' is replaced by another).
23workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
32workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
24workflow w0 = do
33workflow w0 = do
25 rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
34 rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
26 return $ fmap fst eResult
35 return $ fmap fst eResult
27
36
37+-- | Similar to 'workflow', but outputs an 'Event' that fires at post-build time and whenever the current 'Workflow' is replaced by the next 'Workflow'.
28workflowView :: 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)
38workflowView :: 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)
29workflowView w0 = do
39workflowView w0 = do
30 rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
40 rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
31 eReplace <- fmap switch $ hold never $ fmap snd eResult
41 eReplace <- fmap switch $ hold never $ fmap snd eResult
32 return $ fmap fst eResult
42 return $ fmap fst eResult
33
43
44+-- | Map a function over a 'Workflow', possibly changing the return type.
34mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
45mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
35mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
46mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
36
47
48+-- | Map a "cheap" function over a 'Workflow'. Refer to the documentation for 'pushCheap' for more information and performance considerations.
37mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
49mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
38mapWorkflowCheap f (Workflow x) = Workflow (fmap (f *** fmapCheap (mapWorkflowCheap f)) x)
50mapWorkflowCheap 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 #-}
1{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE GADTs #-}
4{-# LANGUAGE GADTs #-}
3{-# LANGUAGE RecursiveDo #-}
5{-# LANGUAGE RecursiveDo #-}
@@ -12,6 +14,10 @@ import Data.Functor.Misc
12import qualified Data.Map as M
14import qualified Data.Map as M
13import Data.These
15import Data.These
14
16
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+
15import Reflex
21import Reflex
16import Reflex.EventWriter.Base
22import Reflex.EventWriter.Base
17import Test.Run
23import Test.Run
@@ -36,6 +42,9 @@ main = do
36 print os4
42 print os4
37 os5@[[Nothing, Just [1, 2]]] <- runApp' (unwrapApp testLiveTellEventDMap) [Just ()]
43 os5@[[Nothing, Just [1, 2]]] <- runApp' (unwrapApp testLiveTellEventDMap) [Just ()]
38 print os5
44 print os5
45+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
46+ print os6
47+ let ![[Nothing, Nothing]] = os6
39 return ()
48 return ()
40
49
41unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
50unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
@@ -44,16 +53,13 @@ unwrapApp x appIn = do
44 return e
53 return e
45
54
46testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
55testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
47−testOrdering pulse = do
48− forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
56+testOrdering pulse = forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
49− return ()
50
57
51testSimultaneous :: (Reflex t, Adjustable t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
58testSimultaneous :: (Reflex t, Adjustable t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
52testSimultaneous pulse = do
59testSimultaneous pulse = do
53 let e0 = fmapMaybe (^? here) pulse
60 let e0 = fmapMaybe (^? here) pulse
54 e1 = fmapMaybe (^? there) pulse
61 e1 = fmapMaybe (^? there) pulse
55 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
62 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
56− return ()
57
63
58-- | Test that a widget telling and event which fires at the same time it has been replaced
64-- | Test that a widget telling and event which fires at the same time it has been replaced
59-- doesn't count along with the new widget.
65-- doesn't count along with the new widget.
@@ -112,3 +118,17 @@ testLiveTellEventDMap pulse = do
112 (mapToDMap $ M.singleton 1 ())
118 (mapToDMap $ M.singleton 1 ())
113 ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
119 ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
114 return ()
120 return ()
121+
122+delayedPulse
123+ :: forall t m
124+ . ( Reflex t
125+ , Adjustable t m
126+ , MonadHold t m
127+ , MonadFix m
128+ )
129+ => Event t ()
130+ -> EventWriterT t [Int] m ()
131+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
132+ -- This has the effect of delaying pulse' from pulse
133+ (_, pulse') <- runWithReplace (pure ()) $ pure [1] <$ pulse
134+ tellEvent pulse'
test/GC.hs+6−5
@@ -18,15 +18,17 @@ import Data.GADT.Compare
18import Data.IORef
18import Data.IORef
19import Data.Semigroup
19import Data.Semigroup
20import Data.These
20import Data.These
21+import Data.Type.Equality ((:~:)(Refl))
21
22
22import Data.Functor.Misc
23import Data.Functor.Misc
23−import Reflex.Patch
24+import Data.Patch
24
25
25import qualified Reflex.Host.Class as Host
26import qualified Reflex.Host.Class as Host
26import qualified Reflex.Spider.Internal as S
27import qualified Reflex.Spider.Internal as S
27
28
28import System.Exit
29import System.Exit
29import System.Mem
30import System.Mem
31+import Data.Coerce
30
32
31main :: IO ()
33main :: IO ()
32main = do
34main = do
@@ -46,7 +48,7 @@ hostPerf ref = S.runSpiderHost $ do
46 eventToPerform <- Host.runHostFrame $ do
48 eventToPerform <- Host.runHostFrame $ do
47 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
49 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
48 <- S.SpiderHostFrame
50 <- S.SpiderHostFrame
49− $ fmap ( S.merge
51+ $ fmap ( S.mergeG coerce
50 . S.dynamicHold)
52 . S.dynamicHold)
51 $ S.hold DMap.empty
53 $ S.hold DMap.empty
52 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
54 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
@@ -55,8 +57,8 @@ hostPerf ref = S.runSpiderHost $ do
55 { S.subscriberPropagate = S.subscriberPropagate sub
57 { S.subscriberPropagate = S.subscriberPropagate sub
56 }
58 }
57 return (s, o))
59 return (s, o))
58− $ runIdentity <$> S.select
60+ $ runIdentity . runIdentity <$> S.selectG
59− (S.fan $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
61+ (S.fanG $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
60 (WrapArg Request)
62 (WrapArg Request)
61 return $ alignWith (mergeThese (<>))
63 return $ alignWith (mergeThese (<>))
62 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
64 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
@@ -82,7 +84,6 @@ hostPerf ref = S.runSpiderHost $ do
82 Nothing -> []
84 Nothing -> []
83 Host.fireEventsAndRead followupEventTriggers $ return ()
85 Host.fireEventsAndRead followupEventTriggers $ return ()
84 return ()
86 return ()
85− return ()
86
87
87data Tell a where
88data Tell a where
88 Action :: Tell ()
89 Action :: Tell ()
test/Headless.hsnew file+10
@@ -0,0 +1,10 @@
1+module Main where
2+
3+import Reflex
4+import Reflex.Host.Headless (runHeadlessApp)
5+
6+main :: IO ()
7+main = do
8+ runHeadlessApp $ do
9+ pb <- getPostBuild
10+ performEvent (pure <$> pb)
test/QueryT.hs+5−1
@@ -19,8 +19,12 @@ import Data.Map.Monoidal (MonoidalMap)
19import Data.Semigroup
19import Data.Semigroup
20import Data.These
20import Data.These
21
21
22+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
23+import Data.These.Lens
24+#endif
25+
22import Reflex
26import Reflex
23−import Reflex.Patch.MapWithMove
27+import Data.Patch.MapWithMove
24import Test.Run
28import Test.Run
25
29
26newtype MyQuery = MyQuery SelectedCount
30newtype MyQuery = MyQuery SelectedCount
test/Reflex/Bench/Focused.hs+12
@@ -130,6 +130,16 @@ mapDynChain = iterM (return . fmap (+1))
130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
132
132
133+holdDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134+holdDynChain = iterM (\d -> sample (current d) >>= flip holdDyn (updated d))
135+
136+buildDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
137+buildDynChain = iterM (\d -> do
138+ let b = fmap (+1) (current d)
139+ e = fmap (*2) (updated d)
140+ buildDynamic (sample b) e)
141+
142+
133combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
143combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
144combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
135
145
@@ -308,6 +318,8 @@ dynamics :: Word -> [(String, TestCase)]
308dynamics n =
318dynamics n =
309 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
319 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
310 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
320 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
321+ , testE "holdDynChain" $ fmap updated $ holdDynChain n =<< d
322+ , testE "buildDynChain" $ fmap updated $ buildDynChain n =<< d
311 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
323 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
312 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
324 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
313 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
325 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
test/Reflex/Plan/Pure.hs+5−4
@@ -41,6 +41,7 @@ instance MonadHold (Pure Int) PurePlan where
41 holdIncremental initial = liftPlan . holdIncremental initial
41 holdIncremental initial = liftPlan . holdIncremental initial
42 buildDynamic getInitial = liftPlan . buildDynamic getInitial
42 buildDynamic getInitial = liftPlan . buildDynamic getInitial
43 headE = liftPlan . headE
43 headE = liftPlan . headE
44+ now = liftPlan now
44
45
45instance MonadSample (Pure Int) PurePlan where
46instance MonadSample (Pure Int) PurePlan where
46 sample = liftPlan . sample
47 sample = liftPlan . sample
@@ -55,15 +56,15 @@ instance TestPlan (Pure Int) PurePlan where
55runPure :: PurePlan a -> (a, IntSet)
56runPure :: PurePlan a -> (a, IntSet)
56runPure (PurePlan p) = runStateT p mempty $ 0
57runPure (PurePlan p) = runStateT p mempty $ 0
57
58
58−relavantTimes :: IntSet -> IntSet
59+relevantTimes :: IntSet -> IntSet
59−relavantTimes occs = IntSet.fromList [0..l + 1]
60+relevantTimes occs = IntSet.fromList [0..l + 1]
60 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
61 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
61
62
62testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63−testBehavior (b, occs) = IntMap.fromSet (sample b) (relavantTimes occs)
64+testBehavior (b, occs) = IntMap.fromSet (sample b) (relevantTimes occs)
64
65
65testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66−testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relavantTimes occs)
67+testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relevantTimes occs)
67
68
68
69
69
70
test/Reflex/Test/CrossImpl.hs+18−8
@@ -21,11 +21,12 @@ import Reflex.Dynamic
21import Reflex.Host.Class
21import Reflex.Host.Class
22import qualified Reflex.Pure as P
22import qualified Reflex.Pure as P
23import qualified Reflex.Spider.Internal as S
23import qualified Reflex.Spider.Internal as S
24+import qualified Reflex.Profiled as Prof
24
25
25import Control.Arrow (second, (&&&))
26import Control.Arrow (second, (&&&))
26import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
27import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
27import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28−import Data.Dependent.Map (DSum (..))
29+import Data.Dependent.Sum (DSum (..))
29import Data.Foldable
30import Data.Foldable
30import Data.Map.Strict (Map)
31import Data.Map.Strict (Map)
31import qualified Data.Map.Strict as Map
32import qualified Data.Map.Strict as Map
@@ -35,8 +36,6 @@ import Data.Traversable
35import System.Exit
36import System.Exit
36import System.Mem
37import System.Mem
37
38
38−import System.IO.Unsafe
39−
40mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
39mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
41mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
40mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
42 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
41 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
@@ -73,11 +72,14 @@ instance MapMSignals (Event t a) (Event t' a) t t' where
73instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
72instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
74 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
73 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
75
74
75+testTimeline
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)
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))
77−testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
79+testTimeline builder (bMap, eMap) = do
78 (re, reTrigger) <- newEventWithTriggerRef
80 (re, reTrigger) <- newEventWithTriggerRef
79 (rb, rbTrigger) <- newEventWithTriggerRef
81 (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
81 (b', e') <- runHostFrame $ builder (b, re)
83 (b', e') <- runHostFrame $ builder (b, re)
82 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
84 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
83 let times = relevantTestingTimes (bMap, eMap)
85 let times = relevantTestingTimes (bMap, eMap)
@@ -102,9 +104,11 @@ testAgreement :: (Eq c, Eq d, Show c, Show d) => (forall m t. TestCaseConstraint
102testAgreement builder inputs = do
104testAgreement builder inputs = do
103 let identityResult = testPure builder inputs
105 let identityResult = testPure builder inputs
104 tracePerf "---------" $ return ()
106 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
106 tracePerf "---------" $ return ()
110 tracePerf "---------" $ return ()
107− let resultsAgree = identityResult == spiderResult
111+ let resultsAgree = identityResult == spiderResult && identityResult == profiledResult
108 if resultsAgree
112 if resultsAgree
109 then do --putStrLn "Success:"
113 then do --putStrLn "Success:"
110 --print identityResult
114 --print identityResult
@@ -112,6 +116,7 @@ testAgreement builder inputs = do
112 else do putStrLn "Failure:"
116 else do putStrLn "Failure:"
113 putStrLn $ "Pure result: " <> show identityResult
117 putStrLn $ "Pure result: " <> show identityResult
114 putStrLn $ "Spider result: " <> show spiderResult
118 putStrLn $ "Spider result: " <> show spiderResult
119+ putStrLn $ "Profiled result: " <> show profiledResult
115 return resultsAgree
120 return resultsAgree
116
121
117type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
122type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
@@ -218,6 +223,11 @@ testCases =
218 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
223 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
219 let b' = pull $ sample =<< sample bb
224 let b' = pull $ sample =<< sample bb
220 return (b', e)
225 return (b', e)
226+ , (,) "foldDynWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(_, e) -> do
227+ d <- foldDyn (:) [] $
228+ pushAlways (\a -> foldDyn (:) [a] e) e
229+ let b = current (join (fmap distributeListOverDynPure d))
230+ return (b, e)
221 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
231 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
222 bb <- hold "b" e
232 bb <- hold "b" e
223 bd <- hold never . fmap (const e) =<< headE e
233 bd <- hold never . fmap (const e) =<< headE e
test/Reflex/Test/Micro.hs+8−2
@@ -322,8 +322,14 @@ testCases =
322 let e = never <$ switch b
322 let e = never <$ switch b
323 return $ void e
323 return $ void e
324 lazyHold
324 lazyHold
325−
325+ , testE "now-1" $ do
326−
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
327 ] where
333 ] where
328
334
329 events1, events2, events3 :: TestPlan t m => m (Event t String)
335 events1, events2, events3 :: TestPlan t m => m (Event t String)
test/Reflex/TestPlan.hs+2−2
@@ -26,8 +26,8 @@ import Reflex.Class
26import Prelude
26import Prelude
27
27
28class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
28class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
29− -- | Speicify a plan of an input Event firing
29+ -- | Specify a plan of an input Event firing
30− -- Occurances must be in the future (i.e. Time > 0)
30+ -- Occurrences must be in the future (i.e. Time > 0)
31 -- Initial specification is
31 -- Initial specification is
32
32
33 plan :: [(Word, a)] -> m (Event t a)
33 plan :: [(Word, a)] -> m (Event t a)
test/RequesterT.hs+179−11
@@ -1,14 +1,40 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
2{-# LANGUAGE GADTs #-}
5{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE LambdaCase #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE RecursiveDo #-}
4{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeApplications #-}
12+{-# LANGUAGE TypeFamilies #-}
5module Main where
13module Main where
6
14
7−import Control.Lens
15+import Control.Lens hiding (has)
8import Control.Monad
16import 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
9import qualified Data.Dependent.Map as DMap
22import qualified Data.Dependent.Map as DMap
10import Data.Dependent.Sum
23import 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)
11import Data.These
32import Data.These
33+import Text.Read (readMaybe)
34+
35+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
36+import Data.These.Lens
37+#endif
12
38
13import Reflex
39import Reflex
14import Reflex.Requester.Base
40import Reflex.Requester.Base
@@ -20,18 +46,38 @@ data RequestInt a where
20
46
21main :: IO ()
47main :: IO ()
22main = do
48main = do
23− os1@[[Just [10,9,8,7,6,5,4,3,2,1]]] <- runApp' (unwrapApp testOrdering) $
49+ os1 <- runApp' (unwrapApp testOrdering) $
24 [ Just ()
50 [ Just ()
25 ]
51 ]
26 print os1
52 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 $
53+ os2 <- runApp' (unwrapApp testSimultaneous) $ map Just $
29− [ This ()
54+ [ This ()
30− , That ()
55+ , That ()
31− , This ()
56+ , This ()
32− , These () ()
57+ , These () ()
33− ]
58+ ]
34 print os2
59 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+
35 return ()
81 return ()
36
82
37unwrapRequest :: DSum tag RequestInt -> Int
83unwrapRequest :: DSum tag RequestInt -> Int
@@ -43,7 +89,7 @@ unwrapApp :: ( Reflex t, Monad m )
43 -> m (Event t [Int])
89 -> m (Event t [Int])
44unwrapApp x appIn = do
90unwrapApp x appIn = do
45 ((), e) <- runRequesterT (x appIn) never
91 ((), e) <- runRequesterT (x appIn) never
46− return $ fmap (map unwrapRequest . DMap.toList) e
92+ return $ fmap (map unwrapRequest . requesterDataToList) e
47
93
48testOrdering :: ( Response m ~ Identity
94testOrdering :: ( Response m ~ Identity
49 , Request m ~ RequestInt
95 , Request m ~ RequestInt
@@ -65,3 +111,125 @@ testSimultaneous pulse = do
65 switchE = fmapMaybe (^? there) pulse
111 switchE = fmapMaybe (^? there) pulse
66 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
112 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
67 requestingIdentity (RequestInt (i+1) <$ tellE)
113 requestingIdentity (RequestInt (i+1) <$ tellE)
114+
115+-- | Test that a widget requesting and event which fires at the same time it has been replaced
116+-- doesn't count along with the new widget.
117+testMoribundRequest
118+ :: forall t m
119+ . ( Reflex t
120+ , Adjustable t m
121+ , MonadHold t m
122+ , MonadFix m
123+ , Response m ~ Identity
124+ , Request m ~ RequestInt
125+ , Requester t m
126+ )
127+ => Event t ()
128+ -> m ()
129+testMoribundRequest pulse = do
130+ rec let requestIntOnReplace x = requestingIdentity $ RequestInt x <$ rwrFinished
131+ (_, rwrFinished) <- runWithReplace (requestIntOnReplace 1) $ requestIntOnReplace 2 <$ pulse
132+ return ()
133+
134+-- | The equivalent of 'testMoribundRequest' for 'traverseDMapWithKeyWithAdjust'.
135+testMoribundRequestDMap
136+ :: forall t m
137+ . ( Reflex t
138+ , Adjustable t m
139+ , MonadHold t m
140+ , MonadFix m
141+ , Response m ~ Identity
142+ , Request m ~ RequestInt
143+ , Requester t m
144+ )
145+ => Event t ()
146+ -> m ()
147+testMoribundRequestDMap pulse = do
148+ rec let requestIntOnReplace :: Int -> m ()
149+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
150+ (_, rwrFinished :: Event t (PatchDMap (Const2 () Int) Identity)) <-
151+ traverseDMapWithKeyWithAdjust
152+ (\(Const2 ()) (Identity v) -> Identity . const v <$> requestIntOnReplace v)
153+ (mapToDMap $ M.singleton () 1)
154+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton () 2) <$ pulse)
155+ return ()
156+
157+-- | Ensures that elements which are _not_ removed can still fire requests
158+-- during the same frame as other elements are updated.
159+testLiveRequestDMap
160+ :: forall t m
161+ . ( Reflex t
162+ , Adjustable t m
163+ , MonadHold t m
164+ , MonadFix m
165+ , Response m ~ Identity
166+ , Request m ~ RequestInt
167+ , Requester t m
168+ )
169+ => Event t ()
170+ -> m ()
171+testLiveRequestDMap pulse = do
172+ rec let requestIntOnReplace :: Int -> m ()
173+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
174+ (_, rwrFinished :: Event t (PatchDMap (Const2 Int ()) Identity)) <-
175+ traverseDMapWithKeyWithAdjust
176+ (\(Const2 k) (Identity ()) -> Identity <$> requestIntOnReplace k)
177+ (mapToDMap $ M.singleton 1 ())
178+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
179+ return ()
180+
181+delayedPulse
182+ :: forall t m
183+ . ( Reflex t
184+ , Adjustable t m
185+ , MonadHold t m
186+ , MonadFix m
187+ , Response m ~ Identity
188+ , Request m ~ RequestInt
189+ , PerformEvent t m
190+ , Requester t m
191+ )
192+ => Event t ()
193+ -> m ()
194+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
195+ -- This has the effect of delaying pulse' from pulse
196+ (_, pulse') <- runWithReplace (pure ()) $ pure (RequestInt 1) <$ pulse
197+ requestingIdentity pulse'
198+
199+data TestRequest a where
200+ TestRequest_Reverse :: String -> TestRequest String
201+ TestRequest_Increment :: Int -> TestRequest Int
202+
203+testMatchRequestsWithResponses
204+ :: forall m t req a
205+ . ( MonadFix m
206+ , MonadHold t m
207+ , Reflex t
208+ , PerformEvent t m
209+ , MonadIO (Performable m)
210+ , ForallF Show req
211+ , Has Read req
212+ )
213+ => Event t (req a) -> m (Event t (Map Int String))
214+testMatchRequestsWithResponses pulse = mdo
215+ (_, requests) <- runRequesterT (requesting pulse) responses
216+ let rawResponses = M.map (\v ->
217+ case words v of
218+ ["reverse", str] -> reverse str
219+ ["increment", i] -> show $ succ $ (read i :: Int)
220+ ) <$> rawRequestMap
221+ (rawRequestMap, responses) <- matchResponsesWithRequests reqEncoder requests (head . M.toList <$> rawResponses)
222+ pure rawResponses
223+ where
224+ reqEncoder :: forall a. req a -> (String, String -> Maybe a)
225+ reqEncoder r =
226+ ( whichever @Show @req @a $ show r
227+ , \x -> has @Read r $ readMaybe x
228+ )
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 @@
1module Main where
1module Main where
2
2
3import Control.Monad
3import Control.Monad
4−import Language.Haskell.HLint3 (hlint)
4+import Language.Haskell.HLint (hlint)
5import System.Directory
5import System.Directory
6import System.Exit (exitFailure, exitSuccess)
6import System.Exit (exitFailure, exitSuccess)
7import System.FilePath
7import System.FilePath
@@ -22,6 +22,8 @@ main = do
22 , "--ignore=Use unless"
22 , "--ignore=Use unless"
23 , "--ignore=Reduce duplication"
23 , "--ignore=Reduce duplication"
24 , "--cpp-define=USE_TEMPLATE_HASKELL"
24 , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--cpp-define=DEBUG"
26+ , "--ignore=Use tuple-section"
25 ]
27 ]
26 recurseInto = and <$> sequence
28 recurseInto = and <$> sequence
27 [ fileType ==? Directory
29 [ fileType ==? Directory
@@ -29,16 +31,9 @@ main = do
29 ]
31 ]
30 matchFile = and <$> sequence
32 matchFile = and <$> sequence
31 [ extension ==? ".hs"
33 [ extension ==? ".hs"
32− , let notElem' = liftOp notElem
33− in filePath `notElem'` filePathExceptions pwd
34 ]
34 ]
35 files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
35 files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
36 ideas <- fmap concat $ forM files $ \f -> do
36 ideas <- fmap concat $ forM files $ \f -> do
37 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
37 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
38 runHlint f
38 runHlint f
39 if null ideas then exitSuccess else exitFailure
39 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− ]