on develop help sign in
89 files changed+5524−3989
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+41 .stylish-haskell.yaml+2−3 .travis.yml−16 CONTRIBUTING.md+66 ChangeLog.md+151 Quickref.md+39−10 README.md+15−11 bench-cbits/checkCapability.c+11−12 bench/Main.hs+7−6 bench/RunAll.hs+1−1 cabal.haskell-ci+23 cabal.project+1 default.nix−38 dep/reflex-platform/default.nix+7 dep/reflex-platform/github.json+7 reflex.cabal+267−90 release.nix+58 src/Control/Monad/ReaderIO.hs+60 src/Data/AppendMap.hs+58−382 src/Data/FastMutableIntMap.hs+26−9 src/Data/FastWeakBag.hs+16−12 src/Data/Functor/Misc.hs−363 src/Data/Map/Misc.hs+27−11 src/Data/WeakBag.hs+13−11 src/Reflex.hs+8−2 src/Reflex/Adjustable/Class.hs+89−115 src/Reflex/BehaviorWriter/Base.hs+211 src/Reflex/BehaviorWriter/Class.hs+31 src/Reflex/Class.hs+728−348 src/Reflex/Collection.hs+164−60 src/Reflex/Dynamic.hs+66−216 src/Reflex/Dynamic/TH.hs+4−28 src/Reflex/DynamicWriter.hs+4−221 src/Reflex/DynamicWriter/Base.hs+246 src/Reflex/DynamicWriter/Class.hs+28 src/Reflex/EventWriter.hs+4−279 src/Reflex/EventWriter/Base.hs+317 src/Reflex/EventWriter/Class.hs+26 src/Reflex/FastWeak.hs+73−6 src/Reflex/FunctorMaybe.hs+32−18 src/Reflex/Host/Class.hs+6−26 src/Reflex/Host/Headless.hs+128 src/Reflex/Network.hs+14−9 src/Reflex/NotReady/Class.hs+16−6 src/Reflex/Optimizer.hs+13−4 src/Reflex/Patch.hs−34 src/Reflex/Patch/Class.hs−22 src/Reflex/Patch/DMap.hs−68 src/Reflex/Patch/DMapWithMove.hs−281 src/Reflex/Patch/IntMap.hs−50 src/Reflex/Patch/Map.hs−64 src/Reflex/Patch/MapWithMove.hs−156 src/Reflex/PerformEvent/Base.hs+7−4 src/Reflex/PerformEvent/Class.hs+6−2 src/Reflex/PostBuild/Base.hs+4−2 src/Reflex/PostBuild/Class.hs−2 src/Reflex/Profiled.hs+99−23 src/Reflex/Pure.hs+38−27 src/Reflex/Query/Base.hs+115−55 src/Reflex/Query/Class.hs+92−11 src/Reflex/Requester/Base.hs+202−24 src/Reflex/Requester/Class.hs−1 src/Reflex/Spider.hs+5−7 src/Reflex/Spider/Internal.hs+972−507 src/Reflex/Spider/SpiderTimeline.include.hs−155 src/Reflex/Spider/SpiderTimelineHost.include.hs−57 src/Reflex/Time.hs+158−14 src/Reflex/TriggerEvent/Base.hs+5−1 src/Reflex/TriggerEvent/Class.hs+6−1 src/Reflex/Widget/Basic.hs+3−1 src/Reflex/Workflow.hs+14−28 stylize+4 test/Adjustable.hs+62 test/DebugCycles.hs+171 test/EventWriterT.hs+95−5 test/GC.hs+14−8 test/Headless.hs+10 test/QueryT.hs+20−9 test/Reflex/Bench/Focused.hs+13−1 test/Reflex/Plan/Pure.hs+5−4 test/Reflex/Plan/Reflex.hs+2−2 test/Reflex/Test/CrossImpl.hs+24−15 test/Reflex/Test/Micro.hs+71−4 test/Reflex/TestPlan.hs+2−2 test/RequesterT.hs+184−14 test/Test/Run.hs+8 test/hlint.hs+6−10 test/rootCleanup.hs+3−3 test/semantics.hs−2
.github/workflows/haskell.ymlnew file+41
@@ -0,0 +1,41 @@
1+name: github-action
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+ strategy:
8+ matrix:
9+ ghc: ['8.4.4', '8.6.5', '8.8.4', '8.10.2']
10+ os: ['ubuntu-latest', 'macos-latest']
11+ runs-on: ${{ matrix.os }}
12+
13+ name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
14+ steps:
15+ - uses: actions/checkout@v2
16+ - uses: actions/setup-haskell@v1
17+ with:
18+ ghc-version: ${{ matrix.ghc }}
19+ - name: Cache
20+ uses: actions/cache@v1
21+ env:
22+ cache-name: cache-cabal
23+ with:
24+ path: ~/.cabal
25+ key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
26+ restore-keys: |
27+ ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
28+ ${{ runner.os }}-${{ matrix.ghc }}-build-
29+ ${{ runner.os }}-${{ matrix.ghc }}-
30+ ${{ runner.os }}
31+
32+ - name: Install dependencies
33+ run: |
34+ cabal update
35+ cabal build --only-dependencies --enable-tests --enable-benchmarks
36+ - name: Build
37+ run: cabal build --enable-tests --enable-benchmarks all
38+ - name: Run tests
39+ run: cabal test all
40+ - name: Build Docs
41+ run: cabal haddock
.stylish-haskell.yaml+2−3
@@ -149,6 +149,5 @@ columns: 110
149149# needs to be aware of these, so it can parse the file correctly.
150150#
151151# No language extensions are enabled by default.
152−# language_extensions:
153− # - TemplateHaskell
154− # - QuasiQuotes
152+language_extensions:
153+ - TemplateHaskell
.travis.ymldeleted−16
@@ -1,16 +0,0 @@
1−# Cache Buster: 0
2−language: nix
3−cache:
4− directories:
5− - /nix
6−matrix:
7− include:
8− - env: COMPILER=ghc7103
9− - env: COMPILER=ghc821
10− - env: COMPILER=ghc802
11− - env: COMPILER=ghcjs
12−script:
13− - set -e
14− - nix-build -E "with (import <nixpkgs> {}); pkgs.haskell.packages.$COMPILER.callPackage ./default.nix { }"
15− - nix-collect-garbage -d # This is important to do right before 'script' ends so the cache gets GCed
16−
CONTRIBUTING.mdnew file+66
@@ -0,0 +1,66 @@
1+# Contribution Guide
2+
3+Contributions and issue reports are encouraged and appreciated!
4+
5+- [Opening Issues](#opening-issues)
6+- [Submitting Changes](#submitting-changes)
7+ - [Guidelines for Commit Messages](#guidelines-for-commit-messages)
8+ - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
9+ - [Code Quality](#code-quality)
10+ - [Documentation](#documentation)
11+
12+## Opening Issues
13+
14+Before opening an issue, please check whether your issue has already been reported. Assuming it has not:
15+
16+* Describe the issue you're encountering or the suggestion you're making
17+* Include any relevant steps to reproduce or code samples you can. It's always easier for us to debug if we have something that demonstrates the error.
18+* Let us know what version of reflex you were using. If you're using a github checkout, provide the git hash.
19+* Describe how you're building reflex (i.e., via reflex-platform, cabal install, stack, obelisk, etc.). If you're using reflex-platform or obelisk, provide the git hash of your checkout.
20+
21+## Submitting Changes
22+
23+### Guidelines for Commit Messages
24+
25+#### Summary Line
26+The summary line of your commit message should summarize the changes being made. Commit messages should be written in the imperative mood and should describe what happens when the commit is applied.
27+
28+One way to think about it is that your commit message should be able to complete the sentence:
29+"When applied, this commit will..."
30+
31+#### Body
32+For breaking changes, new features, refactors, or other major changes, the body of the commit message should describe the motivation behind the change in greater detail and may include references to the issue tracker. The body shouldn't repeat code/comments from the diff.
33+
34+### Guidelines for Pull Requests
35+
36+Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
37+
38+### Code Quality
39+
40+#### Warnings
41+
42+Your pull request should add no new warnings to the project. It should also generally not disable any warnings.
43+
44+#### Build and Test
45+
46+Make sure the project builds and that the tests pass! This will generally also be checked by CI before merge, but trying it yourself first means you'll catch problems earlier and your contribution can be merged that much sooner!
47+
48+#### Dependencies
49+
50+Include version bounds whenever adding a dependency to the library stanza of the cabal file. Note that libraries added to reflex.cabal also need to be added to default.nix.
51+
52+### Documentation
53+
54+#### In the code
55+We're always striving to improve documentation. Please include [haddock](https://haskell-haddock.readthedocs.io/en/latest/index.html) documentation for any added code, and update the documentation for any code you modify.
56+
57+#### In the [Changelog](ChangeLog.md)
58+Add an entry to the changelog when your PR:
59+* Adds a feature
60+* Deprecates something
61+* Includes a breaking change
62+* Makes any other change that will impact users
63+
64+#### In the [Readme](README.md)
65+The readme is the first place a lot of people look for information about the repository. Update any parts of the readme that are affected by your PR.
66+
ChangeLog.mdnew file+151
@@ -0,0 +1,151 @@
1+# Revision history for reflex
2+
3+## 0.8.2.0
4+
5+* Add `matchResponseMapWithRequests`, which it similar to `matchResponsesWithRequests` but allows processing of multiple responses at once.
6+
7+## 0.8.1.1
8+
9+* Allow newer hlint for older GHCs, and add upper bound for newer GHCs
10+
11+## 0.8.1.0
12+
13+* Add support for GHC 8.10
14+* Drop support for GHC < 8.4
15+
16+## 0.8.0.0
17+
18+* Replace 0.7.2.0 with 0.8.0.0 to reflect the `MonadHold` interface change. Deprecates 0.7.2.0.
19+
20+## 0.7.2.0 -- *Deprecated*
21+
22+* ([#416](https://github.com/reflex-frp/reflex/pull/416)) Add `now :: m (Event t ())` to `MonadHold`.
23+* Extend some dependency version bounds
24+* Fix HLint 3 test
25+
26+## 0.7.1.1
27+
28+*Backport release*.
29+Changes do not carry forward to 0.7.2.0.
30+
31+* Add support for GHC 8.10
32+* Drop support for GHC < 8.4
33+* Extend some dependency version bounds
34+* Fix HLint 3 test
35+
36+## 0.7.1.0
37+
38+* ([#413](https://github.com/reflex-frp/reflex/pull/413), [#417](https://github.com/reflex-frp/reflex/pull/417)) Add `Reflex.Host.Headless` module which provides `runHeadlessApp` as an easy way to run a Reflex network in a "headless" environment.
39+* ([#420](https://github.com/reflex-frp/reflex/pull/420)) Add a [`Data.Zip.Unzip`](https://hackage.haskell.org/package/semialign-1.1/docs/Data-Zip.html#t:Unzip) instance for `Event`.
40+* ([#419](https://github.com/reflex-frp/reflex/pull/419)) Add `distributeIntMapOverDynPure` and `joinDynThroughIntMap` as convenience functions for working with `Dynamic` `IntMap`s.
41+
42+
43+## 0.7.0.0
44+
45+* Add lifting instances for most classes to `Reflex.Profiled.Profiled`. ([#398](https://github.com/reflex-frp/reflex/pull/398))
46+* Class `MonadQuery t q m` now has a `Monad m` superclass constraint. ([#400](https://github.com/reflex-frp/reflex/pull/400))
47+* **(Breaking change)** Rename class `MonadBehaviorWriter` -> `BehaviorWriter` for consistency with `EventWriter`/`DynamicWriter`. ([#401](https://github.com/reflex-frp/reflex/pull/401))
48+* Introduce deprecated alias `MonadBehaviorWriter = BehaviorWriter`. ([#401](https://github.com/reflex-frp/reflex/pull/401))
49+* Fix bug in spider where event subscriptions would be prematurely finalized due to over-aggressive inlining. ([#409](https://github.com/reflex-frp/reflex/pull/409))
50+* Add instances of `PerformEvent` and `TriggerEvent` for `MaybeT`. ([#395](https://github.com/reflex-frp/reflex/pull/395))
51+
52+## 0.6.4.1
53+
54+* Fix a bug in the Reflex Profiled transformer where
55+ `Reflex.Class.mergeIncrementalG` and
56+ `Reflex.Class.mergeIncrementalWithMoveG` implementations referenced
57+ itself instead of the inner transformed timeline, causing an
58+ infinite loop.
59+
60+## 0.6.4
61+
62+* Support GHC 8.8
63+
64+* Add `Reflex.Query.Base.mapQueryT`. See that module for documentation
65+
66+* The `Reflex.Patch.*` modules were moved to the `patch` library.
67+ They are `Data.Patch.*` there, but reexported under their old names for backwards compatability here.
68+
69+* Additional instances for `Query` classes for basic types.
70+
71+* Add cabal flags `debug-propagation` and `debug-event-cycles` to build in debugging
72+ code for performance and for cyclic dependencies between events
73+
74+## 0.6.3
75+
76+* `Data.WeakBag.traverse` and `Data.FastWeakBag.traverse` have been deprecated.
77+ They are replaced with `Data.WeakBag.traverse_` and `Data.FastWeakBag.traverse_`, respectively.
78+
79+* Fixes a bug in `Reflex.Patch.MapWithMove.patchThatSortsMapWith` that was producing invalid `PatchMapWithMove`.
80+
81+* Add missing `NotReady` instances:
82+ - `instance NotReady (SpiderTimeline x) (SpiderHost x)`
83+ - `instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x))`
84+
85+## 0.6.2.4
86+
87+* Update to monoidal-containers 0.6
88+
89+## 0.6.2.3
90+
91+* Add an upper-bound to witherable
92+
93+## 0.6.2.2
94+
95+* Support these >= 1. Add `split-these` flag to control whether to use new these/semialign combination or not.
96+
97+* Update version bounds to fix some CI failures
98+
99+* Add travis CI configuration
100+
101+## 0.6.2.1
102+
103+* Generalize `fan` to `fanG` to take a `DMap` with non-`Identity`
104+ functor:
105+ * `fan` to `fanG`
106+ * `EventSelectorG` for `fanG` result selector.
107+
108+* Reduce the amount of unsafeCoerce in coercing newtypes under Event/Dynamic/Behavior.
109+ * Add fused ReaderIO for the purpose of coercion (ReaderT's third argument has nominal role preventing automated coerce)
110+ * Add incrementalCoercion/coerceIncremental to go with dynamicCoercion/coerceDynamic
111+
112+* Generalize merging functions:
113+ `merge` to `mergeG`,
114+ `mergeIncremental` to `mergeIncrementalG`,
115+ `mergeIncrementalWithMove` to `mergeIncrementalWithMoveG`.
116+
117+* Generalize distribute function:
118+ `distributeDMapOverDynPure` to `distributeDMapOverDynPureG`,
119+
120+## 0.6.2.0
121+
122+* Fix `holdDyn` so that it is lazy in its event argument
123+ These produce `DMap`s whose values needn't be `Identity`.
124+
125+* Stop using the now-deprecated `*Tag` classes (e.g., `ShowTag`).
126+
127+* Fix `holdDyn` so that it is lazy in its event argument.
128+
129+## 0.6.1.0
130+
131+* Re-export all of `Data.Map.Monoidal`
132+
133+* Fix `QueryT` and `RequesterT` tests
134+
135+## 0.6.0.0 -- 2019-03-20
136+
137+* Deprecate `FunctorMaybe` in favor of `Data.Witherable.Filterable`. We still export `fmapMaybe`, `ffilter`, etc., but they all rely on `Filterable` now.
138+
139+* Rename `MonadDynamicWriter` to `DynamicWriter` and add a deprecation for the old name.
140+
141+* Remove many deprecated functions.
142+
143+* Add a `Num` instance for `Dynamic`.
144+
145+* Add `matchRequestsWithResponses` to make it easier to use `Requester` with protocols that don't do this matching for you.
146+
147+* Add `withRequesterT` to map functions over the request and response of a `RequesterT`.
148+
149+* Suppress nil patches in `QueryT` as an optimization. The `Query` type must now have an `Eq` instance.
150+
151+* Add `throttleBatchWithLag` to `Reflex.Time`. See that module for details.
Quickref.md+39−10
@@ -54,18 +54,19 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
5454[ ] difference :: Event a -> Event b -> Event a
5555[ ] align :: Event a -> Event b -> Event (These a b)
5656[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
57+ -- Note align functions from Data.Align in semialign package
5758[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
5859[ ] leftmost :: [Event a] -> Event a
5960[ ] mergeList :: [Event a] -> Event (NonEmpty a)
60−[ ] merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
61+[ ] merge :: GCompare k => DMap k Event -> Event (DMap k Identity)
6162[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
6263
6364-- Efficient one-to-many fanout
64−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
65−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
66−[ ] select :: EventSelector k -> k a -> Event a
67−[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
68−[ ] fanThese :: Event (These a b) -> (Event a, Event b)
65+[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
66+[ ] fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
67+[ ] select :: EventSelector k -> k a -> Event a
68+[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
69+[ ] fanThese :: Event (These a b) -> (Event a, Event b)
6970
7071-- Event to Event via function that can sample current values
7172[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
@@ -98,6 +99,10 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
9899[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
99100-- ... plus many more due to typeclass membership
100101
102+-- Combine multiple behaviors via applicative instance
103+[ ] ffor2 :: Behavior a -> Behavior b -> (a -> b -> c) -> Behavior c
104+[ ] ffor3 :: Behavior a -> Behavior b -> Behavior c -> (a -> b -> c -> d) -> Behavior d
105+
101106-- Behavior to Behavior by sampling current values
102107[S] sample :: Behavior a -> m a
103108[ ] pull :: m a -> Behavior a
@@ -135,6 +140,10 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
135140[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
136141[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
137142
143+-- Combine multiple dynamics via applicative instance
144+[ ] ffor2 :: Dynamic a -> Dynamic b -> (a -> b -> c) -> Dynamic c
145+[ ] ffor3 :: Dynamic a -> Dynamic b -> Dynamic c -> (a -> b -> c -> d) -> Dynamic d
146+
138147-- Efficient one-to-many fanout
139148[ ] demux :: Ord k => Dynamic k -> Demux k
140149[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
@@ -158,7 +167,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
158167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
159168[ ] switch :: Behavior (Event a) -> Event a
160169
161−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
162171[ ] switchDyn :: Dynamic (Event a) -> Event a
163172
164173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
@@ -190,7 +199,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
190199The functions mentioned above are used to create a static FRP network.
191200There are additional typeclasses that can be used to modify the FRP network, to have it interact with IO action, or to introspect the building of the network.
192201
193−Th typeclasses and their associated annotations include:
202+The typeclasses and their associated annotations include:
194203
195204- `PostBuild`
196205 Fire an Event when an FRP network has been set up.
@@ -198,7 +207,7 @@ Th typeclasses and their associated annotations include:
198207 [B] -- Function runs in any monad supporting PostBuild
199208 ```
200209
201−- `Adjustable`
210+- `Adjustable`
202211 Use Events to add or remove pieces of an FRP network.
203212 ```haskell
204213 [A] -- Function runs in any monad supporting Adjustable
@@ -263,7 +272,7 @@ Th typeclasses and their associated annotations include:
263272```haskell
264273-- Run side-effecting actions in Event when it occurs; returned Event contains
265274-- results. Side effects run in the (Performable m) monad which is associated with
266−-- the (PerformEvent t m) typeclass constraint.
275+-- the (PerformEvent t m) typeclass constraint.
267276-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
268277[P] performEvent :: Event (Performable m a ) -> m (Event a)
269278
@@ -284,3 +293,23 @@ Th typeclasses and their associated annotations include:
284293[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
285294```
286295
296+## Networks
297+
298+```haskell
299+-- Functions from Reflex.Adjustable / Reflex.Network used to deal with Dynamics/Events carrying (m a)
300+
301+[A] runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
302+
303+-- Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
304+-- The returned Event of network results occurs when the Dynamic does. Note: Often, the type a is an Event,
305+-- in which case the return value is an Event-of-Events that would typically be flattened (via switchHold).
306+[P,A] networkView :: Dynamic (m a) -> m (Event a)
307+
308+-- Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the
309+-- Event fires. The returned Dynamic of network results occurs when the Event does. Note: Often, the type a is an
310+-- Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
311+[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
312+
313+-- Render a placeholder network to be shown while another network is not yet done building
314+[P,A] untilReady :: m a -> m b -> m (a, Event b)
315+```
README.md+15−11
@@ -1,19 +1,23 @@
1−## Reflex
2−### Practical Functional Reactive Programming
1+# [Reflex](https://reflex-frp.org/)
32
4−Reflex is an fully-deterministic, higher-order Functional Reactive Programming (FRP) interface and an engine that efficiently implements that interface.
3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/reflex.svg)](https://hackage.haskell.org/package/reflex) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/reflex/badge)](https://matrix.hackage.haskell.org/#/package/reflex) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/reflex/blob/master/LICENSE)
54
6−[Reflex-DOM](https://github.com/reflex-frp/reflex-dom) is a framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
5+Interactive programs without callbacks or side-effects. Functional Reactive Programming (FRP) uses composable events and time-varying values to describe interactive systems as pure functions. Just like other pure functional code, functional reactive code is easier to get right on the first try, maintain, and reuse.
76
8−Comprehensive documentation is still a work in progress, but a tutorial for Reflex and Reflex-DOM is available at https://github.com/reflex-frp/reflex-platform and an introductory talk given at the New York Haskell Meetup is available here: [Part 1](https://www.youtube.com/watch?v=mYvkcskJbc4) / [Part 2](https://www.youtube.com/watch?v=3qfc9XFVo2c).
7+Reflex is a fully-deterministic, higher-order Functional Reactive Programming interface and an engine that efficiently implements that interface.
98
10−A summary of Reflex functions is available in the [quick reference](Quickref.md).
9+**Visit https://reflex-frp.org for more information, tutorials, documentation and [examples](https://examples.reflex-frp.org/).**
1110
12−### Additional resources
13−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
11+## Resources
1412
15−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
13+* [Official Website](https://reflex-frp.org)
14+* [Quick Reference](Quickref.md)
15+* [Reflex-DOM](https://github.com/reflex-frp/reflex-dom): A framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
16+* [Obelisk](https://github.com/obsidiansystems/obelisk#obelisk): A framework built on Reflex and Reflex-DOM for functional reactive web and mobile applications, with batteries included.
17+* [Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
18+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
19+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
1620
17−[hackage](https://hackage.haskell.org/package/reflex)
21+## Hacking
1822
19−[irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
23+From the root of a [Reflex Platform](https://github.com/reflex-frp/reflex-platform) checkout, run `./scripts/hack-on haskell-overlays/reflex-packages/dep/reflex`. This will check out the reflex source code into the `haskell-overlays/reflex-packages/dep/reflex` directory. You can then point that checkout at your fork, make changes, etc. Use the `./try-reflex` or `./scripts/work-on` scripts to start a shell in which you can test your changes.
bench-cbits/checkCapability.c+11−12
@@ -42,7 +42,7 @@ typedef struct Task_ {
4242 // or just continue immediately. It's a workaround for the fact
4343 // that signalling a condition variable doesn't do anything if the
4444 // thread is already running, but we want it to be sticky.
45− rtsBool wakeup;
45+ HsBool wakeup;
4646#endif
4747
4848 // This points to the Capability that the Task "belongs" to. If
@@ -62,14 +62,14 @@ typedef struct Task_ {
6262 // The current top-of-stack InCall
6363 struct InCall_ *incall;
6464
65− nat n_spare_incalls;
65+ uint32_t n_spare_incalls;
6666 struct InCall_ *spare_incalls;
6767
68− rtsBool worker; // == rtsTrue if this is a worker Task
69− rtsBool stopped; // this task has stopped or exited Haskell
68+ HsBool worker; // == rtsTrue if this is a worker Task
69+ HsBool stopped; // this task has stopped or exited Haskell
7070
7171 // So that we can detect when a finalizer illegally calls back into Haskell
72− rtsBool running_finalizers;
72+ HsBool running_finalizers;
7373
7474 // Links tasks on the returning_tasks queue of a Capability, and
7575 // on spare_workers.
@@ -88,7 +88,7 @@ struct Capability_ {
8888 StgFunTable f;
8989 StgRegTable r;
9090
91− nat no; // capability number.
91+ uint32_t no; // capability number.
9292
9393 // The Task currently holding this Capability. This task has
9494 // exclusive access to the contents of this Capability (apart from
@@ -98,12 +98,12 @@ struct Capability_ {
9898
9999 // true if this Capability is running Haskell code, used for
100100 // catching unsafe call-ins.
101− rtsBool in_haskell;
101+ HsBool in_haskell;
102102
103103 // Has there been any activity on this Capability since the last GC?
104− nat idle;
104+ uint32_t idle;
105105
106− rtsBool disabled;
106+ HsBool disabled;
107107
108108 // The run queue. The Task owning this Capability has exclusive
109109 // access to its run queue, so can wake up threads without
@@ -159,7 +159,7 @@ struct Capability_ {
159159#if defined(THREADED_RTS)
160160 // Worker Tasks waiting in the wings. Singly-linked.
161161 Task *spare_workers;
162− nat n_spare_workers; // count of above
162+ uint32_t n_spare_workers; // count of above
163163
164164 // This lock protects:
165165 // running_task
@@ -192,10 +192,9 @@ struct Capability_ {
192192
193193 // Per-capability STM-related data
194194 StgTVarWatchQueue *free_tvar_watch_queues;
195− StgInvariantCheckQueue *free_invariant_check_queues;
196195 StgTRecChunk *free_trec_chunks;
197196 StgTRecHeader *free_trec_headers;
198− nat transaction_tokens;
197+ uint32_t transaction_tokens;
199198} // typedef Capability is defined in RtsAPI.h
200199 // We never want a Capability to overlap a cache line with anything
201200 // else, so round it up to a cache line size:
bench/Main.hs+7−6
@@ -20,6 +20,7 @@ import qualified Data.Dependent.Map as DMap
2020import Data.Dependent.Sum
2121import Data.Functor.Misc
2222import Data.IORef
23+import Data.Maybe (fromJust)
2324import Reflex
2425import Reflex.Host.Class
2526
@@ -70,7 +71,7 @@ micros =
7071 , withSetupWHNF "fireEventsOnly"
7172 (newEventWithTriggerRef >>= subscribePair)
7273 (\(_, trigger) -> do
73− Just key <- liftIO $ readIORef trigger
74+ key <- fromJust <$> liftIO (readIORef trigger)
7475 fireEvents [key :=> Identity (42 :: Int)])
7576 , withSetupWHNF "fireEventsAndRead(head/merge1)"
7677 (setupMerge 1 >>= subscribePair)
@@ -84,14 +85,14 @@ micros =
8485 , withSetupWHNF "fireEventsOnly(head/merge100)"
8586 (setupMerge 100 >>= subscribePair)
8687 (\(_, t:_) -> do
87− Just key <- liftIO $ readIORef t
88+ key <- fromJust <$> liftIO (readIORef t)
8889 fireEvents [key :=> Identity (42 :: Int)])
8990 , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
9091 , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
9192 ]
9293
9394setupMerge :: Int
94− -> SpiderHost Global ( Event (SpiderEnv Global) (DMap (Const2 Int a) Identity)
95+ -> SpiderHost Global ( Event (SpiderTimeline Global) (DMap (Const2 Int a) Identity)
9596 , [IORef (Maybe (EventTrigger Spider a))]
9697 )
9798setupMerge num = do
@@ -99,11 +100,11 @@ setupMerge num = do
99100 let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100101 pure (merge m, triggers)
101102
102−subscribePair :: (Event (SpiderEnv Global) a, b) -> SpiderHost Global (EventHandle (SpiderEnv Global) a, b)
103+subscribePair :: (Event (SpiderTimeline Global) a, b) -> SpiderHost Global (EventHandle (SpiderTimeline Global) a, b)
103104subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104105
105−fireAndRead :: IORef (Maybe (EventTrigger (SpiderEnv Global) a)) -> a -> EventHandle (SpiderEnv Global) b
106+fireAndRead :: IORef (Maybe (EventTrigger (SpiderTimeline Global) a)) -> a -> EventHandle (SpiderTimeline Global) b
106107 -> SpiderHost Global (Maybe b)
107108fireAndRead trigger val subd = do
108− Just key <- liftIO $ readIORef trigger
109+ key <- fromJust <$> liftIO (readIORef trigger)
109110 fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
bench/RunAll.hs+1−1
@@ -136,7 +136,7 @@ benchmarks = implGroup "spider" runSpiderHost cases
136136pattern RunTestCaseFlag = "--run-test-case"
137137
138138spawnBenchmark :: String -> Benchmark
139−spawnBenchmark name = Benchmark name $ Benchmarkable $ \n -> do
139+spawnBenchmark name = bench name . toBenchmarkable $ \n -> do
140140 self <- getExecutablePath
141141 callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
142142
cabal.haskell-cinew file+23
@@ -0,0 +1,23 @@
1+distribution: xenial
2+benchmarks: False
3+unconstrained: False
4+installed: -all
5+
6+-- https://github.com/haskell/cabal/issues/6106
7+install-dependencies: False
8+
9+constraint-set no-th
10+ constraints: reflex -use-template-haskell
11+
12+constraint-set old-these
13+ ghc: <8.8
14+ constraints: these <1
15+
16+constraint-set old-witherable
17+ constraints: witherable <0.3.2
18+
19+constraint-set debug-propagation
20+ constraints: reflex +debug-propagation
21+
22+constraint-set debug-cycles
23+ constraints: reflex +debug-cycles
cabal.projectnew file+1
@@ -0,0 +1 @@
1+packages: .
default.nixdeleted−38
@@ -1,38 +0,0 @@
1−{ mkDerivation, ghc, base, bifunctors, containers, deepseq
2−, dependent-map, dependent-sum, exception-transformers
3−, haskell-src-exts, haskell-src-meta, hlint, lens, MemoTrie
4−, monad-control, mtl, primitive, random, ref-tf
5−, semigroupoids , semigroups, split, stdenv, stm, syb
6−, template-haskell , these, time, transformers
7−, transformers-compat, unbounded-delays, prim-uniq
8−, data-default , filepath, directory, filemanip, ghcjs-base
9−, useTemplateHaskell ? true
10−}:
11−mkDerivation {
12− pname = "reflex";
13− version = "0.5.0";
14− src = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [ ".git" "dist" ])) ./.;
15− libraryHaskellDepends = [
16− base bifunctors containers dependent-map dependent-sum
17− exception-transformers lens
18− MemoTrie monad-control mtl primitive ref-tf semigroupoids
19− semigroups stm syb template-haskell these transformers
20− transformers-compat prim-uniq
21− base bifunctors containers deepseq dependent-map dependent-sum
22− mtl ref-tf split transformers data-default
23− random time unbounded-delays
24− ] ++ (if ghc.isGhcjs or false then [
25− ghcjs-base
26− ] else []) ++ (if !useTemplateHaskell then [] else [
27− haskell-src-exts haskell-src-meta
28− ]);
29− testHaskellDepends = if ghc.isGhcjs or false then [] else [
30− hlint filepath directory filemanip
31− ];
32− configureFlags = if useTemplateHaskell then [] else [
33− "-f-use-template-haskell"
34− ];
35− homepage = "https://github.com/reflex-frp/reflex";
36− description = "Higher-order Functional Reactive Programming";
37− license = stdenv.lib.licenses.bsd3;
38−}
dep/reflex-platform/default.nixnew file+7
@@ -0,0 +1,7 @@
1+# DO NOT HAND-EDIT THIS FILE
2+import ((import <nixpkgs> {}).fetchFromGitHub (
3+ let json = builtins.fromJSON (builtins.readFile ./github.json);
4+ in { inherit (json) owner repo rev sha256;
5+ private = json.private or false;
6+ }
7+))
dep/reflex-platform/github.jsonnew file+7
@@ -0,0 +1,7 @@
1+{
2+ "owner": "reflex-frp",
3+ "repo": "reflex-platform",
4+ "branch": "develop",
5+ "rev": "f628398d076243a0851b27e625b37f65dff9b89b",
6+ "sha256": "0sl0hf1glgyb1vmf2mhw4r9ipmcqk1y19d3wsic7dix2jwywzrh9"
7+}
reflex.cabal+267−90
@@ -1,7 +1,17 @@
11Name: reflex
2−Version: 0.5
2+Version: 0.8.2.0
33Synopsis: Higher-order Functional Reactive Programming
4−Description: Reflex is a high-performance, deterministic, higher-order Functional Reactive Programming system
4+Description:
5+ Interactive programs without callbacks or side-effects.
6+ Functional Reactive Programming (FRP) uses composable events and time-varying
7+ values to describe interactive systems as pure functions.
8+ Just like other pure functional code, functional reactive code is easier
9+ to get right on the first try, maintain, and reuse.
10+ .
11+ Reflex is a fully-deterministic, higher-order Functional Reactive Programming
12+ interface and an engine that efficiently implements that interface.
13+ .
14+ <https://reflex-frp.org>
515License: BSD3
616License-file: LICENSE
717Author: Ryan Trinkle
@@ -9,14 +19,17 @@ Maintainer: ryan.trinkle@gmail.com
919Stability: Experimental
1020Category: FRP
1121Build-type: Simple
12−Cabal-version: >=1.9.2
13−homepage: https://github.com/reflex-frp/reflex
22+Cabal-version: 1.22
23+homepage: https://reflex-frp.org
1424bug-reports: https://github.com/reflex-frp/reflex/issues
25+extra-source-files:
26+ README.md
27+ Quickref.md
28+ ChangeLog.md
1529
16−flag specialize-to-spidertimeline-global
17− description: Specialize all Reflex functions to the SpiderTimeline Global implementation. This may improve performance, but will disable all other implementations.
18− default: False
19− manual: True
30+tested-with:
31+ GHC ==8.4.4 || ==8.6.5 || ==8.8.1 || ==8.10.2,
32+ GHCJS ==8.6
2033
2134flag use-reflex-optimizer
2235 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
@@ -28,89 +41,105 @@ flag use-template-haskell
2841 default: True
2942 manual: True
3043
31−flag expose-all-unfoldings
32− description: Build the library with -fexpose-all-unfoldings which can help client code specialize better
44+flag debug-trace-events
45+ description: Add instrumentation that outputs the stack trace of the definition of an event whenever it is subscribed to. Warning: It is very slow!
3346 default: False
3447 manual: True
3548
36−flag debug-trace-events
37− description: Add instrumentation that outputs the stack trace of the definition of an event whenever it is subscribed to. Warning: It is very slow!
49+flag fast-weak
50+ description: Use the primitive implementation of FastWeak in GHCJS; note that this requires GHCJS to be built with FastWeak and FastWeakBag present in the RTS, which is not the default
3851 default: False
3952 manual: True
4053
41−flag experimental-dependent-sum-instances
42− description: Use experimental incoherent instances for certain forked dependent-sum typeclasses
54+flag debug-propagation
55+ description: Enable debugging of spider internals
4356 default: False
4457 manual: True
4558
46−flag fast-weak
47− description: Use the primitive implementation of FastWeak in GHCJS; note that this requires GHCJS to be built with FastWeak and FastWeakBag present in the RTS, which is not the default
59+flag debug-cycles
60+ description: Enable debugging of event cycles
4861 default: False
4962 manual: True
5063
64+flag split-these
65+ description: Use split these/semialign packages
66+ manual: False
67+ default: True
68+
5169library
70+ default-language: Haskell2010
5271 hs-source-dirs: src
5372 build-depends:
5473 MemoTrie == 0.6.*,
55− base >= 4.7 && < 4.11,
74+ base >= 4.11 && < 4.15,
5675 bifunctors >= 5.2 && < 5.6,
57− comonad,
58− containers == 0.5.*,
76+ comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
78+ constraints-extras >= 0.3 && < 0.4,
79+ containers >= 0.6 && < 0.7,
5980 data-default >= 0.5 && < 0.8,
60− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
6182 exception-transformers == 0.4.*,
62− free == 4.12.*,
6383 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
6485 monad-control >= 1.0.1 && < 1.1,
6586 mtl >= 2.1 && < 2.3,
66− prim-uniq >= 0.1.0.1 && < 0.2,
67− primitive >= 0.5 && < 0.7,
87+ patch >= 0.0.1 && < 0.1,
88+ prim-uniq >= 0.1.0.1 && < 0.3,
89+ primitive >= 0.5 && < 0.8,
90+ profunctors >= 5.3 && < 5.7,
6891 random == 1.1.*,
6992 ref-tf == 0.4.*,
7093 reflection == 2.1.*,
7194 semigroupoids >= 4.0 && < 6,
72− semigroups >= 0.16 && < 0.19,
73− stm == 2.4.*,
95+ stm >= 2.4 && < 2.6,
7496 syb >= 0.5 && < 0.8,
75− these >= 0.4 && < 0.8,
76− time >= 1.4 && < 1.9,
77− transformers >= 0.2,
78− transformers-compat >= 0.3,
79− unbounded-delays >= 0.1.0.0 && < 0.2
97+ time >= 1.4 && < 1.10,
98+ transformers >= 0.5.6.0 && < 0.6,
99+ unbounded-delays >= 0.1.0.0 && < 0.2,
100+ witherable >= 0.3 && < 0.5
101+
102+ if flag(split-these)
103+ build-depends: these >= 1 && <1.2,
104+ semialign >=1 && <1.2,
105+ monoidal-containers >= 0.6 && < 0.7
106+ else
107+ build-depends: these >= 0.4 && <0.9,
108+ monoidal-containers == 0.4.0.0
80109
81110 exposed-modules:
111+ Control.Monad.ReaderIO
82112 Data.AppendMap,
113+ Data.FastMutableIntMap,
114+ Data.FastWeakBag,
83115 Data.Map.Misc,
84− Data.Functor.Misc,
85116 Data.WeakBag,
86− Data.FastWeakBag,
87− Data.FastMutableIntMap,
88117 Reflex,
89118 Reflex.Class,
119+ Reflex.Adjustable.Class,
120+ Reflex.BehaviorWriter.Base,
121+ Reflex.BehaviorWriter.Class,
90122 Reflex.Collection,
91− Reflex.EventWriter,
92123 Reflex.Dynamic,
93124 Reflex.Dynamic.Uniq,
94125 Reflex.DynamicWriter,
126+ Reflex.DynamicWriter.Base,
127+ Reflex.DynamicWriter.Class,
128+ Reflex.EventWriter,
129+ Reflex.EventWriter.Base,
130+ Reflex.EventWriter.Class,
95131 Reflex.FastWeak,
96132 Reflex.FunctorMaybe,
97133 Reflex.Host.Class,
134+ Reflex.Host.Headless,
98135 Reflex.Network,
99136 Reflex.NotReady.Class,
100− Reflex.Patch,
101− Reflex.Patch.Class,
102− Reflex.Patch.DMap,
103− Reflex.Patch.DMapWithMove,
104− Reflex.Patch.IntMap,
105− Reflex.Patch.Map,
106− Reflex.Patch.MapWithMove,
107− Reflex.TriggerEvent.Base,
108− Reflex.TriggerEvent.Class,
109137 Reflex.PerformEvent.Base,
110138 Reflex.PerformEvent.Class,
111139 Reflex.PostBuild.Base,
112140 Reflex.PostBuild.Class,
113141 Reflex.Profiled,
142+ Reflex.Pure,
114143 Reflex.Query.Base,
115144 Reflex.Query.Class,
116145 Reflex.Requester.Base,
@@ -118,53 +147,62 @@ library
118147 Reflex.Spider,
119148 Reflex.Spider.Internal,
120149 Reflex.Time,
150+ Reflex.TriggerEvent.Base,
151+ Reflex.TriggerEvent.Class,
121152 Reflex.Widget.Basic,
122153 Reflex.Workflow
123154
124− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively -ddump-simpl -ddump-to-file -dsuppress-coercions -dsuppress-idinfo
125− ghc-prof-options: -fprof-auto
155+ reexported-modules:
156+ patch:Data.Functor.Misc,
157+ patch:Data.Patch as Reflex.Patch,
158+ patch:Data.Patch.Class as Reflex.Patch.Class,
159+ patch:Data.Patch.DMap as Reflex.Patch.DMap,
160+ patch:Data.Patch.DMapWithMove as Reflex.Patch.DMapWithMove,
161+ patch:Data.Patch.IntMap as Reflex.Patch.IntMap,
162+ patch:Data.Patch.Map as Reflex.Patch.Map,
163+ patch:Data.Patch.MapWithMove as Reflex.Patch.MapWithMove
126164
127− if flag(specialize-to-spidertimeline-global)
128− cpp-options: -DSPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
129− else
130− exposed-modules: Reflex.Pure
165+ ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
131166
132167 if flag(debug-trace-events)
133168 cpp-options: -DDEBUG_TRACE_EVENTS
134− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
135171
136172 if flag(use-reflex-optimizer)
137173 cpp-options: -DUSE_REFLEX_OPTIMIZER
138174 build-depends: ghc
139175 exposed-modules: Reflex.Optimizer
140176
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+
141183 if flag(use-template-haskell)
142184 cpp-options: -DUSE_TEMPLATE_HASKELL
143185 build-depends:
144− dependent-sum >= 0.3 && < 0.5,
145− haskell-src-exts >= 1.16 && < 1.21,
186+ dependent-sum >= 0.6 && < 0.8,
187+ haskell-src-exts >= 1.16 && < 1.24,
146188 haskell-src-meta >= 0.6 && < 0.9,
147− template-haskell >= 2.9 && < 2.13
189+ template-haskell >= 2.9 && < 2.17
148190 exposed-modules:
149191 Reflex.Dynamic.TH
150192 other-extensions: TemplateHaskell
151193 else
152194 build-depends:
153− dependent-sum == 0.4.*
154−
155− if flag(expose-all-unfoldings)
156− ghc-options: -fexpose-all-unfoldings
157−
158− if flag(experimental-dependent-sum-instances)
159− ghc-options: -DEXPERIMENTAL_DEPENDENT_SUM_INSTANCES
195+ dependent-sum >= 0.6 && < 0.8
160196
161197 if flag(fast-weak) && impl(ghcjs)
162− ghc-options: -DGHCJS_FAST_WEAK
198+ cpp-options: -DGHCJS_FAST_WEAK
163199
164200 if impl(ghcjs)
165− build-depends: ghcjs-base
201+ build-depends:
202+ ghcjs-base == 0.2.*
166203
167204test-suite semantics
205+ default-language: Haskell2010
168206 type: exitcode-stdio-1.0
169207 main-is: semantics.hs
170208 hs-source-dirs: test
@@ -173,33 +211,46 @@ test-suite semantics
173211 base,
174212 bifunctors,
175213 containers,
176− deepseq >= 1.3 && < 1.5,
214+ deepseq,
177215 dependent-map,
178216 dependent-sum,
179217 mtl,
180218 ref-tf,
181219 reflex,
182220 split,
183− transformers >= 0.3
184− if flag(specialize-to-spidertimeline-global)
185− buildable: False
221+ transformers
222+ other-modules:
223+ Reflex.Bench.Focused
224+ Reflex.Plan.Pure
225+ Reflex.Plan.Reflex
226+ Reflex.Test
227+ Reflex.Test.Micro
228+ Reflex.TestPlan
186229
187230test-suite CrossImpl
231+ default-language: Haskell2010
188232 type: exitcode-stdio-1.0
189233 main-is: Reflex/Test/CrossImpl.hs
190234 hs-source-dirs: test
191− ghc-options: -O2 -Wall -rtsopts -main-is Reflex.Test.CrossImpl.test
235+ ghc-options: -O2 -Wall -rtsopts
192236 build-depends:
193237 base,
194238 containers,
195239 dependent-map,
240+ dependent-sum,
241+ deepseq,
196242 mtl,
243+ transformers,
197244 ref-tf,
198245 reflex
199− if flag(specialize-to-spidertimeline-global)
200− buildable: False
246+ other-modules:
247+ Reflex.Test
248+ Reflex.TestPlan
249+ Reflex.Plan.Reflex
250+ Reflex.Plan.Pure
201251
202252test-suite hlint
253+ default-language: Haskell2010
203254 type: exitcode-stdio-1.0
204255 main-is: hlint.hs
205256 hs-source-dirs: test
@@ -207,104 +258,226 @@ test-suite hlint
207258 , directory
208259 , filepath
209260 , filemanip
210− , 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
211265 if impl(ghcjs)
212266 buildable: False
213− buildable: False
214267
215268test-suite EventWriterT
269+ default-language: Haskell2010
216270 type: exitcode-stdio-1.0
217271 main-is: EventWriterT.hs
218272 hs-source-dirs: test
219273 build-depends: base
274+ , containers
275+ , deepseq
276+ , dependent-map
220277 , dependent-sum
221278 , lens
279+ , mtl
222280 , these
223281 , transformers
224282 , reflex
225283 , ref-tf
226284
285+ if flag(split-these)
286+ build-depends: these-lens
287+
288+ other-modules:
289+ Test.Run
290+
291+
292+test-suite DebugCycles
293+ default-language: Haskell2010
294+ type: exitcode-stdio-1.0
295+ main-is: DebugCycles.hs
296+ hs-source-dirs: test
297+ ghc-options: -threaded
298+ build-depends: base
299+ , containers
300+ , deepseq
301+ , dependent-map
302+ , dependent-sum
303+ , hspec
304+ , lens
305+ , mtl
306+ , these
307+ , transformers
308+ , reflex
309+ , ref-tf
310+ , witherable
311+ , proctest
312+
313+
314+ if flag(split-these)
315+ build-depends: these-lens, semialign
316+
317+ other-modules:
318+ Test.Run
319+
320+
227321test-suite RequesterT
322+ default-language: Haskell2010
228323 type: exitcode-stdio-1.0
229324 main-is: RequesterT.hs
230325 hs-source-dirs: test
231326 build-depends: base
232− , dependent-sum
327+ , constraints
328+ , constraints-extras
329+ , containers
330+ , deepseq
233331 , dependent-map
332+ , dependent-sum
234333 , lens
334+ , mtl
335+ , ref-tf
336+ , reflex
337+ , text
235338 , these
236339 , transformers
340+
341+ if flag(split-these)
342+ build-depends: these-lens
343+
344+ other-modules:
345+ Reflex.TestPlan
346+ Reflex.Plan.Pure
347+ Test.Run
348+
349+test-suite Headless
350+ default-language: Haskell2010
351+ type: exitcode-stdio-1.0
352+ main-is: Headless.hs
353+ hs-source-dirs: test
354+ build-depends: base
355+ , reflex
356+
357+test-suite Adjustable
358+ default-language: Haskell2010
359+ type: exitcode-stdio-1.0
360+ main-is: Adjustable.hs
361+ hs-source-dirs: test
362+ build-depends: base
363+ , containers
364+ , dependent-sum
237365 , reflex
238366 , ref-tf
239− buildable: False
367+ , these
368+
369+ other-modules:
370+ Test.Run
240371
241372test-suite QueryT
373+ default-language: Haskell2010
242374 type: exitcode-stdio-1.0
243375 main-is: QueryT.hs
244376 hs-source-dirs: test
245377 build-depends: base
246378 , containers
247− , dependent-sum
248379 , dependent-map
380+ , dependent-sum
381+ , deepseq
249382 , lens
383+ , monoidal-containers
384+ , mtl
385+ , patch
386+ , ref-tf
387+ , reflex
250388 , these
251389 , transformers
252− , semigroups
253− , reflex
254− , ref-tf
390+
391+ if flag(split-these)
392+ build-depends: semialign, these-lens
393+
394+ other-modules:
395+ Test.Run
396+ Reflex.TestPlan
397+ Reflex.Plan.Reflex
398+ Reflex.Plan.Pure
255399
256400test-suite GC-Semantics
401+ default-language: Haskell2010
257402 type: exitcode-stdio-1.0
258403 main-is: GC.hs
259404 hs-source-dirs: test
260− if flag(specialize-to-spidertimeline-global)
261− buildable: False
262405 build-depends: base
406+ , containers
263407 , dependent-sum
264408 , dependent-map
409+ , deepseq
410+ , mtl
411+ , patch
265412 , these
266413 , transformers
267414 , reflex
268415 , ref-tf
269− if impl(ghc < 8)
270− build-depends: semigroups
416+
417+ if flag(split-these)
418+ build-depends: semialign
419+
420+ other-modules:
421+ Reflex.Plan.Pure
422+ Reflex.Plan.Reflex
423+ Reflex.TestPlan
424+ Test.Run
271425
272426test-suite rootCleanup
427+ default-language: Haskell2010
273428 type: exitcode-stdio-1.0
274429 main-is: rootCleanup.hs
275430 hs-source-dirs: test
276431 build-depends: base
432+ , containers
433+ , deepseq
434+ , dependent-sum
435+ , mtl
277436 , reflex
437+ , ref-tf
438+ , these
439+ other-modules:
440+ Reflex.Plan.Pure
441+ Reflex.TestPlan
442+ Test.Run
278443
279444benchmark spider-bench
445+ default-language: Haskell2010
280446 type: exitcode-stdio-1.0
281− hs-source-dirs: bench
447+ hs-source-dirs: bench test
282448 main-is: Main.hs
283449 ghc-options: -Wall -O2 -rtsopts
284450 build-depends:
285451 base,
286− criterion == 1.1.*,
287− deepseq >= 1.3 && < 1.5,
452+ containers,
453+ criterion,
454+ deepseq,
288455 dependent-map,
289456 dependent-sum,
457+ ref-tf,
290458 mtl,
291459 primitive,
292460 reflex,
461+ split,
293462 stm,
294− transformers >= 0.3
463+ transformers
464+ other-modules:
465+ Reflex.TestPlan
466+ Reflex.Plan.Reflex
467+ Reflex.Bench.Focused
295468
296469benchmark saulzar-bench
470+ default-language: Haskell2010
297471 type: exitcode-stdio-1.0
298472 hs-source-dirs: bench test
299473 c-sources: bench-cbits/checkCapability.c
300474 main-is: RunAll.hs
301475 ghc-options: -Wall -O2 -rtsopts -threaded
302− ghc-prof-options: -fprof-auto
303476 build-depends:
304477 base,
305− containers == 0.5.*,
306− criterion == 1.1.*,
307− deepseq >= 1.3 && < 1.5,
478+ containers,
479+ criterion,
480+ deepseq,
308481 dependent-map,
309482 dependent-sum,
310483 loch-th,
@@ -316,7 +489,11 @@ benchmark saulzar-bench
316489 split,
317490 stm,
318491 time,
319− transformers >= 0.3
492+ transformers
493+ other-modules:
494+ Reflex.TestPlan
495+ Reflex.Plan.Reflex
496+ Reflex.Bench.Focused
320497
321498source-repository head
322499 type: git
release.nixnew file+58
@@ -0,0 +1,58 @@
1+{ reflex-platform-fun ? import ./dep/reflex-platform
2+, supportedSystems ? ["x86_64-linux" "x86_64-darwin"]
3+}:
4+
5+let
6+ native-reflex-platform = reflex-platform-fun {};
7+ inherit (native-reflex-platform.nixpkgs) lib;
8+
9+ perPlatform = lib.genAttrs supportedSystems (system: let
10+ reflex-platform = reflex-platform-fun { inherit system; };
11+ compilers = [
12+ "ghc"
13+ "ghcjs"
14+ ] ++ lib.optionals (reflex-platform.androidSupport) [
15+ "ghcAndroidAarch64"
16+ "ghcAndroidAarch32"
17+ ] ++ lib.optionals (reflex-platform.iosSupport) [
18+ "ghcIosAarch64"
19+ ];
20+ variations = map (v: "reflex" + v) [
21+ "-dontUseTemplateHaskell"
22+ ""
23+ ];
24+ compilerPkgs = lib.genAttrs compilers (ghc: let
25+ variationPkgs = lib.genAttrs variations (variation: let
26+ reflex-platform = reflex-platform-fun {
27+ inherit system;
28+ __useTemplateHaskell = variation == "reflex"; # TODO hack
29+ haskellOverlays = [
30+ # Use this package's source for reflex
31+ (self: super: {
32+ _dep = super._dep // {
33+ reflex = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [
34+ "release.nix"
35+ ".git"
36+ "dist"
37+ "cabal.haskell-ci"
38+ "cabal.project"
39+ ".travis.yml"
40+ ])) ./.;
41+ };
42+ })
43+ ];
44+ };
45+ in reflex-platform.${ghc}.reflex);
46+ in variationPkgs // {
47+ cache = reflex-platform.pinBuildInputs "reflex-${system}-${ghc}"
48+ (builtins.attrValues variationPkgs);
49+ });
50+ in compilerPkgs // {
51+ cache = reflex-platform.pinBuildInputs "reflex-${system}"
52+ (map (a: a.cache) (builtins.attrValues compilerPkgs));
53+ });
54+
55+ metaCache = native-reflex-platform.pinBuildInputs "reflex-everywhere"
56+ (map (a: a.cache) (builtins.attrValues perPlatform));
57+
58+in perPlatform // { inherit metaCache; }
src/Control/Monad/ReaderIO.hsnew file+60
@@ -0,0 +1,60 @@
1+{-# language RoleAnnotations #-}
2+{-# language MultiParamTypeClasses #-}
3+{-# language FlexibleInstances #-}
4+{-# language CPP #-}
5+module Control.Monad.ReaderIO
6+ (
7+ ReaderIO (..)
8+ )
9+ where
10+
11+import Control.Monad.Fix
12+#if MIN_VERSION_base(4,10,0)
13+import Control.Applicative
14+#endif
15+import Control.Monad
16+import Control.Monad.Reader.Class
17+import Control.Monad.IO.Class
18+
19+-- | An approximate clone of @RIO@ from the @rio@ package, but not based on
20+-- @ReaderT@. The trouble with @ReaderT@ is that its third type argument has a
21+-- @nominal@ role, so we can't coerce through it when it's wrapped in some
22+-- other @data@ type. Ugh.
23+newtype ReaderIO e a = ReaderIO { runReaderIO :: e -> IO a }
24+type role ReaderIO representational representational
25+
26+instance Functor (ReaderIO e) where
27+ fmap = liftM
28+ {-# INLINE fmap #-}
29+ a <$ m = m >> pure a
30+ {-# INLINE (<$) #-}
31+
32+instance Applicative (ReaderIO e) where
33+ pure a = ReaderIO $ \_ -> pure a
34+ {-# INLINE pure #-}
35+ (<*>) = ap
36+ {-# INLINE (<*>) #-}
37+#if MIN_VERSION_base(4,10,0)
38+ liftA2 = liftM2
39+ {-# INLINE liftA2 #-}
40+#endif
41+ (*>) = (>>)
42+ {-# INLINE (*>) #-}
43+
44+instance Monad (ReaderIO e) where
45+ ReaderIO q >>= f = ReaderIO $ \e -> q e >>= \a -> runReaderIO (f a) e
46+ {-# INLINE (>>=) #-}
47+
48+instance MonadFix (ReaderIO e) where
49+ mfix f = ReaderIO $ \e -> mfix $ \r -> runReaderIO (f r) e
50+ {-# INLINE mfix #-}
51+
52+instance MonadIO (ReaderIO e) where
53+ liftIO m = ReaderIO $ \_ -> m
54+ {-# INLINE liftIO #-}
55+
56+instance MonadReader e (ReaderIO e) where
57+ ask = ReaderIO pure
58+ {-# INLINE ask #-}
59+ local f (ReaderIO m) = ReaderIO (m . f)
60+ {-# INLINE local #-}
src/Data/AppendMap.hs+58−382
@@ -1,408 +1,84 @@
1−{-# LANGUAGE DeriveFunctor #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE DeriveTraversable #-}
1+{-# LANGUAGE CPP #-}
42{-# LANGUAGE FlexibleContexts #-}
53{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
74{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE PatternSynonyms #-}
86{-# LANGUAGE RoleAnnotations #-}
97{-# LANGUAGE ScopedTypeVariables #-}
108{-# LANGUAGE TypeFamilies #-}
11−-- | 'Data.Map' with a better 'Monoid' instance
12−--
13−-- 'Data.Map' has @mappend = union@, which is left-biased. AppendMap has
14−-- @mappend = unionWith mappend@ instead.
15−module Data.AppendMap where
9+{-# OPTIONS_GHC -fno-warn-orphans #-}
10+-- |
11+-- Module:
12+-- Data.AppendMap
13+-- Description:
14+-- Instances and convenience functions for 'Data.Map.Monoidal'. We use
15+-- monoidal-containers to take advantage of its better monoid instance.
16+-- 'Data.Map' has @mappend = union@, which is left-biased. 'MonoidalMap'
17+-- has @mappend = unionWith mappend@ instead.
18+module Data.AppendMap
19+ ( module Data.AppendMap
20+ , module Data.Map.Monoidal
21+ ) where
22+
23+import Prelude hiding (null)
1624
17−import Prelude hiding (map)
18−
19−import Control.Lens
20−import Data.Align
2125import Data.Coerce
2226import Data.Default
2327import Data.Map (Map)
24−import qualified Data.Map as Map
25−import Data.Semigroup
26−import Data.Set (Set)
27−import Data.Typeable
28−import GHC.Generics (Generic)
29−import Reflex.Class (FunctorMaybe (..))
30−import Reflex.Patch (Additive, Group (..))
31−
32−newtype AppendMap k m = AppendMap { _unAppendMap :: Map k m }
33− deriving (Eq, Ord, Show, Read, Typeable, Generic, Functor, Foldable, Traversable, Align)
34−
35−type instance (Index (AppendMap k m)) = k
36−type instance (IxValue (AppendMap k m)) = m
37−
38−instance Ord k => Ixed (AppendMap k m) where
39− ix i = _Wrapped . ix i
40−
41−instance Ord k => At (AppendMap k m) where
42− at i = _Wrapped . at i
43−
44−instance FunctorMaybe (AppendMap k) where
45− fmapMaybe = mapMaybe
28+#if MIN_VERSION_containers(0,5,11)
29+import qualified Data.Map.Internal.Debug as Map (showTree, showTreeWith)
30+#else
31+import qualified Data.Map as Map (showTree, showTreeWith)
32+#endif
33+import qualified Data.Witherable as W
34+import Data.Map.Monoidal
35+import qualified Data.Map.Monoidal as MonoidalMap
36+
37+
38+{-# DEPRECATED AppendMap "Use 'MonoidalMap' instead" #-}
39+-- | AppendMap is a synonym for 'Data.Map.Monoidal.MonoidalMap'
40+type AppendMap = MonoidalMap
41+
42+{-# DEPRECATED _unAppendMap "Use 'getMonoidalMap' instead" #-}
43+-- | A synonym for 'getMonoidalMap'
44+_unAppendMap :: MonoidalMap k v -> Map k v
45+_unAppendMap = getMonoidalMap
46+
47+-- | Pattern synonym for 'MonoidalMap'
48+pattern AppendMap :: Map k v -> MonoidalMap k v
49+pattern AppendMap m = MonoidalMap m
50+
51+#if !MIN_VERSION_witherable(0,3,2)
52+instance W.Filterable (MonoidalMap k) where
53+ mapMaybe = MonoidalMap.mapMaybe
54+#endif
4655
4756-- | Deletes a key, returning 'Nothing' if the result is empty.
48−nonEmptyDelete :: Ord k => k -> AppendMap k a -> Maybe (AppendMap k a)
57+nonEmptyDelete :: Ord k => k -> MonoidalMap k a -> Maybe (MonoidalMap k a)
4958nonEmptyDelete k vs =
5059 let deleted = delete k vs
51− in if Data.AppendMap.null deleted
60+ in if null deleted
5261 then Nothing
5362 else Just deleted
5463
64+-- | Like 'mapMaybe' but indicates whether the resulting container is empty
5565mapMaybeNoNull :: (a -> Maybe b)
56− -> AppendMap token a
57− -> Maybe (AppendMap token b)
66+ -> MonoidalMap token a
67+ -> Maybe (MonoidalMap token b)
5868mapMaybeNoNull f as =
59− let bs = fmapMaybe f as
60− in if Data.AppendMap.null bs
69+ let bs = mapMaybe f as
70+ in if null bs
6171 then Nothing
6272 else Just bs
6373
64−instance FunctorWithIndex k (AppendMap k) where
65− imap f = AppendMap . imap f . _unAppendMap
66− imapped = _Wrapped . imapped
67−
68−instance FoldableWithIndex k (AppendMap k) where
69− ifolded = _Wrapped . ifolded
70−
71−instance TraversableWithIndex k (AppendMap k) where
72− itraverse = itraverseOf itraversed
73− itraversed = _Wrapped . itraversed
74−
75−instance (Ord k, Semigroup m) => Semigroup (AppendMap k m) where
76− (AppendMap m0) <> (AppendMap m1) = AppendMap $ Map.unionWith (<>) m0 m1
77−
78−instance (Ord k, Semigroup m) => Monoid (AppendMap k m) where
79− mempty = empty
80− mappend = (<>)
81−
82−instance (Ord k, Group q) => Group (AppendMap k q) where
83− negateG = map negateG
84−
85−instance (Ord k, Additive q) => Additive (AppendMap k q)
86−
87−(!) :: forall k a. Ord k => AppendMap k a -> k -> a
88−(!) = coerce ((Map.!) :: Map k a -> k -> a)
89−infixl 9 !
90−
91−(\\) :: forall k a b. Ord k => AppendMap k a -> AppendMap k b -> AppendMap k a
92−(\\) = coerce ((Map.\\) :: Map k a -> Map k b -> Map k a)
93−infixl 9 \\
94−
95−null :: forall k a. AppendMap k a -> Bool
96−null = coerce (Map.null :: Map k a -> Bool)
97−
98−size :: forall k a. AppendMap k a -> Int
99−size = coerce (Map.size :: Map k a -> Int)
100−
101−member :: forall k a. Ord k => k -> AppendMap k a -> Bool
102−member = coerce (Map.member :: k -> Map k a -> Bool)
103−
104−notMember :: forall k a. Ord k => k -> AppendMap k a -> Bool
105−notMember = coerce (Map.notMember :: k -> Map k a -> Bool)
106−
107−lookup :: forall k a. Ord k => k -> AppendMap k a -> Maybe a
108−lookup = coerce (Map.lookup :: k -> Map k a -> Maybe a)
109−
110−findWithDefault :: forall k a. Ord k => a -> k -> AppendMap k a -> a
111−findWithDefault = coerce (Map.findWithDefault :: a -> k -> Map k a -> a)
112−
113−lookupLT :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
114−lookupLT = coerce (Map.lookupLT :: k -> Map k a -> Maybe (k,a))
115−
116−lookupGT :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
117−lookupGT = coerce (Map.lookupGT :: k -> Map k a -> Maybe (k,a))
118−
119−lookupLE :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
120−lookupLE = coerce (Map.lookupLE :: k -> Map k a -> Maybe (k,a))
121−
122−lookupGE :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
123−lookupGE = coerce (Map.lookupGE :: k -> Map k a -> Maybe (k,a))
124−
125−empty :: forall k a. AppendMap k a
126−empty = coerce (Map.empty :: Map k a)
127−
128−singleton :: forall k a. k -> a -> AppendMap k a
129−singleton = coerce (Map.singleton :: k -> a -> Map k a)
130−
131−insert :: forall k a. Ord k => k -> a -> AppendMap k a -> AppendMap k a
132−insert = coerce (Map.insert :: k -> a -> Map k a -> Map k a)
133−
134−insertWith :: forall k a. Ord k => (a -> a -> a) -> k -> a -> AppendMap k a -> AppendMap k a
135−insertWith = coerce (Map.insertWith :: (a -> a -> a) -> k -> a -> Map k a -> Map k a)
136−
137−insertWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> k -> a -> AppendMap k a -> AppendMap k a
138−insertWithKey = coerce (Map.insertWithKey :: (k -> a -> a -> a) -> k -> a -> Map k a -> Map k a)
139−
140−insertLookupWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> k -> a -> AppendMap k a -> (Maybe a, AppendMap k a)
141−insertLookupWithKey = coerce (Map.insertLookupWithKey :: (k -> a -> a -> a) -> k -> a -> Map k a -> (Maybe a, Map k a))
142−
143−delete :: forall k a. Ord k => k -> AppendMap k a -> AppendMap k a
144−delete = coerce (Map.delete :: k -> Map k a -> Map k a)
145−
146−adjust :: forall k a. Ord k => (a -> a) -> k -> AppendMap k a -> AppendMap k a
147−adjust = coerce (Map.adjust :: (a -> a) -> k -> Map k a -> Map k a)
148−
149−adjustWithKey :: forall k a. Ord k => (k -> a -> a) -> k -> AppendMap k a -> AppendMap k a
150−adjustWithKey = coerce (Map.adjustWithKey :: (k -> a -> a) -> k -> Map k a -> Map k a)
151−
152−update :: forall k a. Ord k => (a -> Maybe a) -> k -> AppendMap k a -> AppendMap k a
153−update = coerce (Map.update :: (a -> Maybe a) -> k -> Map k a -> Map k a)
154−
155−updateWithKey :: forall k a. Ord k => (k -> a -> Maybe a) -> k -> AppendMap k a -> AppendMap k a
156−updateWithKey = coerce (Map.updateWithKey :: (k -> a -> Maybe a) -> k -> Map k a -> Map k a)
157−
158−updateLookupWithKey :: forall k a. Ord k => (k -> a -> Maybe a) -> k -> AppendMap k a -> (Maybe a, AppendMap k a)
159−updateLookupWithKey = coerce (Map.updateLookupWithKey :: (k -> a -> Maybe a) -> k -> Map k a -> (Maybe a, Map k a))
160−
161−alter :: forall k a. Ord k => (Maybe a -> Maybe a) -> k -> AppendMap k a -> AppendMap k a
162−alter = coerce (Map.alter :: (Maybe a -> Maybe a) -> k -> Map k a -> Map k a)
163−
164−unionWith :: forall k a. Ord k => (a -> a -> a) -> AppendMap k a -> AppendMap k a -> AppendMap k a
165−unionWith = coerce (Map.unionWith :: (a -> a -> a) -> Map k a -> Map k a -> Map k a)
166−
167−unionWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> AppendMap k a -> AppendMap k a -> AppendMap k a
168−unionWithKey = coerce (Map.unionWithKey :: (k -> a -> a -> a) -> Map k a -> Map k a -> Map k a)
169−
170−unionsWith :: forall k a. Ord k => (a -> a -> a) -> [AppendMap k a] -> AppendMap k a
171−unionsWith = coerce (Map.unionsWith :: (a -> a -> a) -> [Map k a] -> Map k a)
172−
173−difference :: forall k a b. Ord k => AppendMap k a -> AppendMap k b -> AppendMap k a
174−difference = (\\)
175−
176−differenceWith :: forall k a b. Ord k => (a -> b -> Maybe a) -> AppendMap k a -> AppendMap k b -> AppendMap k a
177−differenceWith = coerce (Map.differenceWith :: (a -> b -> Maybe a) -> Map k a -> Map k b -> Map k a)
178−
179−differenceWithKey :: forall k a b. Ord k => (k -> a -> b -> Maybe a) -> AppendMap k a -> AppendMap k b -> AppendMap k a
180−differenceWithKey = coerce (Map.differenceWithKey :: (k -> a -> b -> Maybe a) -> Map k a -> Map k b -> Map k a)
181−
182−intersectionWith :: forall k a b c. Ord k => (a -> b -> c) -> AppendMap k a -> AppendMap k b -> AppendMap k c
183−intersectionWith = coerce (Map.intersectionWith :: (a -> b -> c) -> Map k a -> Map k b -> Map k c)
184−
185−intersectionWithKey :: forall k a b c. Ord k => (k -> a -> b -> c) -> AppendMap k a -> AppendMap k b -> AppendMap k c
186−intersectionWithKey = coerce (Map.intersectionWithKey :: (k -> a -> b -> c) -> Map k a -> Map k b -> Map k c)
187−
188−mergeWithKey :: forall k a b c. Ord k => (k -> a -> b -> Maybe c) -> (AppendMap k a -> AppendMap k c) -> (AppendMap k b -> AppendMap k c) -> AppendMap k a -> AppendMap k b -> AppendMap k c
189−mergeWithKey = coerce (Map.mergeWithKey :: (k -> a -> b -> Maybe c) -> (Map k a -> Map k c) -> (Map k b -> Map k c) -> Map k a -> Map k b -> Map k c)
190−
191−map :: (a -> b) -> AppendMap k a -> AppendMap k b
192−map = fmap
193−
194−mapWithKey :: (k -> a -> b) -> AppendMap k a -> AppendMap k b
195−mapWithKey = imap
196−
197−traverseWithKey :: Applicative t => (k -> a -> t b) -> AppendMap k a -> t (AppendMap k b)
198−traverseWithKey = itraverse
199−
200−mapAccum :: forall k a b c. (a -> b -> (a, c)) -> a -> AppendMap k b -> (a, AppendMap k c)
201−mapAccum = coerce (Map.mapAccum :: (a -> b -> (a, c)) -> a -> Map k b -> (a, Map k c))
202−
203−mapAccumWithKey :: forall k a b c. (a -> k -> b -> (a, c)) -> a -> AppendMap k b -> (a, AppendMap k c)
204−mapAccumWithKey = coerce (Map.mapAccumWithKey :: (a -> k -> b -> (a, c)) -> a -> Map k b -> (a, Map k c))
205−
206−mapAccumRWithKey :: forall k a b c. (a -> k -> b -> (a, c)) -> a -> AppendMap k b -> (a, AppendMap k c)
207−mapAccumRWithKey = coerce (Map.mapAccumRWithKey :: (a -> k -> b -> (a, c)) -> a -> Map k b -> (a, Map k c))
208−
209−mapKeys :: forall k1 k2 a. Ord k2 => (k1 -> k2) -> AppendMap k1 a -> AppendMap k2 a
210−mapKeys = coerce (Map.mapKeys :: (k1 -> k2) -> Map k1 a -> Map k2 a)
211−
212−mapKeysWith :: forall k1 k2 a. Ord k2 => (a -> a -> a) -> (k1 -> k2) -> AppendMap k1 a -> AppendMap k2 a
213−mapKeysWith = coerce (Map.mapKeysWith :: (a -> a -> a) -> (k1 -> k2) -> Map k1 a -> Map k2 a)
214−
215−mapKeysMonotonic :: forall k1 k2 a. (k1 -> k2) -> AppendMap k1 a -> AppendMap k2 a
216−mapKeysMonotonic = coerce (Map.mapKeysMonotonic :: (k1 -> k2) -> Map k1 a -> Map k2 a)
217−
218−foldr :: forall k a b. (a -> b -> b) -> b -> AppendMap k a -> b
219−foldr = coerce (Map.foldr :: (a -> b -> b) -> b -> Map k a -> b)
220−
221−foldl :: forall k a b. (a -> b -> a) -> a -> AppendMap k b -> a
222−foldl = coerce (Map.foldl :: (a -> b -> a) -> a -> Map k b -> a)
223−
224−foldrWithKey :: forall k a b. (k -> a -> b -> b) -> b -> AppendMap k a -> b
225−foldrWithKey = coerce (Map.foldrWithKey :: (k -> a -> b -> b) -> b -> Map k a -> b)
226−
227−foldlWithKey :: forall k a b. (a -> k -> b -> a) -> a -> AppendMap k b -> a
228−foldlWithKey = coerce (Map.foldlWithKey :: (a -> k -> b -> a) -> a -> Map k b -> a)
74+-- TODO: Move instances to `Data.Patch`
75+-- | Displays a 'MonoidalMap' as a tree. See 'Data.Map.Lazy.showTree' for details.
76+showTree :: forall k a. (Show k, Show a) => MonoidalMap k a -> String
77+showTree = coerce (Map.showTree :: Map k a -> String)
22978
230−foldMapWithKey :: forall k a m. Monoid m => (k -> a -> m) -> AppendMap k a -> m
231−foldMapWithKey = coerce (Map.foldMapWithKey :: Monoid m => (k -> a -> m) -> Map k a -> m)
232−
233−foldr' :: forall k a b. (a -> b -> b) -> b -> AppendMap k a -> b
234−foldr' = coerce (Map.foldr' :: (a -> b -> b) -> b -> Map k a -> b)
235−
236−foldl' :: forall k a b. (a -> b -> a) -> a -> AppendMap k b -> a
237−foldl' = coerce (Map.foldl' :: (a -> b -> a) -> a -> Map k b -> a)
238−
239−foldrWithKey' :: forall k a b. (k -> a -> b -> b) -> b -> AppendMap k a -> b
240−foldrWithKey' = coerce (Map.foldrWithKey' :: (k -> a -> b -> b) -> b -> Map k a -> b)
241−
242−foldlWithKey' :: forall k a b. (a -> k -> b -> a) -> a -> AppendMap k b -> a
243−foldlWithKey' = coerce (Map.foldlWithKey' :: (a -> k -> b -> a) -> a -> Map k b -> a)
244−
245−elems :: forall k a. AppendMap k a -> [a]
246−elems = coerce (Map.elems :: Map k a -> [a])
247−
248−keys :: forall k a. AppendMap k a -> [k]
249−keys = coerce (Map.keys :: Map k a -> [k])
250−
251−assocs :: forall k a. AppendMap k a -> [(k, a)]
252−assocs = coerce (Map.assocs :: Map k a -> [(k, a)])
253−
254−keysSet :: forall k a. AppendMap k a -> Set k
255−keysSet = coerce (Map.keysSet :: Map k a -> Set k)
256−
257−fromSet :: forall k a. (k -> a) -> Set k -> AppendMap k a
258−fromSet = coerce (Map.fromSet :: (k -> a) -> Set k -> Map k a)
259−
260−toList :: forall k a. AppendMap k a -> [(k, a)]
261−toList = coerce (Map.toList :: Map k a -> [(k, a)])
262−
263−fromList :: forall k a. Ord k => [(k, a)] -> AppendMap k a
264−fromList = coerce (Map.fromList :: [(k, a)] -> Map k a)
265−
266−fromListWith :: forall k a. Ord k => (a -> a -> a) -> [(k, a)] -> AppendMap k a
267−fromListWith = coerce (Map.fromListWith :: (a -> a -> a) -> [(k, a)] -> Map k a)
268−
269−fromListWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> [(k, a)] -> AppendMap k a
270−fromListWithKey = coerce (Map.fromListWithKey :: (k -> a -> a -> a) -> [(k, a)] -> Map k a)
271−
272−toAscList :: forall k a. AppendMap k a -> [(k, a)]
273−toAscList = coerce (Map.toAscList :: Map k a -> [(k, a)])
274−
275−toDescList :: forall k a. AppendMap k a -> [(k, a)]
276−toDescList = coerce (Map.toDescList :: Map k a -> [(k, a)])
277−
278−fromAscList :: forall k a. Eq k => [(k, a)] -> AppendMap k a
279−fromAscList = coerce (Map.fromAscList :: [(k, a)] -> Map k a)
280−
281−fromAscListWith :: forall k a. Eq k => (a -> a -> a) -> [(k, a)] -> AppendMap k a
282−fromAscListWith = coerce (Map.fromAscListWith :: (a -> a -> a) -> [(k, a)] -> Map k a)
283−
284−fromAscListWithKey :: forall k a. Eq k => (k -> a -> a -> a) -> [(k, a)] -> AppendMap k a
285−fromAscListWithKey = coerce (Map.fromAscListWithKey :: (k -> a -> a -> a) -> [(k, a)] -> Map k a)
286−
287−fromDistinctAscList :: forall k a. [(k, a)] -> AppendMap k a
288−fromDistinctAscList = coerce (Map.fromDistinctAscList :: [(k, a)] -> Map k a)
289−
290−filter :: forall k a. (a -> Bool) -> AppendMap k a -> AppendMap k a
291−filter = coerce (Map.filter :: (a -> Bool) -> Map k a -> Map k a)
292−
293−filterWithKey :: forall k a. (k -> a -> Bool) -> AppendMap k a -> AppendMap k a
294−filterWithKey = coerce (Map.filterWithKey :: (k -> a -> Bool) -> Map k a -> Map k a)
295−
296−partition :: forall k a. (a -> Bool) -> AppendMap k a -> (AppendMap k a, AppendMap k a)
297−partition = coerce (Map.partition :: (a -> Bool) -> Map k a -> (Map k a, Map k a))
298−
299−partitionWithKey :: forall k a. (k -> a -> Bool) -> AppendMap k a -> (AppendMap k a, AppendMap k a)
300−partitionWithKey = coerce (Map.partitionWithKey :: (k -> a -> Bool) -> Map k a -> (Map k a, Map k a))
301−
302−mapMaybe :: forall k a b. (a -> Maybe b) -> AppendMap k a -> AppendMap k b
303−mapMaybe = coerce (Map.mapMaybe :: (a -> Maybe b) -> Map k a -> Map k b)
304−
305−mapMaybeWithKey :: forall k a b. (k -> a -> Maybe b) -> AppendMap k a -> AppendMap k b
306−mapMaybeWithKey = coerce (Map.mapMaybeWithKey :: (k -> a -> Maybe b) -> Map k a -> Map k b)
307−
308−mapEither :: forall k a b c. (a -> Either b c) -> AppendMap k a -> (AppendMap k b, AppendMap k c)
309−mapEither = coerce (Map.mapEither :: (a -> Either b c) -> Map k a -> (Map k b, Map k c))
310−
311−mapEitherWithKey :: forall k a b c. (k -> a -> Either b c) -> AppendMap k a -> (AppendMap k b, AppendMap k c)
312−mapEitherWithKey = coerce (Map.mapEitherWithKey :: (k -> a -> Either b c) -> Map k a -> (Map k b, Map k c))
313−
314−split :: forall k a. Ord k => k -> AppendMap k a -> (AppendMap k a, AppendMap k a)
315−split = coerce (Map.split :: k -> Map k a -> (Map k a, Map k a))
316−
317−splitLookup :: forall k a. Ord k => k -> AppendMap k a -> (AppendMap k a, Maybe a, AppendMap k a)
318−splitLookup = coerce (Map.splitLookup :: k -> Map k a -> (Map k a, Maybe a, Map k a))
319−
320−splitRoot :: forall k a. AppendMap k a -> [AppendMap k a]
321−splitRoot = coerce (Map.splitRoot :: Map k a -> [Map k a])
322−
323−isSubmapOf :: forall k a. (Ord k, Eq a) => AppendMap k a -> AppendMap k a -> Bool
324−isSubmapOf = coerce (Map.isSubmapOf :: Map k a -> Map k a -> Bool)
325−
326−isSubmapOfBy :: forall k a b. Ord k => (a -> b -> Bool) -> AppendMap k a -> AppendMap k b -> Bool
327−isSubmapOfBy = coerce (Map.isSubmapOfBy :: (a -> b -> Bool) -> Map k a -> Map k b -> Bool)
328−
329−isProperSubmapOf :: forall k a. (Ord k, Eq a) => AppendMap k a -> AppendMap k a -> Bool
330−isProperSubmapOf = coerce (Map.isProperSubmapOf :: Map k a -> Map k a -> Bool)
331−
332−isProperSubmapOfBy :: forall k a b. Ord k => (a -> b -> Bool) -> AppendMap k a -> AppendMap k b -> Bool
333−isProperSubmapOfBy = coerce (Map.isProperSubmapOfBy :: (a -> b -> Bool) -> Map k a -> Map k b -> Bool)
334−
335−lookupIndex :: forall k a. Ord k => k -> AppendMap k a -> Maybe Int
336−lookupIndex = coerce (Map.lookupIndex :: k -> Map k a -> Maybe Int)
337−
338−findIndex :: forall k a. Ord k => k -> AppendMap k a -> Int
339−findIndex = coerce (Map.findIndex :: k -> Map k a -> Int)
340−
341−elemAt :: forall k a. Int -> AppendMap k a -> (k, a)
342−elemAt = coerce (Map.elemAt :: Int -> Map k a -> (k, a))
343−
344−updateAt :: forall k a. (k -> a -> Maybe a) -> Int -> AppendMap k a -> AppendMap k a
345−updateAt = coerce (Map.updateAt :: (k -> a -> Maybe a) -> Int -> Map k a -> Map k a)
346−
347−deleteAt :: forall k a. Int -> AppendMap k a -> AppendMap k a
348−deleteAt = coerce (Map.deleteAt :: Int -> Map k a -> Map k a)
349−
350−findMin :: forall k a. AppendMap k a -> (k, a)
351−findMin = coerce (Map.findMin :: Map k a -> (k, a))
352−
353−findMax :: forall k a. AppendMap k a -> (k, a)
354−findMax = coerce (Map.findMax :: Map k a -> (k, a))
355−
356−deleteMin :: forall k a. AppendMap k a -> AppendMap k a
357−deleteMin = coerce (Map.deleteMin :: Map k a -> Map k a)
358−
359−deleteMax :: forall k a. AppendMap k a -> AppendMap k a
360−deleteMax = coerce (Map.deleteMax :: Map k a -> Map k a)
361−
362−deleteFindMin :: forall k a. AppendMap k a -> ((k, a), AppendMap k a)
363−deleteFindMin = coerce (Map.deleteFindMin :: Map k a -> ((k, a), Map k a))
364−
365−deleteFindMax :: forall k a. AppendMap k a -> ((k, a), AppendMap k a)
366−deleteFindMax = coerce (Map.deleteFindMax :: Map k a -> ((k, a), Map k a))
367−
368−updateMin :: forall k a. (a -> Maybe a) -> AppendMap k a -> AppendMap k a
369−updateMin = coerce (Map.updateMin :: (a -> Maybe a) -> Map k a -> Map k a)
370−
371−updateMax :: forall k a. (a -> Maybe a) -> AppendMap k a -> AppendMap k a
372−updateMax = coerce (Map.updateMax :: (a -> Maybe a) -> Map k a -> Map k a)
373−
374−updateMinWithKey :: forall k a. (k -> a -> Maybe a) -> AppendMap k a -> AppendMap k a
375−updateMinWithKey = coerce (Map.updateMinWithKey :: (k -> a -> Maybe a) -> Map k a -> Map k a)
376−
377−updateMaxWithKey :: forall k a. (k -> a -> Maybe a) -> AppendMap k a -> AppendMap k a
378−updateMaxWithKey = coerce (Map.updateMaxWithKey :: (k -> a -> Maybe a) -> Map k a -> Map k a)
379−
380−minView :: forall k a. AppendMap k a -> Maybe (a, AppendMap k a)
381−minView = coerce (Map.minView :: Map k a -> Maybe (a, Map k a))
382−
383−maxView :: forall k a. AppendMap k a -> Maybe (a, AppendMap k a)
384−maxView = coerce (Map.maxView :: Map k a -> Maybe (a, Map k a))
385−
386−minViewWithKey :: forall k a. AppendMap k a -> Maybe ((k, a), AppendMap k a)
387−minViewWithKey = coerce (Map.minViewWithKey :: Map k a -> Maybe ((k, a), Map k a))
388−
389−maxViewWithKey :: forall k a. AppendMap k a -> Maybe ((k, a), AppendMap k a)
390−maxViewWithKey = coerce (Map.maxViewWithKey :: Map k a -> Maybe ((k, a), Map k a))
391−
392−showTree :: forall k a. (Show k, Show a) => AppendMap k a -> String
393−showTree = coerce (Map.showTree :: (Show k, Show a) => Map k a -> String)
394−
395−showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> AppendMap k a -> String
79+-- | Displays a 'MonoidalMap' as a tree, using the supplied function to convert nodes to string.
80+showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> MonoidalMap k a -> String
39681showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
39782
398−valid :: forall k a. Ord k => AppendMap k a -> Bool
399−valid = coerce (Map.valid :: Ord k => Map k a -> Bool)
400−
401−instance Default (AppendMap k a) where
83+instance Default (MonoidalMap k a) where
40284 def = empty
403−
404−instance AppendMap k' v' ~ t => Rewrapped (AppendMap k a) t
405−
406−instance Wrapped (AppendMap k a) where
407− type Unwrapped (AppendMap k a) = Map k a
408− _Wrapped' = iso (\(AppendMap m) -> m) AppendMap
src/Data/FastMutableIntMap.hs+26−9
@@ -1,8 +1,9 @@
1−{-# LANGUAGE DeriveFunctor #-}
2−{-# LANGUAGE DeriveFoldable #-}
3−{-# LANGUAGE DeriveTraversable #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
51{-# LANGUAGE TypeFamilies #-}
2+-- |
3+-- Module:
4+-- Data.FastMutableIntMap
5+-- Description:
6+-- A mutable version of 'IntMap'
67module Data.FastMutableIntMap
78 ( FastMutableIntMap
89 , new
@@ -20,49 +21,60 @@ module Data.FastMutableIntMap
2021 , patchIntMapNewElements
2122 , patchIntMapNewElementsMap
2223 , getDeletions
24+ , toList
2325 ) where
2426
2527--TODO: Pure JS version
2628--TODO: Fast copy to FastIntMap
2729--TODO: Fast patch type
2830
31+import Prelude hiding (lookup)
32+
2933import Control.Monad.IO.Class
3034import Data.Foldable (traverse_)
31−import Data.IORef
3235import Data.IntMap.Strict (IntMap)
3336import qualified Data.IntMap.Strict as IntMap
34−import Data.Maybe
35−import Prelude hiding (lookup)
36−import Reflex.Patch.Class
37−import Reflex.Patch.IntMap
37+import Data.IORef
38+import Data.Patch.Class
39+import Data.Patch.IntMap
3840
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.
3943newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
4044
45+-- | Create a new 'FastMutableIntMap' out of an 'IntMap'
4146new :: IntMap a -> IO (FastMutableIntMap a)
4247new m = FastMutableIntMap <$> newIORef m
4348
49+-- | Create a new empty 'FastMutableIntMap'
4450newEmpty :: IO (FastMutableIntMap a)
4551newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
4652
53+-- | Insert an element into a 'FastMutableIntMap' at the given key
4754insert :: FastMutableIntMap a -> Int -> a -> IO ()
4855insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
4956
57+-- | Attempt to lookup an element by key in a 'FastMutableIntMap'
5058lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
5159lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
5260
61+-- | Runs the provided action over the intersection of a 'FastMutableIntMap' and an 'IntMap'
5362forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
5463forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
5564 a <- liftIO $ readIORef r
5665 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
5766
67+-- | Runs the provided action over the values of a 'FastMutableIntMap'
5868for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
5969for_ (FastMutableIntMap r) f = do
6070 a <- liftIO $ readIORef r
6171 traverse_ f a
6272
73+-- | Checks whether a 'FastMutableIntMap' is empty
6374isEmpty :: FastMutableIntMap a -> IO Bool
6475isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
6576
77+-- | Retrieves the size of a 'FastMutableIntMap'
6678size :: FastMutableIntMap a -> IO Int
6779size (FastMutableIntMap r) = IntMap.size <$> readIORef r
6880
@@ -73,8 +85,13 @@ getFrozenAndClear (FastMutableIntMap r) = do
7385 writeIORef r IntMap.empty
7486 return result
7587
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.
7690applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
7791applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
7892 v <- readIORef r
7993 writeIORef r $! applyAlways p v
8094 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+16−12
@@ -18,6 +18,7 @@ module Data.FastWeakBag
1818 , isEmpty
1919 , insert
2020 , traverse
21+ , traverse_
2122 , remove
2223 -- * Internal functions
2324 -- These will not always be available.
@@ -26,32 +27,31 @@ module Data.FastWeakBag
2627#endif
2728 ) where
2829
29−import Control.Monad hiding (forM_, mapM_)
30+import Prelude hiding (traverse)
31+
32+import Control.Monad
3033import Control.Monad.IO.Class
3134
3235#ifdef GHCJS_FAST_WEAK
3336import GHCJS.Types
34−import Reflex.FastWeak (unsafeFromRawJSVal, unsafeToRawJSVal, js_isNull)
37+import Reflex.FastWeak (js_isNull, unsafeFromRawJSVal, unsafeToRawJSVal)
3538#else
3639import Control.Exception
37−import Data.Foldable (forM_, mapM_)
3840import Data.IntMap.Strict (IntMap)
3941import qualified Data.IntMap.Strict as IntMap
4042import Data.IORef
4143import System.Mem.Weak
4244#endif
4345
44−import Prelude hiding (mapM_, traverse)
45−
46−-- | A @FastWeakBag a@ holds a set of values of type @a@, but does not retain them -
47−-- that is, they can still be garbage-collected. As long as the @a@s remain
46+-- | A 'FastWeakBag' holds a set of values of type @/a/@, but does not retain them -
47+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
4848-- alive, the 'FastWeakBag' will continue to refer to them.
4949#ifdef GHCJS_FAST_WEAK
5050newtype FastWeakBag a = FastWeakBag JSVal
5151#else
5252data FastWeakBag a = FastWeakBag
5353 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
54− , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a)))
54+ , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a))) -- ^ Map of items contained by the 'FastWeakBag'
5555 }
5656#endif
5757
@@ -117,14 +117,14 @@ foreign import javascript unsafe "(function(){ for(var i = 0; i < $1.tickets.len
117117isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
118118#endif
119119
120−{-# INLINE traverse #-}
120+{-# INLINE traverse_ #-}
121121-- | Visit every node in the given list. If new nodes are appended during the
122122-- traversal, they will not be visited. Every live node that was in the list
123123-- when the traversal began will be visited exactly once; however, no guarantee
124124-- is made about the order of the traversal.
125−traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
125+traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
126126#ifdef GHCJS_FAST_WEAK
127−traverse wb f = do
127+traverse_ wb f = do
128128 let go cursor = when (not $ js_isNull cursor) $ do
129129 val <- liftIO $ js_getTicketValue cursor
130130 f $ unsafeFromRawJSVal val
@@ -135,13 +135,17 @@ foreign import javascript unsafe "$r = $1.val;" js_getTicketValue :: JSVal -> IO
135135--TODO: Fix the race condition where if a cursor is deleted (presumably using 'remove', below) while we're holding it, it can't find its way back to the correct bag
136136foreign import javascript unsafe "(function(){ for(var i = $1.pos - 1; i >= 0; i--) { if($1.bag.tickets[i] !== null) { return $1.bag.tickets[i]; } }; return null; })()" js_getNext :: FastWeakBagTicket a -> IO JSVal --TODO: Clean up as we go along so this isn't O(n) every time -- Result can be null or a FastWeakBagTicket a
137137#else
138−traverse (FastWeakBag _ children) f = {-# SCC "traverse" #-} do
138+traverse_ (FastWeakBag _ children) f = {-# SCC "traverse_" #-} do
139139 cs <- liftIO $ readIORef children
140140 forM_ cs $ \c -> do
141141 ma <- liftIO $ deRefWeak c
142142 mapM_ f ma
143143#endif
144144
145+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
146+traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
147+traverse = traverse_
148+
145149-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
146150-- on the same 'FastWeakBagTicket'.
147151{-# INLINE remove #-}
src/Data/Functor/Misc.hsdeleted−363
@@ -1,363 +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−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
88− gshowToShow (Const2 _) = id
89−#else
90− gshowsPrec n x@(Const2 _) = showsPrec n x
91−#endif
92−
93−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
94−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
95− showTagToShow (Const2 _) _ = id
96−#else
97− showTaggedPrec (Const2 _) = showsPrec
98−#endif
99−
100−instance Eq k => GEq (Const2 k v) where
101−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
102− geqToEq _ = id
103− geqUnify (Const2 _) (Const2 _) _ = id
104−#else
105− geq (Const2 a) (Const2 b) =
106− if a == b
107− then Just Refl
108− else Nothing
109−#endif
110−
111−instance Ord k => GCompare (Const2 k v) where
112−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
113− gcompareToOrd (Const2 _) = id
114− gcompare (Const2 a) (Const2 b) = strengthenOrdering $ compare a b
115−#else
116− gcompare (Const2 a) (Const2 b) = case compare a b of
117− LT -> GLT
118− EQ -> GEQ
119− GT -> GGT
120−#endif
121−
122−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
123−instance {-# INCOHERENT #-} (Eq k, Eq v) => EqTag (Const2 k v) Identity where
124− eqTagToEq (Const2 _) _ = id
125−
126−instance {-# INCOHERENT #-} Eq k => EqTag (Const2 k v) (Const2 k v) where
127− eqTagToEq (Const2 _) _ = id
128−#endif
129−
130−-- | Convert a 'DMap' to a regular 'Map'
131−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
132−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
133−
134−-- | Convert a 'DMap' to an 'IntMap'
135−dmapToIntMap :: DMap (Const2 IntMap.Key v) Identity -> IntMap v
136−dmapToIntMap = IntMap.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
137−
138−-- | Convert a 'DMap' to a regular 'Map', applying the given function to remove
139−-- the wrapping 'Functor'
140−dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
141−dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
142−
143−-- | Convert a regular 'Map' to a 'DMap'
144−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
145−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
146−
147−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
148−-- to a 'DMap'
149−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
150−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
151−
152−-- | Convert a regular 'IntMap', where the values are already wrapped in a
153−-- functor, to a 'DMap'
154−intMapWithFunctorToDMap :: IntMap (f v) -> DMap (Const2 IntMap.Key v) f
155−intMapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . IntMap.toAscList
156−
157−-- | Convert a 'DMap' to a regular 'Map' by forgetting the types associated with
158−-- the keys, using a function to remove the wrapping 'Functor'
159−weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
160−weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (Some.This k, f v)) . DMap.toAscList
161−
162−--------------------------------------------------------------------------------
163−-- WrapArg
164−--------------------------------------------------------------------------------
165−
166−-- | 'WrapArg' can be used to tag a value in one functor with a type
167−-- representing another functor. This was primarily used with dependent-map <
168−-- 0.2, in which the value type was not wrapped in a separate functor.
169−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
170− WrapArg :: f a -> WrapArg g f (g a)
171−
172−deriving instance Eq (f a) => Eq (WrapArg g f (g' a))
173−deriving instance Ord (f a) => Ord (WrapArg g f (g' a))
174−deriving instance Show (f a) => Show (WrapArg g f (g' a))
175−deriving instance Read (f a) => Read (WrapArg g f (g a))
176−
177−instance GEq f => GEq (WrapArg g f) where
178−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
179− geqToEq (WrapArg f) = geqToEq f
180− geqUnify (WrapArg a) (WrapArg b) = geqUnify a b
181−#else
182− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
183−#endif
184−
185−instance GCompare f => GCompare (WrapArg g f) where
186−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
187− gcompareToOrd (WrapArg f) = gcompareToOrd f
188−#endif
189− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
190− GLT -> GLT
191− GEQ -> GEQ
192− GGT -> GGT
193−
194−--------------------------------------------------------------------------------
195−-- Convenience functions for DMap
196−--------------------------------------------------------------------------------
197−
198−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
199−-- well as the value. The provided function MUST preserve the ordering of the
200−-- keys, or the resulting 'DMap' will be malformed.
201−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
202−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
203−
204−{-# INLINE combineDMapsWithKey #-}
205−-- | Union two 'DMap's of different types, yielding another type. Each key that
206−-- is present in either input map will be present in the output.
207−combineDMapsWithKey :: forall f g h i.
208− GCompare f
209− => (forall a. f a -> These (g a) (h a) -> i a)
210− -> DMap f g
211− -> DMap f h
212− -> DMap f i
213−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
214− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
215− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
216− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
217− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
218− GLT -> (gk :=> f gk (This gv)) : go gs' hs
219− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
220− GGT -> (hk :=> f hk (That hv)) : go gs hs'
221−
222−-- | Extract the values of a 'DMap' of 'EitherTag's.
223−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
224−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
225− (Nothing, Nothing) -> Nothing
226− (Just (Identity a), Nothing) -> Just $ This a
227− (Nothing, Just (Identity b)) -> Just $ That b
228− (Just (Identity a), Just (Identity b)) -> Just $ These a b
229−
230−-- | Tag type for 'Either' to use it as a 'DSum'.
231−data EitherTag l r a where
232− LeftTag :: EitherTag l r l
233− RightTag :: EitherTag l r r
234− deriving (Typeable)
235−
236−deriving instance Show (EitherTag l r a)
237−deriving instance Eq (EitherTag l r a)
238−deriving instance Ord (EitherTag l r a)
239−
240−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
241−instance {-# INCOHERENT #-} (Show (f l), Show (f r)) => ShowTag (EitherTag l r) f where
242− showTagToShow e _ = case e of
243− LeftTag -> id
244− RightTag -> id
245−
246−instance {-# INCOHERENT #-} (Eq (f l), Eq (f r)) => EqTag (EitherTag l r) f where
247− eqTagToEq e _ = case e of
248− LeftTag -> id
249− RightTag -> id
250−#endif
251−
252−instance GEq (EitherTag l r) where
253−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
254− geqToEq _ = id
255− geqUnify LeftTag LeftTag _ same = same
256− geqUnify RightTag RightTag _ same = same
257− geqUnify _ _ unknown _ = unknown
258−#endif
259− geq a b = case (a, b) of
260− (LeftTag, LeftTag) -> Just Refl
261− (RightTag, RightTag) -> Just Refl
262− _ -> Nothing
263−
264−instance GCompare (EitherTag l r) where
265−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
266− gcompareToOrd _ = id
267−#endif
268− gcompare a b = case (a, b) of
269− (LeftTag, LeftTag) -> GEQ
270− (LeftTag, RightTag) -> GLT
271− (RightTag, LeftTag) -> GGT
272− (RightTag, RightTag) -> GEQ
273−
274−instance GShow (EitherTag l r) where
275−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
276− gshowToShow _ = id
277−#else
278− gshowsPrec _ a = case a of
279− LeftTag -> showString "LeftTag"
280− RightTag -> showString "RightTag"
281−#endif
282−
283−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
284−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
285− showTagToShow t _ = case t of
286− LeftTag -> id
287− RightTag -> id
288−#else
289− showTaggedPrec t n (Identity a) = case t of
290− LeftTag -> showsPrec n a
291− RightTag -> showsPrec n a
292−#endif
293−
294−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
295−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
296−eitherToDSum = \case
297− Left a -> (LeftTag :=> Identity a)
298− Right b -> (RightTag :=> Identity b)
299−
300−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
301−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
302−dsumToEither = \case
303− (LeftTag :=> Identity a) -> Left a
304− (RightTag :=> Identity b) -> Right b
305−
306−--------------------------------------------------------------------------------
307−-- ComposeMaybe
308−--------------------------------------------------------------------------------
309−
310−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
311−-- make the 'f' parameter have a nominal type role. We need f to be
312−-- representational so that we can use safe 'coerce'.
313−#if MIN_VERSION_transformers(5,2,0)
314−newtype ComposeMaybe f a =
315−#else
316−newtype ComposeMaybe (f :: * -> *) (a :: *) =
317−#endif
318− ComposeMaybe { getComposeMaybe :: Maybe (f a) } deriving (Show, Eq, Ord)
319−
320−deriving instance Functor f => Functor (ComposeMaybe f)
321−
322−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
323−instance {-# INCOHERENT #-} EqTag f g => EqTag f (ComposeMaybe g) where
324− eqTagToEq f _ = eqTagToEq f (Proxy :: Proxy g)
325−
326−instance {-# INCOHERENT #-} GShow k => ShowTag k (ComposeMaybe k) where
327− showTagToShow k _ r = gshowToShow k (showTagToShow k (Proxy :: Proxy k) r)
328−#endif
329−--------------------------------------------------------------------------------
330−-- Deprecated functions
331−--------------------------------------------------------------------------------
332−
333−{-# INLINE sequenceDmap #-}
334−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ -> fmap Identity)' instead" #-}
335−-- | Run the actions contained in the 'DMap'
336−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
337−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
338−
339−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
340−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
341−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
342−wrapDMap f = DMap.map $ f . runIdentity
343−
344−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
345−-- | Replace one functor for a 'DMap''s values with a different functor
346−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
347−rewrapDMap = DMap.map
348−
349−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
350−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
351−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
352−unwrapDMap f = DMap.map $ Identity . f
353−
354−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
355−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
356−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
357−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
358−
359−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
360−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
361−-- underlying functor
362−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
363−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
src/Data/Map/Misc.hs+27−11
@@ -1,5 +1,6 @@
11{-# LANGUAGE LambdaCase #-}
2−module Data.Map.Misc
2+-- | Additional functions for manipulating 'Map's.
3+module Data.Map.Misc
34 (
45 -- * Working with Maps
56 diffMapNoEq
@@ -10,7 +11,6 @@ module Data.Map.Misc
1011 ) where
1112
1213import Data.Align
13−import Data.Either
1414import Data.Map (Map)
1515import qualified Data.Map as Map
1616import Data.Maybe
@@ -18,12 +18,21 @@ import Data.Set (Set)
1818import qualified Data.Set as Set
1919import Data.These
2020
21+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new@ respectively. @Just@ represents an association present in @new@ and @Nothing@
22+-- represents an association only present in @old@ but no longer present in @new@.
23+--
24+-- Similar to 'diffMap' but doesn't require 'Eq' on the values, thus can't tell if a value has changed or not.
2125diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
2226diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
2327 This _ -> Just Nothing
2428 These _ new -> Just $ Just new
2529 That new -> Just $ Just new
2630
31+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new respectively. @Just@ represents an association present in @new@ and either not
32+-- present in @old@ or where the value has changed. @Nothing@ represents an association only present in @old@ but no longer present in @new@.
33+--
34+-- See also 'diffMapNoEq' for a similar but weaker version which does not require 'Eq' on the values but thus can't indicated a value not changing between
35+-- @old@ and @new@ with @Nothing@.
2736diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
2837diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
2938 This _ -> Just Nothing
@@ -32,23 +41,30 @@ diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
3241 | otherwise -> Just $ Just new
3342 That new -> Just $ Just new
3443
44+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new map from the given input @'Map' k v@.
45+--
46+-- See also 'Data.Patch.Map' and 'Data.Patch.MapWithMove'.
3547applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
3648applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
37− where (deletions, insertions) = mapPartitionEithers $ maybeToEither <$> patch
49+ where (deletions, insertions) = Map.mapEither maybeToEither patch
3850 maybeToEither = \case
3951 Nothing -> Left ()
4052 Just r -> Right r
4153
54+-- |Split a @'Map' k (Either a b)@ into @Map k a@ and @Map k b@, equivalent to @'Map.mapEither' id@
55+{-# DEPRECATED mapPartitionEithers "Use 'mapEither' instead" #-}
4256mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
43−mapPartitionEithers m = (fromLeft <$> ls, fromRight <$> rs)
44− where (ls, rs) = Map.partition isLeft m
45− fromLeft (Left l) = l
46− fromLeft _ = error "mapPartitionEithers: fromLeft received a Right value; this should be impossible"
47− fromRight (Right r) = r
48− fromRight _ = error "mapPartitionEithers: fromRight received a Left value; this should be impossible"
57+mapPartitionEithers = Map.mapEither id
4958
50−-- | Apply a map patch to a set
51−-- > applyMapKeysSet patch (Map.keysSet m) == Map.keysSet (applyMap patch m)
59+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new @'Set' k@ from the given input set.
60+--
61+-- Equivalent to:
62+--
63+-- @
64+-- applyMapKeysSet patch ('Map.keysSet' m) == 'Map.keysSet' ('applyMap' patch m)
65+-- @
66+--
67+-- but avoids the intervening @Map@ and needs no values.
5268applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
5369applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
5470 where (insertions, deletions) = Map.partition isJust patch
src/Data/WeakBag.hs+13−11
@@ -15,25 +15,25 @@ module Data.WeakBag
1515 , singleton
1616 , insert
1717 , traverse
18+ , traverse_
1819 , remove
1920 -- * Internal functions
2021 -- These will not always be available.
2122 , _weakBag_children --TODO: Don't export this
2223 ) where
2324
25+import Prelude hiding (traverse)
26+
2427import Control.Exception
25−import Control.Monad hiding (forM_, mapM_)
28+import Control.Monad
2629import Control.Monad.IO.Class
27−import Data.Foldable (forM_, mapM_)
2830import Data.IntMap.Strict (IntMap)
2931import qualified Data.IntMap.Strict as IntMap
3032import Data.IORef
3133import System.Mem.Weak
3234
33−import Prelude hiding (mapM_, traverse)
34−
35−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
36−-- that is, they can still be garbage-collected. As long as the @a@s remain
35+-- | A 'WeakBag' holds a set of values of type @/a/@, but does not retain them -
36+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
3737-- alive, the 'WeakBag' will continue to refer to them.
3838data WeakBag a = WeakBag
3939 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
@@ -72,8 +72,6 @@ insert a (WeakBag nextId children) wbRef finalizer = {-# SCC "insert" #-} do
7272 let !csWithoutMe = IntMap.delete myId cs
7373 in (csWithoutMe, csWithoutMe)
7474 when (IntMap.null csWithoutMe) $ finalizer b
75− return ()
76− return ()
7775 wa <- mkWeakPtr a' $ Just cleanup
7876 atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
7977 return $ WeakBagTicket
@@ -102,18 +100,22 @@ singleton a wbRef finalizer = {-# SCC "singleton" #-} do
102100 ticket <- insert a bag wbRef finalizer
103101 return (bag, ticket)
104102
105−{-# INLINE traverse #-}
103+{-# INLINE traverse_ #-}
106104-- | Visit every node in the given list. If new nodes are appended during the
107105-- traversal, they will not be visited. Every live node that was in the list
108106-- when the traversal began will be visited exactly once; however, no guarantee
109107-- is made about the order of the traversal.
110−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
111−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
108+traverse_ :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
109+traverse_ (WeakBag _ children) f = {-# SCC "traverse" #-} do
112110 cs <- liftIO $ readIORef children
113111 forM_ cs $ \c -> do
114112 ma <- liftIO $ deRefWeak c
115113 mapM_ f ma
116114
115+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
116+traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
117+traverse = traverse_
118+
117119-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
118120-- on the same 'WeakBagTicket'.
119121{-# INLINE remove #-}
src/Reflex.hs+8−2
@@ -6,14 +6,20 @@ module Reflex
66 ) where
77
88import Reflex.Class as X
9+import Reflex.Adjustable.Class as X
10+import Reflex.BehaviorWriter.Base as X
11+import Reflex.BehaviorWriter.Class as X
912import Reflex.Collection as X
10−import Reflex.EventWriter as X
1113import Reflex.Dynamic as X
14+import Reflex.EventWriter.Base as X
15+import Reflex.EventWriter.Class as X
1216#ifdef USE_TEMPLATE_HASKELL
1317import Reflex.Dynamic.TH as X
1418#endif
1519import Reflex.Dynamic.Uniq as X
16−import Reflex.DynamicWriter as X
20+import Reflex.DynamicWriter.Base as X
21+import Reflex.DynamicWriter.Class as X
22+import Reflex.NotReady.Class as X
1723import Reflex.PerformEvent.Base as X
1824import Reflex.PerformEvent.Class as X
1925import Reflex.PostBuild.Base as X
src/Reflex/Adjustable/Class.hs+89−115
@@ -1,50 +1,46 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE RankNTypes #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FunctionalDependencies #-}
35{-# LANGUAGE LambdaCase #-}
4−{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE RankNTypes #-}
57{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE FlexibleInstances #-}
98{-# LANGUAGE TypeFamilies #-}
109{-# LANGUAGE UndecidableInstances #-}
1110#ifdef USE_REFLEX_OPTIMIZER
1211{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1312#endif
14−module Reflex.Adjustable.Class
15− (
13+-- |
14+-- Module:
15+-- Reflex.Adjustable.Class
16+-- Description:
17+-- A class for actions that can be "adjusted" over time based on some 'Event'
18+-- such that, when observed after the firing of any such 'Event', the result
19+-- is as though the action was originally run with the 'Event's value.
20+module Reflex.Adjustable.Class
21+ (
1622 -- * The Adjustable typeclass
1723 Adjustable(..)
1824 , sequenceDMapWithAdjust
1925 , sequenceDMapWithAdjustWithMove
2026 , mapMapWithAdjustWithMove
21− -- * Widgets on Collections
22− , listHoldWithKey
23− , listWithKey
24− , listWithKey'
25− , listWithKeyShallowDiff
26− , listViewWithKey
27− , selectViewListWithKey
28− , selectViewListWithKey_
29− -- * List Utils
30− , list
31− , simpleList
27+ -- * Deprecated aliases
28+ , MonadAdjust
3229 ) where
3330
34−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
35−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
36−import Data.Align
37−import Data.Map (Map)
38−import qualified Data.Map as Map
39−import Data.Dependent.Map (DMap, GCompare (..))
31+import Control.Monad.Identity
32+import Control.Monad.Reader
33+import Data.Dependent.Map (DMap)
34+import Data.GADT.Compare (GCompare(..))
35+import qualified Data.Dependent.Map as DMap
4036import Data.Functor.Constant
4137import Data.Functor.Misc
42−import Data.Map.Misc
43−import Data.These
38+import Data.IntMap.Strict (IntMap)
39+import qualified Data.IntMap.Strict as IntMap
40+import Data.Map (Map)
4441
4542import Reflex.Class
46−import Reflex.Dynamic
47−import Reflex.PostBuild.Class
43+import Data.Patch.DMapWithMove
4844
4945-- | A 'Monad' that supports adjustment over time. After an action has been
5046-- run, if the given events fire, it will adjust itself so that its net effect
@@ -53,10 +49,43 @@ import Reflex.PostBuild.Class
5349-- other side-effects) cannot be undone, so it is up to the instance implementer
5450-- to determine what the best meaning for this class is in such cases.
5551class (Reflex t, Monad m) => Adjustable t m | m -> t where
56− runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
57− traverseIntMapWithKeyWithAdjust :: (IntMap.Key -> v -> m v') -> IntMap v -> Event t (PatchIntMap v) -> m (IntMap v', Event t (PatchIntMap v'))
58− traverseDMapWithKeyWithAdjust :: GCompare k => (forall a. k a -> v a -> m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> m (DMap k v', Event t (PatchDMap k v'))
59− traverseDMapWithKeyWithAdjustWithMove :: GCompare k => (forall a. k a -> v a -> m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> m (DMap k v', Event t (PatchDMapWithMove k v'))
52+ runWithReplace
53+ :: m a
54+ -> Event t (m b)
55+ -> m (a, Event t b)
56+
57+ traverseIntMapWithKeyWithAdjust
58+ :: (IntMap.Key -> v -> m v')
59+ -> IntMap v
60+ -> Event t (PatchIntMap v)
61+ -> m (IntMap v', Event t (PatchIntMap v'))
62+
63+ traverseDMapWithKeyWithAdjust
64+ :: GCompare k
65+ => (forall a. k a -> v a -> m (v' a))
66+ -> DMap k v
67+ -> Event t (PatchDMap k v)
68+ -> m (DMap k v', Event t (PatchDMap k v'))
69+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
70+ traverseDMapWithKeyWithAdjust f dm0 dm' = fmap (fmap (fmap fromPatchWithMove)) $
71+ traverseDMapWithKeyWithAdjustWithMove f dm0 $ fmap toPatchWithMove dm'
72+ where
73+ toPatchWithMove (PatchDMap m) = PatchDMapWithMove $ DMap.map toNodeInfoWithMove m
74+ toNodeInfoWithMove = \case
75+ ComposeMaybe (Just v) -> NodeInfo (From_Insert v) $ ComposeMaybe Nothing
76+ ComposeMaybe Nothing -> NodeInfo From_Delete $ ComposeMaybe Nothing
77+ fromPatchWithMove (PatchDMapWithMove m) = PatchDMap $ DMap.map fromNodeInfoWithMove m
78+ fromNodeInfoWithMove (NodeInfo from _) = ComposeMaybe $ case from of
79+ From_Insert v -> Just v
80+ From_Delete -> Nothing
81+ From_Move _ -> error "traverseDMapWithKeyWithAdjust: implementation of traverseDMapWithKeyWithAdjustWithMove inserted spurious move"
82+
83+ traverseDMapWithKeyWithAdjustWithMove
84+ :: GCompare k
85+ => (forall a. k a -> v a -> m (v' a))
86+ -> DMap k v
87+ -> Event t (PatchDMapWithMove k v)
88+ -> m (DMap k v', Event t (PatchDMapWithMove k v'))
6089
6190instance Adjustable t m => Adjustable t (ReaderT r m) where
6291 runWithReplace a0 a' = do
@@ -72,95 +101,40 @@ instance Adjustable t m => Adjustable t (ReaderT r m) where
72101 r <- ask
73102 lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
74103
75−sequenceDMapWithAdjust :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
104+-- | Traverse a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
105+-- to the 'DMap' can add, remove, or update values.
106+sequenceDMapWithAdjust
107+ :: (GCompare k, Adjustable t m)
108+ => DMap k m
109+ -> Event t (PatchDMap k m)
110+ -> m (DMap k Identity, Event t (PatchDMap k Identity))
76111sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
77112
78−sequenceDMapWithAdjustWithMove :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
113+-- | Traverses a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
114+-- to the 'DMap' can add, remove, update, move, or swap values.
115+sequenceDMapWithAdjustWithMove
116+ :: (GCompare k, Adjustable t m)
117+ => DMap k m
118+ -> Event t (PatchDMapWithMove k m)
119+ -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
79120sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
80121
81−mapMapWithAdjustWithMove :: forall t m k v v'. (Adjustable t m, Ord k) => (k -> v -> m v') -> Map k v -> Event t (PatchMapWithMove k v) -> m (Map k v', Event t (PatchMapWithMove k v'))
122+-- | Traverses a 'Map', running the provided 'Adjustable' action. The provided 'Event' of patches to the 'Map'
123+-- can add, remove, update, move, or swap values.
124+mapMapWithAdjustWithMove
125+ :: forall t m k v v'. (Adjustable t m, Ord k)
126+ => (k -> v -> m v')
127+ -> Map k v
128+ -> Event t (PatchMapWithMove k v)
129+ -> m (Map k v', Event t (PatchMapWithMove k v'))
82130mapMapWithAdjustWithMove f m0 m' = do
83131 (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
84132 return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
85133
86−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))
87−listHoldWithKey m0 m' f = do
88− let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
89− dm' = fmap (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey (\k v -> ComposeMaybe $ fmap (f k) v)) m'
90− (a0, a') <- sequenceDMapWithAdjust dm0 dm'
91− fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a' --TODO: Move the dmapToMap to the righthand side so it doesn't get fully redone every time
92−
93−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
94−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))
95−listWithKey vals mkChild = do
96− postBuild <- getPostBuild
97− let childValChangedSelector = fanMap $ updated vals
98− -- We keep track of changes to children values in the mkChild function we pass to listHoldWithKey
99− -- The other changes we need to keep track of are child insertions and deletions. diffOnlyKeyChanges
100− -- keeps track of insertions and deletions but ignores value changes, since they're already accounted for.
101− diffOnlyKeyChanges olds news = flip Map.mapMaybe (align olds news) $ \case
102− This _ -> Just Nothing
103− These _ _ -> Nothing
104− That new -> Just $ Just new
105− rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
106− let changeVals :: Event t (Map k (Maybe v))
107− changeVals = attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
108− [ updated vals
109− , 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
110− ]
111− listHoldWithKey Map.empty changeVals $ \k v ->
112− mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
113−
114−{-# DEPRECATED listWithKey' "listWithKey' has been renamed to listWithKeyShallowDiff; also, its behavior has changed to fix a bug where children were always rebuilt (never updated)" #-}
115−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))
116−listWithKey' = listWithKeyShallowDiff
117−
118−-- | 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.
119−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))
120−listWithKeyShallowDiff initialVals valsChanged mkChild = do
121− let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
122− sentVals <- foldDyn applyMap Map.empty $ fmap (fmap void) valsChanged
123− let relevantPatch patch _ = case patch of
124− 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
125− Just _ -> Nothing -- We don't want to let spurious re-creations of items through
126− listHoldWithKey initialVals (attachWith (flip (Map.differenceWith relevantPatch)) (current sentVals) valsChanged) $ \k v ->
127− mkChild k v $ select childValChangedSelector $ Const2 k
128−
129−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
130−-- | Create a dynamically-changing set of Event-valued widgets.
131−-- 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'.
132−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))
133−listViewWithKey vals mkChild = switch . fmap mergeMap <$> listViewWithKey' vals mkChild
134−
135−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))
136−listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
137−
138−-- | Create a dynamically-changing set of widgets, one of which is selected at any time.
139−selectViewListWithKey :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
140− => Dynamic t k -- ^ Current selection key
141− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
142− -> (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
143− -> m (Event t (k, a)) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
144−selectViewListWithKey selection vals mkChild = do
145− let selectionDemux = demux selection -- For good performance, this value must be shared across all children
146− selectChild <- listWithKey vals $ \k v -> do
147− let selected = demuxed selectionDemux k
148− selectSelf <- mkChild k v selected
149− return $ fmap ((,) k) selectSelf
150− return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
151−
152−selectViewListWithKey_ :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
153− => Dynamic t k -- ^ Current selection key
154− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
155− -> (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
156− -> m (Event t k) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
157−selectViewListWithKey_ selection vals mkChild = fmap fst <$> selectViewListWithKey selection vals mkChild
158−
159−-- | Create a dynamically-changing set of widgets from a Dynamic key/value map.
160−-- Unlike the 'withKey' variants, the child widgets are insensitive to which key they're associated with.
161−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))
162−list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
134+--------------------------------------------------------------------------------
135+-- Deprecated functions
136+--------------------------------------------------------------------------------
163137
164−-- | Create a dynamically-changing set of widgets from a Dynamic list.
165−simpleList :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t [v] -> (Dynamic t v -> m a) -> m (Dynamic t [a])
166−simpleList xs mkChild = fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap (Map.fromList . zip [(1::Int)..]) xs
138+{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
139+-- | Synonym for 'Adjustable'
140+type MonadAdjust = Adjustable
src/Reflex/BehaviorWriter/Base.hsnew file+211
@@ -0,0 +1,211 @@
1+{-|
2+Module: Reflex.BehaviorWriter.Base
3+Description: Implementation of BehaviorWriter
4+-}
5+{-# LANGUAGE CPP #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE TypeFamilies #-}
13+{-# LANGUAGE UndecidableInstances #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+#ifdef USE_REFLEX_OPTIMIZER
16+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
17+#endif
18+module Reflex.BehaviorWriter.Base
19+ ( BehaviorWriterT (..)
20+ , runBehaviorWriterT
21+ , withBehaviorWriterT
22+ ) where
23+
24+import Control.Monad.Exception
25+import Control.Monad.Identity
26+import Control.Monad.IO.Class
27+import Control.Monad.Morph
28+import Control.Monad.Reader
29+import Control.Monad.Ref
30+import Control.Monad.State.Strict
31+import Data.Dependent.Map (DMap)
32+import qualified Data.Dependent.Map as DMap
33+import Data.Functor.Misc
34+import Data.IntMap (IntMap)
35+import qualified Data.IntMap as IntMap
36+import Data.Map (Map)
37+import qualified Data.Map as Map
38+import Data.Some (Some)
39+
40+import Reflex.Class
41+import Reflex.Adjustable.Class
42+import Reflex.BehaviorWriter.Class
43+import Reflex.Host.Class
44+import Reflex.PerformEvent.Class
45+import Reflex.PostBuild.Class
46+import Reflex.Query.Class
47+import Reflex.Requester.Class
48+import Reflex.TriggerEvent.Class
49+
50+-- | A basic implementation of 'BehaviorWriter'.
51+newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
52+ -- The list is kept in reverse order
53+ deriving
54+ ( Functor
55+ , Applicative
56+ , Monad
57+ , MonadTrans
58+ , MFunctor
59+ , MonadIO
60+ , MonadFix
61+ , MonadAsyncException
62+ , MonadException
63+ )
64+
65+-- | Run a 'BehaviorWriterT' action. The behavior writer output will be provided
66+-- along with the result of the action.
67+runBehaviorWriterT :: (Monad m, Reflex t, Monoid w) => BehaviorWriterT t w m a -> m (a, Behavior t w)
68+runBehaviorWriterT (BehaviorWriterT a) = do
69+ (result, ws) <- runStateT a []
70+ return (result, mconcat $ reverse ws)
71+
72+-- | Map a function over the output of a 'BehaviorWriterT'.
73+withBehaviorWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m)
74+ => (w -> w')
75+ -> BehaviorWriterT t w m a
76+ -> BehaviorWriterT t w' m a
77+withBehaviorWriterT f dw = do
78+ (r, d) <- lift $ do
79+ (r, d) <- runBehaviorWriterT dw
80+ let d' = fmap f d
81+ return (r, d')
82+ tellBehavior d
83+ return r
84+
85+deriving instance MonadHold t m => MonadHold t (BehaviorWriterT t w m)
86+deriving instance MonadSample t m => MonadSample t (BehaviorWriterT t w m)
87+
88+instance MonadRef m => MonadRef (BehaviorWriterT t w m) where
89+ type Ref (BehaviorWriterT t w m) = Ref m
90+ newRef = lift . newRef
91+ readRef = lift . readRef
92+ writeRef r = lift . writeRef r
93+
94+instance MonadAtomicRef m => MonadAtomicRef (BehaviorWriterT t w m) where
95+ atomicModifyRef r = lift . atomicModifyRef r
96+
97+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (BehaviorWriterT t w m) where
98+ newEventWithTrigger = lift . newEventWithTrigger
99+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
100+
101+instance (Monad m, Monoid w, Reflex t) => BehaviorWriter t w (BehaviorWriterT t w m) where
102+ tellBehavior w = BehaviorWriterT $ modify (w :)
103+
104+instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
105+ ask = lift ask
106+ local f (BehaviorWriterT a) = BehaviorWriterT $ mapStateT (local f) a
107+ reader = lift . reader
108+
109+instance PerformEvent t m => PerformEvent t (BehaviorWriterT t w m) where
110+ type Performable (BehaviorWriterT t w m) = Performable m
111+ performEvent_ = lift . performEvent_
112+ performEvent = lift . performEvent
113+
114+instance TriggerEvent t m => TriggerEvent t (BehaviorWriterT t w m) where
115+ newTriggerEvent = lift newTriggerEvent
116+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
117+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
118+
119+instance PostBuild t m => PostBuild t (BehaviorWriterT t w m) where
120+ getPostBuild = lift getPostBuild
121+
122+instance MonadState s m => MonadState s (BehaviorWriterT t w m) where
123+ get = lift get
124+ put = lift . put
125+
126+instance Requester t m => Requester t (BehaviorWriterT t w m) where
127+ type Request (BehaviorWriterT t w m) = Request m
128+ type Response (BehaviorWriterT t w m) = Response m
129+ requesting = lift . requesting
130+ requesting_ = lift . requesting_
131+
132+instance (MonadQuery t q m, Monad m) => MonadQuery t q (BehaviorWriterT t w m) where
133+ tellQueryIncremental = lift . tellQueryIncremental
134+ askQueryResult = lift askQueryResult
135+ queryIncremental = lift . queryIncremental
136+
137+instance (Adjustable t m, Monoid w, MonadHold t m, Reflex t) => Adjustable t (BehaviorWriterT t w m) where
138+ runWithReplace a0 a' = do
139+ (result0, result') <- lift $ runWithReplace (runBehaviorWriterT a0) $ runBehaviorWriterT <$> a'
140+ tellBehavior . join =<< hold (snd result0) (snd <$> result')
141+ return (fst result0, fst <$> result')
142+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustImpl traverseIntMapWithKeyWithAdjust
143+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith
144+
145+traverseIntMapWithKeyWithAdjustImpl
146+ :: forall t w v' p p' v m.
147+ ( PatchTarget (p' (Behavior t w)) ~ IntMap (Behavior t w)
148+ , Patch (p' (Behavior t w))
149+ , Monoid w
150+ , Reflex t
151+ , MonadHold t m
152+ , Functor p
153+ , p ~ p'
154+ )
155+ => ( (IntMap.Key -> v -> m (v', Behavior t w))
156+ -> IntMap v
157+ -> Event t (p v)
158+ -> m (IntMap (v', Behavior t w), Event t (p (v', Behavior t w)))
159+ )
160+ -> (IntMap.Key -> v -> BehaviorWriterT t w m v')
161+ -> IntMap v
162+ -> Event t (p v)
163+ -> BehaviorWriterT t w m (IntMap v', Event t (p v'))
164+traverseIntMapWithKeyWithAdjustImpl base f (dm0 :: IntMap v) dm' = do
165+ (result0, result') <- lift $ base (\k v -> runBehaviorWriterT $ f k v) dm0 dm'
166+ let liftedResult0 = fmap fst result0
167+ liftedResult' = fmap (fmap fst) result'
168+ liftedWritten0 :: IntMap (Behavior t w)
169+ liftedWritten0 = fmap snd result0
170+ liftedWritten' = fmap (fmap snd) result'
171+ i <- holdIncremental liftedWritten0 liftedWritten'
172+ tellBehavior $ pull $ do
173+ m <- sample $ currentIncremental i
174+ mconcat . IntMap.elems <$> traverse sample m
175+ return (liftedResult0, liftedResult')
176+
177+newtype BehaviorWriterTLoweredResult t w v a = BehaviorWriterTLoweredResult (v a, Behavior t w)
178+
179+traverseDMapWithKeyWithAdjustImpl
180+ :: forall t w k v' p p' v m.
181+ ( PatchTarget (p' (Some k) (Behavior t w)) ~ Map (Some k) (Behavior t w)
182+ , Patch (p' (Some k) (Behavior t w))
183+ , Monoid w
184+ , Reflex t
185+ , MonadHold t m
186+ )
187+ => ( (forall a. k a -> v a -> m (BehaviorWriterTLoweredResult t w v' a))
188+ -> DMap k v
189+ -> Event t (p k v)
190+ -> m (DMap k (BehaviorWriterTLoweredResult t w v'), Event t (p k (BehaviorWriterTLoweredResult t w v')))
191+ )
192+ -> ((forall a. BehaviorWriterTLoweredResult t w v' a -> v' a) -> p k (BehaviorWriterTLoweredResult t w v') -> p k v')
193+ -> ((forall a. BehaviorWriterTLoweredResult t w v' a -> Behavior t w) -> p k (BehaviorWriterTLoweredResult t w v') -> p' (Some k) (Behavior t w))
194+ -> (forall a. k a -> v a -> BehaviorWriterT t w m (v' a))
195+ -> DMap k v
196+ -> Event t (p k v)
197+ -> BehaviorWriterT t w m (DMap k v', Event t (p k v'))
198+traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith f (dm0 :: DMap k v) dm' = do
199+ (result0, result') <- lift $ base (\k v -> fmap BehaviorWriterTLoweredResult $ runBehaviorWriterT $ f k v) dm0 dm'
200+ let getValue (BehaviorWriterTLoweredResult (v, _)) = v
201+ getWritten (BehaviorWriterTLoweredResult (_, w)) = w
202+ liftedResult0 = DMap.map getValue result0
203+ liftedResult' = ffor result' $ mapPatch getValue
204+ liftedWritten0 :: Map (Some k) (Behavior t w)
205+ liftedWritten0 = weakenDMapWith getWritten result0
206+ liftedWritten' = ffor result' $ weakenPatchWith getWritten
207+ i <- holdIncremental liftedWritten0 liftedWritten'
208+ tellBehavior $ pull $ do
209+ m <- sample $ currentIncremental i
210+ mconcat . Map.elems <$> traverse sample m
211+ return (liftedResult0, liftedResult')
src/Reflex/BehaviorWriter/Class.hsnew file+31
@@ -0,0 +1,31 @@
1+{-|
2+Module: Reflex.BehaviorWriter.Class
3+Description: This module defines the 'BehaviorWriter' class
4+-}
5+{-# LANGUAGE CPP #-}
6+{-# LANGUAGE ConstraintKinds #-}
7+{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE FunctionalDependencies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+module Reflex.BehaviorWriter.Class
14+ ( MonadBehaviorWriter
15+ , BehaviorWriter(..)
16+ ) where
17+
18+import Control.Monad.Reader (ReaderT, lift)
19+import Reflex.Class (Behavior)
20+
21+{-# DEPRECATED MonadBehaviorWriter "Use 'BehaviorWriter' instead" #-}
22+-- | Type synonym for 'BehaviorWriter'
23+type MonadBehaviorWriter = BehaviorWriter
24+
25+-- | 'BehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
26+-- and combines them monoidally to provide a 'Behavior' result.
27+class (Monad m, Monoid w) => BehaviorWriter t w m | m -> t w where
28+ tellBehavior :: Behavior t w -> m ()
29+
30+instance BehaviorWriter t w m => BehaviorWriter t w (ReaderT r m) where
31+ tellBehavior = lift . tellBehavior
src/Reflex/Class.hs+728−348
@@ -1,14 +1,14 @@
11{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE ConstraintKinds #-}
32{-# LANGUAGE CPP #-}
3+{-# LANGUAGE ConstraintKinds #-}
44{-# LANGUAGE DefaultSignatures #-}
55{-# LANGUAGE FlexibleContexts #-}
66{-# LANGUAGE FlexibleInstances #-}
77{-# LANGUAGE FunctionalDependencies #-}
88{-# LANGUAGE GADTs #-}
99{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
1110{-# LANGUAGE NoMonomorphismRestriction #-}
11+{-# LANGUAGE PolyKinds #-}
1212{-# LANGUAGE RankNTypes #-}
1313{-# LANGUAGE RecursiveDo #-}
1414{-# LANGUAGE RoleAnnotations #-}
@@ -16,46 +16,56 @@
1616{-# LANGUAGE TypeFamilies #-}
1717{-# LANGUAGE TypeOperators #-}
1818{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
1920#ifdef USE_REFLEX_OPTIMIZER
2021{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
2122#endif
22−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
23−{-# LANGUAGE EmptyDataDecls #-}
24−{-# OPTIONS_GHC -Wno-redundant-constraints #-}
25−#endif
2623
27−-- | This module contains the Reflex interface, as well as a variety of
28−-- convenience functions for working with 'Event's, 'Behavior's, and other
29−-- signals.
24+-- |
25+-- Module:
26+-- Reflex.Class
27+-- Description:
28+-- This module contains the Reflex interface, as well as a variety of
29+-- convenience functions for working with 'Event's, 'Behavior's, and other
30+-- signals.
3031module Reflex.Class
31− ( module Reflex.Patch
32+ ( module Data.Patch
3233 -- * Primitives
3334 , Reflex (..)
3435 , mergeInt
3536 , coerceBehavior
3637 , coerceEvent
3738 , coerceDynamic
39+ , coerceIncremental
3840 , MonadSample (..)
3941 , MonadHold (..)
40− -- ** 'fan'-related types
42+ -- ** 'fan' related types
4143 , EventSelector (..)
44+ , EventSelectorG (..)
4245 , EventSelectorInt (..)
43− -- ** 'Incremental'-related types
4446 -- * Convenience functions
4547 , constDyn
4648 , pushAlways
4749 -- ** Combining 'Event's
4850 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
4954 , mergeMap
55+ , mergeIntMap
5056 , mergeMapIncremental
5157 , mergeMapIncrementalWithMove
5258 , mergeIntMapIncremental
59+ , coincidencePatchMap
60+ , coincidencePatchMapWithMove
61+ , coincidencePatchIntMap
5362 , mergeList
5463 , mergeWith
5564 , difference
5665 , alignEventWithMaybe
5766 -- ** Breaking up 'Event's
5867 , splitE
68+ , fan
5969 , fanEither
6070 , fanThese
6171 , fanMap
@@ -63,12 +73,16 @@ module Reflex.Class
6373 , EitherTag (..)
6474 , eitherToDSum
6575 , dsumToEither
76+ , factorEvent
77+ , filterEventKey
6678 -- ** Collapsing 'Event . Event'
6779 , switchHold
6880 , switchHoldPromptly
6981 , switchHoldPromptOnly
82+ , switchHoldPromptOnlyIncremental
7083 -- ** Using 'Event's to sample 'Behavior's
7184 , tag
85+ , tagMaybe
7286 , attach
7387 , attachWith
7488 , attachWithMaybe
@@ -76,6 +90,7 @@ module Reflex.Class
7690 , gate
7791 -- ** Combining 'Dynamic's
7892 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
7994 , distributeListOverDyn
8095 , distributeListOverDynWith
8196 , zipDyn
@@ -102,6 +117,14 @@ module Reflex.Class
102117 , mapAccumM_
103118 , mapAccumMaybe_
104119 , mapAccumMaybeM_
120+ , accumIncremental
121+ , accumMIncremental
122+ , accumMaybeIncremental
123+ , accumMaybeMIncremental
124+ , mapAccumIncremental
125+ , mapAccumMIncremental
126+ , mapAccumMaybeIncremental
127+ , mapAccumMaybeMIncremental
105128 , zipListWithEvent
106129 , numberOccurrences
107130 , numberOccurrencesFrom
@@ -111,6 +134,9 @@ module Reflex.Class
111134 , tailE
112135 , headTailE
113136 , takeWhileE
137+ , takeWhileJustE
138+ , dropWhileE
139+ , takeDropWhileJustE
114140 , switcher
115141 -- * Debugging functions
116142 , traceEvent
@@ -118,25 +144,24 @@ module Reflex.Class
118144 -- * Unsafe functions
119145 , unsafeDynamic
120146 , unsafeMapIncremental
121− -- * 'FunctorMaybe'
122− , FunctorMaybe (..)
147+ -- * 'Filterable' convenience functions
148+ , FunctorMaybe -- fmapMaybe is purposely not exported from deprecated 'FunctorMaybe' and the new alias is exported instead
149+ , mapMaybe -- Re-exported for convenience
150+ , fmapMaybe
123151 , fforMaybe
124152 , ffilter
125153 , filterLeft
126154 , filterRight
127− -- * 'Adjustable'
128− , Adjustable(..)
129− , sequenceDMapWithAdjust
130− , sequenceDMapWithAdjustWithMove
131− , mapMapWithAdjustWithMove
132155 -- * Miscellaneous convenience functions
133156 , ffor
157+ , ffor2
158+ , ffor3
134159 -- * Deprecated functions
135− , MonadAdjust
136− , appendEvents
137− , onceE
138− , sequenceThese
160+ , switchPromptly
161+ , switchPromptOnly
162+ -- * "Cheap" functions
139163 , fmapMaybeCheap
164+ , mapMaybeCheap
140165 , fmapCheap
141166 , fforCheap
142167 , fforMaybeCheap
@@ -144,101 +169,65 @@ module Reflex.Class
144169 , tagCheap
145170 , mergeWithCheap
146171 , mergeWithCheap'
147− , switchPromptly
148− , switchPromptOnly
149172 -- * Slow, but general, implementations
150173 , slowHeadE
151−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
152− , Spider
153− , SpiderEnv
154− , SpiderTimeline
155− , Global
156− , Behavior (..)
157− , Event (..)
158− , Dynamic (..)
159− , Incremental (..)
160− , never
161− , constant
162− , push
163− , pushCheap
164− , pull
165− , merge
166− , fan
167− , switch
168− , coincidence
169− , current
170− , updated
171− , unsafeBuildDynamic
172− , unsafeBuildIncremental
173− , mergeIncremental
174− , mergeIncrementalWithMove
175− , currentIncremental
176− , updatedIncremental
177− , incrementalToDynamic
178− , behaviorCoercion
179− , eventCoercion
180− , dynamicCoercion
181−#endif
182174 ) where
183175
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+
184187import Control.Applicative
185−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
186−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
187−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
188−import Control.Monad.Trans.Cont (ContT ())
189−import Control.Monad.Trans.Except (ExceptT ())
190−import Control.Monad.Trans.RWS (RWST ())
191−import Control.Monad.Trans.Writer (WriterT ())
188+import Control.Monad.Identity
189+import Control.Monad.Reader
190+import Control.Monad.State.Strict
191+import Control.Monad.Trans.Cont (ContT)
192+import Control.Monad.Trans.Except (ExceptT)
193+import Control.Monad.Trans.RWS (RWST)
194+import Control.Monad.Trans.Writer (WriterT)
192195import Data.Align
193196import Data.Bifunctor
194197import Data.Coerce
195198import Data.Default
196−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
197201import qualified Data.Dependent.Map as DMap
198−import Data.Either
202+import Data.Functor.Compose
203+import Data.Functor.Product
204+import Data.GADT.Compare (GEq (..), GCompare (..))
205+import Data.FastMutableIntMap (PatchIntMap)
199206import Data.Foldable
200−import Data.Functor.Bind hiding (join)
201−import qualified Data.Functor.Bind as Bind
202−import Data.Functor.Constant
207+import Data.Functor.Bind
203208import Data.Functor.Misc
204209import Data.Functor.Plus
205210import Data.IntMap.Strict (IntMap)
206211import qualified Data.IntMap.Strict as IntMap
207212import Data.List.NonEmpty (NonEmpty (..))
208213import Data.Map (Map)
209−import Data.Maybe
210−import Data.Monoid hiding (Alt, (<>))
211−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
214+import Data.Semigroup (Semigroup (..))
215+import Data.Some (Some(Some))
212216import Data.String
213217import Data.These
214−import Data.Traversable
215218import Data.Type.Coercion
216−import Reflex.FunctorMaybe
217−import Reflex.Patch
218−import Data.FastMutableIntMap (PatchIntMap)
219−
220−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
221−import Reflex.Spider.Internal (EventM, Global, HasSpiderTimeline, SpiderHost (..), SpiderHostFrame (..),
222− SpiderPullM, SpiderPushM (..), behaviorHoldIdentity, dynamicConst,
223− dynamicCurrent, dynamicDynIdentity, dynamicHold, dynamicHoldIdentity,
224− dynamicUpdated, newMapDyn, readBehaviorTracked, readBehaviorUntracked,
225− runFrame, runSpiderHostFrame)
226−import qualified Reflex.Spider.Internal
227−import qualified Reflex.Spider.Internal as S
228−import Unsafe.Coerce
229−#endif
230−
231−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
232−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
219+import Data.Type.Equality ((:~:) (..))
220+import Data.Witherable (Filterable(..))
221+import qualified Data.Witherable as W
222+import Reflex.FunctorMaybe (FunctorMaybe)
223+import qualified Reflex.FunctorMaybe
224+import Data.Patch
225+import qualified Data.Patch.MapWithMove as PatchMapWithMove
233226
234227import Debug.Trace (trace)
235228
236−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
237−#include "Spider/SpiderTimeline.include.hs"
238−#endif
239−
240229-- | The 'Reflex' class contains all the primitive functionality needed for
241−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
230+-- Functional Reactive Programming (FRP). The @/t/@ type parameter indicates
242231-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
243232-- and the type of the timeline determines the FRP engine to be used. For most
244233-- purposes, the 'Reflex.Spider' implementation is recommended.
@@ -248,9 +237,6 @@ class ( MonadHold t (PushM t)
248237 , Functor (Dynamic t)
249238 , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
250239 , Monad (Dynamic t)
251−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
252− , t ~ SpiderTimeline Global
253−#endif
254240 ) => Reflex t where
255241 -- | A container for a value that can change over time. 'Behavior's can be
256242 -- sampled at will, but it is not possible to be notified when they change
@@ -273,7 +259,6 @@ class ( MonadHold t (PushM t)
273259 type PushM t :: * -> *
274260 -- | A monad for doing complex pull-based calculations efficiently
275261 type PullM t :: * -> *
276−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
277262 -- | An 'Event' with no occurrences
278263 never :: Event t a
279264 -- | Create a 'Behavior' that always has the given value
@@ -288,18 +273,23 @@ class ( MonadHold t (PushM t)
288273 -- recomputed whenever any of the read 'Behavior's changes
289274 pull :: PullM t a -> Behavior t a
290275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
291− -- least one input event is occuring, and will contain all of the input keys
276+ -- least one input event is occurring, and will contain all of the input keys
292277 -- that are occurring simultaneously
293− 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
294− -- | Efficiently fan-out an event to many destinations. This function should
295− -- be partially applied, and then the result applied repeatedly to create
296− -- child events
297− fan :: GCompare k => Event t (DMap k Identity) -> EventSelector t k --TODO: Can we help enforce the partial application discipline here? The combinator is worthless without it
278+
279+ --TODO: Generalize to get rid of DMap use --TODO: Provide a type-level guarantee that the result is not empty
280+ mergeG :: GCompare k => (forall a. q a -> Event t (v a))
281+ -> DMap k q -> Event t (DMap k v)
282+
283+ -- | Efficiently fan-out an event to many destinations. You should save the
284+ -- result in a @let@-binding, and then repeatedly 'selectG' on the result to
285+ -- create child events
286+ fanG :: GCompare k => Event t (DMap k v) -> EventSelectorG t k v
287+
298288 -- | Create an 'Event' that will occur whenever the currently-selected input
299289 -- 'Event' occurs
300290 switch :: Behavior t (Event t a) -> Event t a
301− -- | Create an 'Event' that will occur whenever the input event is occurring
302− -- and its occurrence value, another 'Event', is also occurring
291+ -- | Create an 'Event' that will occur whenever the input event is occurring -- and its occurrence value, another 'Event', is also occurring.
292+ -- You maybe looking for '@switchHold@ @never@' instead.
303293 coincidence :: Event t (Event t a) -> Event t a
304294 -- | Extract the 'Behavior' of a 'Dynamic'.
305295 current :: Dynamic t a -> Behavior t a
@@ -308,14 +298,19 @@ class ( MonadHold t (PushM t)
308298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
309299 -- recent firing of the given 'Event', if any.
310300 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
311− -- | 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
312302 -- in the same way that the accumulated application of patches would change
313303 -- that value.
314304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
315305 -- | Create a merge whose parents can change over time
316− mergeIncremental :: GCompare k => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
306+ mergeIncrementalG :: GCompare k
307+ => (forall a. q a -> Event t (v a))
308+ -> Incremental t (PatchDMap k q)
309+ -> Event t (DMap k v)
317310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
318− mergeIncrementalWithMove :: GCompare k => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
311+ mergeIncrementalWithMoveG :: GCompare k
312+ => (forall a. q a -> Event t (v a))
313+ -> Incremental t (PatchDMapWithMove k q) -> Event t (DMap k v)
319314 -- | Extract the 'Behavior' component of an 'Incremental'
320315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
321316 -- | Extract the 'Event' component of an 'Incremental'
@@ -331,86 +326,31 @@ class ( MonadHold t (PushM t)
331326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
332327 -- occurrence type
333328 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)
334333 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
335334 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
336−#endif
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
337347
338348--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.
339351mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
340352mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
341353
342−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
343−instance t ~ SpiderTimeline Global => Reflex t where
344− newtype Behavior t a = SpiderBehavior { unSpiderBehavior :: Reflex.Spider.Internal.Behavior Global a }
345− newtype Event t a = SpiderEvent { unSpiderEvent :: Reflex.Spider.Internal.Event Global a }
346− newtype Dynamic t a = SpiderDynamic { unSpiderDynamic :: Reflex.Spider.Internal.Dynamic Global (Identity a) } -- deriving (Functor, Applicative, Monad)
347− newtype Incremental t p = SpiderIncremental { unSpiderIncremental :: Reflex.Spider.Internal.Dynamic Global p }
348− type PullM t = SpiderPullM Global
349− type PushM t = SpiderPushM Global
350−never :: Reflex t => Event t a
351−constant :: Reflex t => a -> Behavior t a
352−push :: Reflex t => (a -> PushM t (Maybe b)) -> Event t a -> Event t b
353−pushCheap :: Reflex t => (a -> PushM t (Maybe b)) -> Event t a -> Event t b
354−pull :: Reflex t => PullM t a -> Behavior t a
355−merge :: (Reflex t, GCompare k) => DMap k (Event t) -> Event t (DMap k Identity)
356−fan :: (Reflex t, GCompare k) => Event t (DMap k Identity) -> EventSelector t k
357−switch :: Reflex t => Behavior t (Event t a) -> Event t a
358−coincidence :: Reflex t => Event t (Event t a) -> Event t a
359−current :: Reflex t => Dynamic t a -> Behavior t a
360−updated :: Reflex t => Dynamic t a -> Event t a
361−unsafeBuildDynamic :: Reflex t => PullM t a -> Event t a -> Dynamic t a
362−unsafeBuildIncremental :: (Reflex t, Patch p) => PullM t (PatchTarget p) -> Event t p -> Incremental t p
363−mergeIncremental :: (Reflex t, GCompare k) => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
364−mergeIncrementalWithMove :: (Reflex t, GCompare k) => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
365−currentIncremental :: (Reflex t, Patch p) => Incremental t p -> Behavior t (PatchTarget p)
366−updatedIncremental :: (Reflex t, Patch p) => Incremental t p -> Event t p
367−incrementalToDynamic :: (Reflex t, Patch p) => Incremental t p -> Dynamic t (PatchTarget p)
368−behaviorCoercion :: Reflex t => Coercion a b -> Coercion (Behavior t a) (Behavior t b)
369−eventCoercion :: Reflex t => Coercion a b -> Coercion (Event t a) (Event t b)
370−dynamicCoercion :: Reflex t => Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
371−{-# INLINE never #-}
372−never = SpiderEvent S.eventNever
373−{-# INLINE constant #-}
374−constant = SpiderBehavior . S.behaviorConst
375−{-# INLINE push #-}
376−push f = SpiderEvent . S.push (coerce f) . unSpiderEvent
377−{-# INLINE pushCheap #-}
378−pushCheap f = SpiderEvent . S.pushCheap (coerce f) . unSpiderEvent
379−{-# INLINE pull #-}
380−pull = SpiderBehavior . S.pull . coerce
381−{-# INLINE merge #-}
382−merge = SpiderEvent . S.merge . S.dynamicConst . (coerce :: DMap k (Event (SpiderTimeline x)) -> DMap k (S.Event x))
383−{-# INLINE fan #-}
384−fan e = EventSelector $ SpiderEvent . S.select (S.fan (unSpiderEvent e))
385−{-# INLINE switch #-}
386−switch = SpiderEvent . S.switch . (coerce :: S.Behavior x (Event (SpiderTimeline x) a) -> S.Behavior x (S.Event x a)) . unSpiderBehavior
387−{-# INLINE coincidence #-}
388−coincidence = SpiderEvent . S.coincidence . (coerce :: S.Event x (Event (SpiderTimeline x) a) -> S.Event x (S.Event x a)) . unSpiderEvent
389−{-# INLINE current #-}
390−current = SpiderBehavior . S.dynamicCurrent . unSpiderDynamic
391−{-# INLINE updated #-}
392−updated = coerceEvent . SpiderEvent . dynamicUpdated . unSpiderDynamic
393−{-# INLINE unsafeBuildDynamic #-}
394−unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ S.unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
395−{-# INLINE unsafeBuildIncremental #-}
396−unsafeBuildIncremental readV0 dv = SpiderIncremental $ S.dynamicDyn $ S.unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
397−{-# INLINE mergeIncremental #-}
398−mergeIncremental = SpiderEvent . S.merge . (unsafeCoerce :: S.Dynamic x (PatchDMap k (Event (SpiderTimeline x))) -> S.Dynamic x (PatchDMap k (S.Event x))) . unSpiderIncremental
399−{-# INLINE mergeIncrementalWithMove #-}
400−mergeIncrementalWithMove = SpiderEvent . S.mergeWithMove . (unsafeCoerce :: S.Dynamic x (PatchDMapWithMove k (Event (SpiderTimeline x))) -> S.Dynamic x (PatchDMapWithMove k (S.Event x))) . unSpiderIncremental
401−{-# INLINE currentIncremental #-}
402−currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
403−{-# INLINE updatedIncremental #-}
404−updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
405−{-# INLINE incrementalToDynamic #-}
406−incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ S.unsafeBuildDynamic (readBehaviorUntracked $ dynamicCurrent i) $ flip S.push (dynamicUpdated i) $ \p -> do
407− c <- readBehaviorUntracked $ dynamicCurrent i
408− return $ Identity <$> apply p c
409−eventCoercion Coercion = Coercion
410−behaviorCoercion Coercion = Coercion
411−dynamicCoercion = unsafeCoerce
412−#endif
413−
414354-- | Coerce a 'Behavior' between representationally-equivalent value types
415355coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
416356coerceBehavior = coerceWith $ behaviorCoercion Coercion
@@ -423,8 +363,14 @@ coerceEvent = coerceWith $ eventCoercion Coercion
423363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
424364coerceDynamic = coerceWith $ dynamicCoercion Coercion
425365
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+
426372-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
427−-- _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
428374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
429375-- if this is not the case, the resulting 'Dynamic' will behave
430376-- nondeterministically.
@@ -452,7 +398,7 @@ class MonadSample t m => MonadHold t m where
452398 -- value and will be updated whenever the given 'Event' occurs. The update
453399 -- takes effect immediately after the 'Event' occurs; if the occurrence that
454400 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
455− -- 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
456402 -- one.
457403 hold :: a -> Event t a -> m (Behavior t a)
458404 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
@@ -467,16 +413,118 @@ class MonadSample t m => MonadHold t m where
467413 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
468414 default holdIncremental :: (Patch p, m ~ f m', MonadTrans f, MonadHold t m') => PatchTarget p -> Event t p -> m (Incremental t p)
469415 holdIncremental v0 = lift . holdIncremental v0
470− buildDynamic :: PullM t a -> Event t a -> m (Dynamic t a)
416+ buildDynamic :: PushM t a -> Event t a -> m (Dynamic t a)
471417 {-
472418 default buildDynamic :: (m ~ f m', MonadTrans f, MonadHold t m') => PullM t a -> Event t a -> m (Dynamic t a)
473419 buildDynamic getV0 = lift . buildDynamic getV0
474420 -}
475− -- | Create a new 'Event' that only occurs only once, on the first occurence of
421+ -- | Create a new 'Event' that only occurs only once, on the first occurrence of
476422 -- the supplied 'Event'.
477423 headE :: Event t a -> m (Event t a)
424+ -- | An event which only occurs at the current moment in time, such that:
425+ --
426+ -- > coincidence (pushAlways (\a -> (a <$) <$> now) e) = e
427+ --
428+ now :: m (Event t ())
429+ default now :: (m ~ f m', MonadTrans f, MonadHold t m') => m (Event t ())
430+ now = lift now
431+
432+-- | Accumulate an 'Incremental' with the supplied initial value and the firings of the provided 'Event',
433+-- using the combining function to produce a patch.
434+accumIncremental
435+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
436+ => (PatchTarget p -> b -> p)
437+ -> PatchTarget p
438+ -> Event t b
439+ -> m (Incremental t p)
440+accumIncremental f = accumMaybeIncremental $ \v o -> Just $ f v o
441+
442+-- | Similar to 'accumIncremental' but the combining function runs in 'PushM'
443+accumMIncremental
444+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
445+ => (PatchTarget p -> b -> PushM t p)
446+ -> PatchTarget p
447+ -> Event t b
448+ -> m (Incremental t p)
449+accumMIncremental f = accumMaybeMIncremental $ \v o -> Just <$> f v o
450+
451+-- | Similar to 'accumIncremental' but allows filtering of updates (by dropping updates when the
452+-- combining function produces @Nothing@)
453+accumMaybeIncremental
454+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
455+ => (PatchTarget p -> b -> Maybe p)
456+ -> PatchTarget p
457+ -> Event t b
458+ -> m (Incremental t p)
459+accumMaybeIncremental f = accumMaybeMIncremental $ \v o -> return $ f v o
460+
461+-- | Similar to 'accumMaybeMIncremental' but the combining function runs in 'PushM'
462+accumMaybeMIncremental
463+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
464+ => (PatchTarget p -> b -> PushM t (Maybe p))
465+ -> PatchTarget p
466+ -> Event t b
467+ -> m (Incremental t p)
468+accumMaybeMIncremental f z e = do
469+ rec let e' = flip push e $ \o -> do
470+ v <- sample $ currentIncremental d'
471+ f v o
472+ d' <- holdIncremental z e'
473+ return d'
478474
475+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event'
476+-- with a function that both accumulates and produces a value to fire
477+-- as an 'Event'. Returns both the accumulated value and the constructed
478+-- 'Event'.
479+mapAccumIncremental
480+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
481+ => (PatchTarget p -> b -> (p, c))
482+ -> PatchTarget p
483+ -> Event t b
484+ -> m (Incremental t p, Event t c)
485+mapAccumIncremental f = mapAccumMaybeIncremental $ \v o -> bimap Just Just $ f v o
486+
487+-- | Like 'mapAccumIncremental' but the combining function runs in 'PushM'
488+mapAccumMIncremental
489+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
490+ => (PatchTarget p -> b -> PushM t (p, c))
491+ -> PatchTarget p
492+ -> Event t b
493+ -> m (Incremental t p, Event t c)
494+mapAccumMIncremental f = mapAccumMaybeMIncremental $ \v o -> bimap Just Just <$> f v o
495+
496+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event' with
497+-- a function that both optionally accumulates and optionally produces
498+-- a value to fire as a separate output 'Event'.
499+-- Note that because 'Nothing's are discarded in both cases, the output
500+-- 'Event' may fire even though the output 'Incremental' has not changed, and
501+-- the output 'Incremental' may update even when the output 'Event' is not firing.
502+mapAccumMaybeIncremental
503+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
504+ => (PatchTarget p -> b -> (Maybe p, Maybe c))
505+ -> PatchTarget p
506+ -> Event t b
507+ -> m (Incremental t p, Event t c)
508+mapAccumMaybeIncremental f = mapAccumMaybeMIncremental $ \v o -> return $ f v o
509+
510+-- | Like 'mapAccumMaybeIncremental' but the combining function is a 'PushM' action
511+mapAccumMaybeMIncremental
512+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
513+ => (PatchTarget p -> b -> PushM t (Maybe p, Maybe c))
514+ -> PatchTarget p
515+ -> Event t b
516+ -> m (Incremental t p, Event t c)
517+mapAccumMaybeMIncremental f z e = do
518+ rec let e' = flip push e $ \o -> do
519+ v <- sample $ currentIncremental d'
520+ result <- f v o
521+ return $ case result of
522+ (Nothing, Nothing) -> Nothing
523+ _ -> Just result
524+ d' <- holdIncremental z $ mapMaybe fst e'
525+ return (d', mapMaybe snd e')
479526
527+-- | A somewhat slow implementation of 'headE'
480528slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
481529slowHeadE e = do
482530 rec be <- hold e $ fmapCheap (const never) e'
@@ -485,18 +533,31 @@ slowHeadE e = do
485533
486534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
487535-- key. This is much more efficient than filtering for each key with
488−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
489537newtype EventSelector t k = EventSelector
490538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
491539 -- determined by the type of the key, so this can be used to fan-out
492540 -- 'Event's whose sub-'Event's have different types.
493541 --
494542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
495− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
496544 -- occurrences of an 'Event'.
497545 select :: forall a. k a -> Event t a
498546 }
499547
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.
500561newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
501562
502563--------------------------------------------------------------------------------
@@ -512,6 +573,7 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
512573 holdIncremental a0 = lift . holdIncremental a0
513574 buildDynamic a0 = lift . buildDynamic a0
514575 headE = lift . headE
576+ now = lift now
515577
516578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
517579 sample = lift . sample
@@ -522,6 +584,7 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
522584 holdIncremental a0 = lift . holdIncremental a0
523585 buildDynamic a0 = lift . buildDynamic a0
524586 headE = lift . headE
587+ now = lift now
525588
526589instance MonadSample t m => MonadSample t (StateT s m) where
527590 sample = lift . sample
@@ -532,6 +595,7 @@ instance MonadHold t m => MonadHold t (StateT s m) where
532595 holdIncremental a0 = lift . holdIncremental a0
533596 buildDynamic a0 = lift . buildDynamic a0
534597 headE = lift . headE
598+ now = lift now
535599
536600instance MonadSample t m => MonadSample t (ExceptT e m) where
537601 sample = lift . sample
@@ -542,6 +606,7 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
542606 holdIncremental a0 = lift . holdIncremental a0
543607 buildDynamic a0 = lift . buildDynamic a0
544608 headE = lift . headE
609+ now = lift now
545610
546611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
547612 sample = lift . sample
@@ -552,6 +617,7 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
552617 holdIncremental a0 = lift . holdIncremental a0
553618 buildDynamic a0 = lift . buildDynamic a0
554619 headE = lift . headE
620+ now = lift now
555621
556622instance MonadSample t m => MonadSample t (ContT r m) where
557623 sample = lift . sample
@@ -562,6 +628,7 @@ instance MonadHold t m => MonadHold t (ContT r m) where
562628 holdIncremental a0 = lift . holdIncremental a0
563629 buildDynamic a0 = lift . buildDynamic a0
564630 headE = lift . headE
631+ now = lift now
565632
566633--------------------------------------------------------------------------------
567634-- Convenience functions
@@ -576,6 +643,14 @@ pushAlways f = push (fmap Just . f)
576643ffor :: Functor f => f a -> (a -> b) -> f b
577644ffor = flip fmap
578645
646+-- | Rotated version of 'liftA2'.
647+ffor2 :: Applicative f => f a -> f b -> (a -> b -> c) -> f c
648+ffor2 a b f = liftA2 f a b
649+
650+-- | Rotated version of 'liftA3'.
651+ffor3 :: Applicative f => f a -> f b -> f c -> (a -> b -> c -> d) -> f d
652+ffor3 a b c f = liftA3 f a b c
653+
579654instance Reflex t => Applicative (Behavior t) where
580655 pure = constant
581656 f <*> x = pull $ sample f `ap` sample x
@@ -603,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
603678 a >>= f = pull $ sample a >>= sample . f
604679 -- 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.
605680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
606682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
607684
608685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
609686 mempty = constant mempty
@@ -619,40 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
619696 negate = fmap negate
620697 signum = fmap signum
621698
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+
622708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
623709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
624710 sconcat = pull . fmap sconcat . mapM sample
625−#if MIN_VERSION_semigroups(0,17,0)
626711 stimes n = fmap $ stimes n
627−#else
628− times1p n = fmap $ times1p n
629−#endif
630712
631−-- | Flipped version of 'fmapMaybe'.
632−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
633−fforMaybe = flip fmapMaybe
713+-- | Alias for 'mapMaybe'
714+fmapMaybe :: Filterable f => (a -> Maybe b) -> f a -> f b
715+fmapMaybe = mapMaybe
716+
717+-- | Flipped version of 'mapMaybe'.
718+fforMaybe :: Filterable f => f a -> (a -> Maybe b) -> f b
719+fforMaybe = flip mapMaybe
634720
635721-- | Filter 'f a' using the provided predicate.
636−-- Relies on 'fforMaybe'.
637−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
638−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
722+ffilter :: Filterable f => (a -> Bool) -> f a -> f a
723+ffilter = W.filter
639724
640725-- | Filter 'Left's from 'f (Either a b)' into 'a'.
641−filterLeft :: FunctorMaybe f => f (Either a b) -> f a
642−filterLeft = fmapMaybe (either Just (const Nothing))
726+filterLeft :: Filterable f => f (Either a b) -> f a
727+filterLeft = mapMaybe (either Just (const Nothing))
643728
644729-- | Filter 'Right's from 'f (Either a b)' into 'b'.
645−filterRight :: FunctorMaybe f => f (Either a b) -> f b
646−filterRight = fmapMaybe (either (const Nothing) Just)
730+filterRight :: Filterable f => f (Either a b) -> f b
731+filterRight = mapMaybe (either (const Nothing) Just)
647732
648733-- | Left-biased event union (prefers left event on simultaneous
649734-- occurrence).
650735instance Reflex t => Alt (Event t) where
651736 ev1 <!> ev2 = leftmost [ev1, ev2]
652737
653−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
654739instance Reflex t => Apply (Event t) where
655− 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+
656744
657745-- | 'Event' intersection (convenient interface to 'coincidence').
658746instance Reflex t => Bind (Event t) where
@@ -661,13 +749,18 @@ instance Reflex t => Bind (Event t) where
661749
662750instance Reflex t => Functor (Event t) where
663751 {-# INLINE fmap #-}
664− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
665753 {-# INLINE (<$) #-}
666754 x <$ e = fmapCheap (const x) e
667755
756+-- TODO Remove this instance
668757instance Reflex t => FunctorMaybe (Event t) where
669758 {-# INLINE fmapMaybe #-}
670− fmapMaybe f = push $ return . f
759+ fmapMaybe = mapMaybe
760+
761+instance Reflex t => Filterable (Event t) where
762+ {-# INLINE mapMaybe #-}
763+ mapMaybe f = push $ return . f
671764
672765-- | Never: @'zero' = 'never'@.
673766instance Reflex t => Plus (Event t) where
@@ -678,7 +771,13 @@ instance Reflex t => Plus (Event t) where
678771tag :: Reflex t => Behavior t b -> Event t a -> Event t b
679772tag b = pushAlways $ \_ -> sample b
680773
681−-- | Create a new 'Event' that combines occurences of supplied 'Event' with the
774+-- | Replace each occurrence value of the 'Event' with the value of the
775+-- 'Behavior' at that time; if it is 'Just', fire with the contained value; if
776+-- it is 'Nothing', drop the occurrence.
777+tagMaybe :: Reflex t => Behavior t (Maybe b) -> Event t a -> Event t b
778+tagMaybe b = push $ \_ -> sample b
779+
780+-- | Create a new 'Event' that combines occurrences of supplied 'Event' with the
682781-- current value of the 'Behavior'.
683782attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
684783attach = attachWith (,)
@@ -688,53 +787,118 @@ attach = attachWith (,)
688787attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
689788attachWith f = attachWithMaybe $ \a b -> Just $ f a b
690789
691−-- | Create a new 'Event' by combining each occurence with the current value of
790+-- | Create a new 'Event' by combining each occurrence with the current value of
692791-- the 'Behavior'. The occurrence is discarded if the combining function returns
693792-- Nothing
694793attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
695794attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
696795
697−-- | Create a new 'Event' that occurs on all but the first occurence of the
796+-- | Create a new 'Event' that occurs on all but the first occurrence of the
698797-- supplied 'Event'.
699−tailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
798+tailE :: (Reflex t, MonadHold t m) => Event t a -> m (Event t a)
700799tailE e = snd <$> headTailE e
701800
702−-- | Create a tuple of two 'Event's with the first one occuring only the first
703−-- time the supplied 'Event' occurs and the second occuring on all but the first
704−-- occurence.
705−headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
801+-- | Create a tuple of two 'Event's with the first one occurring only the first
802+-- time the supplied 'Event' occurs and the second occurring on all but the first
803+-- occurrence.
804+headTailE :: (Reflex t, MonadHold t m) => Event t a -> m (Event t a, Event t a)
706805headTailE e = do
707806 eHead <- headE e
708807 be <- hold never $ fmap (const e) eHead
709808 return (eHead, switch be)
710809
711−-- | Starting at the current time, fire all the occurrences of the 'Event' for
712−-- which the given predicate returns 'True'. When 'False' is returned, do not
713−-- fire, and permanently stop firing, even if 'True' values are encountered
714−-- later.
715−takeWhileE :: forall t m a. (Reflex t, MonadFix m, MonadHold t m) => (a -> Bool) -> Event t a -> m (Event t a)
716−takeWhileE f e = do
717− rec let (eFalse, eTrue) = fanEither $ ffor e' $ \a -> if f a
718− then Right a
719− else Left never
720− be <- hold e eFalse
721− let e' = switch be
810+-- | Take the streak of occurrences starting at the current time for which the
811+-- event returns 'True'.
812+--
813+-- Starting at the current time, fire all the occurrences of the 'Event' for
814+-- which the given predicate returns 'True'. When first 'False' is returned,
815+-- do not fire, and permanently stop firing, even if 'True' values would have
816+-- been encountered later.
817+takeWhileE
818+ :: forall t m a
819+ . (Reflex t, MonadFix m, MonadHold t m)
820+ => (a -> Bool)
821+ -> Event t a
822+ -> m (Event t a)
823+takeWhileE f = takeWhileJustE $ \v -> guard (f v) $> v
824+
825+-- | Take the streak of occurrences starting at the current time for which the
826+-- event returns 'Just b'.
827+--
828+-- Starting at the current time, fire all the occurrences of the 'Event' for
829+-- which the given predicate returns 'Just b'. When first 'Nothing' is returned,
830+-- do not fire, and permanently stop firing, even if 'Just b' values would have
831+-- been encountered later.
832+takeWhileJustE
833+ :: forall t m a b
834+ . (Reflex t, MonadFix m, MonadHold t m)
835+ => (a -> Maybe b)
836+ -> Event t a
837+ -> m (Event t b)
838+takeWhileJustE f e = do
839+ rec let (eBad, eTrue) = fanEither $ ffor e' $ \a -> case f a of
840+ Nothing -> Left never
841+ Just b -> Right b
842+ eFirstBad <- headE eBad
843+ e' <- switchHold e eFirstBad
722844 return eTrue
723845
724−-- | Split the supplied 'Event' into two individual 'Event's occuring at the
846+-- | Drop the streak of occurrences starting at the current time for which the
847+-- event returns 'True'.
848+--
849+-- Starting at the current time, do not fire all the occurrences of the 'Event'
850+-- for which the given predicate returns 'True'. When 'False' is first
851+-- returned, do fire, and permanently continue firing, even if 'True' values
852+-- would have been encountered later.
853+dropWhileE
854+ :: forall t m a
855+ . (Reflex t, MonadFix m, MonadHold t m)
856+ => (a -> Bool)
857+ -> Event t a
858+ -> m (Event t a)
859+dropWhileE f e = snd <$> takeDropWhileJustE (\v -> guard (f v) $> v) e
860+
861+-- | Both take and drop the streak of occurrences starting at the current time
862+-- for which the event returns 'Just b'.
863+--
864+-- For the left event, starting at the current time, fire all the occurrences
865+-- of the 'Event' for which the given function returns 'Just b'. When
866+-- 'Nothing' is returned, do not fire, and permanently stop firing, even if
867+-- 'Just b' values would have been encountered later.
868+--
869+-- For the right event, do not fire until the first occurrence where the given
870+-- function returns 'Nothing', and fire that one and all subsequent
871+-- occurrences. Even if the function would have again returned 'Just b', keep
872+-- on firing.
873+takeDropWhileJustE
874+ :: forall t m a b
875+ . (Reflex t, MonadFix m, MonadHold t m)
876+ => (a -> Maybe b)
877+ -> Event t a
878+ -> m (Event t b, Event t a)
879+takeDropWhileJustE f e = do
880+ rec let (eBad, eGood) = fanEither $ ffor e' $ \a -> case f a of
881+ Nothing -> Left ()
882+ Just b -> Right b
883+ eFirstBad <- headE eBad
884+ e' <- switchHold e (never <$ eFirstBad)
885+ eRest <- switchHoldPromptOnly never (e <$ eFirstBad)
886+ return (eGood, eRest)
887+
888+-- | Split the supplied 'Event' into two individual 'Event's occurring at the
725889-- same time with the respective values from the tuple.
726890splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
727891splitE e = (fmap fst e, fmap snd e)
728892
729893-- | Print the supplied 'String' and the value of the 'Event' on each
730−-- occurence. This should /only/ be used for debugging.
894+-- occurrence. This should /only/ be used for debugging.
731895--
732896-- Note: As with Debug.Trace.trace, the message will only be printed if the
733897-- 'Event' is actually used.
734898traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
735899traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
736900
737−-- | Print the output of the supplied function on each occurence of the
901+-- | Print the output of the supplied function on each occurrence of the
738902-- 'Event'. This should /only/ be used for debugging.
739903--
740904-- Note: As with Debug.Trace.trace, the message will only be printed if the
@@ -745,11 +909,7 @@ traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
745909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
746910 (<>) = alignWith (mergeThese (<>))
747911 sconcat = fmap sconcat . mergeList . toList
748−#if MIN_VERSION_semigroups(0,17,0)
749912 stimes n = fmap $ stimes n
750−#else
751− times1p n = fmap $ times1p n
752−#endif
753913
754914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
755915 mempty = never
@@ -778,21 +938,30 @@ leftmost :: Reflex t => [Event t a] -> Event t a
778938leftmost = mergeWith const
779939
780940-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
781−-- list occurs and has a list of the values of all 'Event's occuring at that
941+-- list occurs and has a list of the values of all 'Event's occurring at that
782942-- time.
783943mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
784944mergeList [] = never
785945mergeList es = mergeWithFoldCheap' id es
786946
787−unsafeMapIncremental :: (Reflex t, Patch p, Patch p') => (PatchTarget p -> PatchTarget p') -> (p -> p') -> Incremental t p -> Incremental t p'
947+unsafeMapIncremental
948+ :: (Reflex t, Patch p, Patch p')
949+ => (PatchTarget p -> PatchTarget p')
950+ -> (p -> p')
951+ -> Incremental t p
952+ -> Incremental t p'
788953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
789954
790955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
791956-- occurs if at least one of them occurs and has a map of values of all 'Event's
792−-- occuring at that time.
957+-- occurring at that time.
793958mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
794959mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
795960
961+-- | Like 'mergeMap' but for 'IntMap'.
962+mergeIntMap :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
963+mergeIntMap = fmap dmapToIntMap . merge . intMapWithFunctorToDMap
964+
796965-- | Create a merge whose parents can change over time
797966mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
798967mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
@@ -810,7 +979,7 @@ fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
810979fanEither e =
811980 let justLeft = either Just (const Nothing)
812981 justRight = either (const Nothing) Just
813− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
814983
815984-- | Split the event into separate events for 'This' and 'That' values,
816985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -822,7 +991,7 @@ fanThese e =
822991 that (That y) = Just y
823992 that (These _ y) = Just y
824993 that _ = Nothing
825− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
826995
827996-- | Split the event into an 'EventSelector' that allows efficient selection of
828997-- the individual 'Event's.
@@ -831,7 +1000,7 @@ fanMap = fan . fmap mapToDMap
8311000
8321001-- | Switches to the new event whenever it receives one. Only the old event is
8331002-- considered the moment a new one is switched in; the output event will fire at
834−-- that moment if only if the old event does.
1003+-- that moment only if the old event does.
8351004--
8361005-- Because the simultaneous firing case is irrelevant, this function imposes
8371006-- laxer "timing requirements" on the overall circuit, avoiding many potential
@@ -871,17 +1040,85 @@ switchHoldPromptOnly e0 e' = do
8711040 eLag <- switch <$> hold e0 e'
8721041 return $ coincidence $ leftmost [e', eLag <$ eLag]
8731042
1043+-- | When the given outer event fires, condense the inner events into the contained patch. Non-firing inner events will be replaced with deletions.
1044+coincidencePatchMap :: (Reflex t, Ord k) => Event t (PatchMap k (Event t v)) -> Event t (PatchMap k v)
1045+coincidencePatchMap e = fmapCheap PatchMap $ coincidence $ ffor e $ \(PatchMap m) -> mergeMap $ ffor m $ \case
1046+ Nothing -> fmapCheap (const Nothing) e
1047+ Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
1048+
1049+-- | See 'coincidencePatchMap'
1050+coincidencePatchIntMap :: Reflex t => Event t (PatchIntMap (Event t v)) -> Event t (PatchIntMap v)
1051+coincidencePatchIntMap e = fmapCheap PatchIntMap $ coincidence $ ffor e $ \(PatchIntMap m) -> mergeIntMap $ ffor m $ \case
1052+ Nothing -> fmapCheap (const Nothing) e
1053+ Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
1054+
1055+-- | See 'coincidencePatchMap'
1056+coincidencePatchMapWithMove :: (Reflex t, Ord k) => Event t (PatchMapWithMove k (Event t v)) -> Event t (PatchMapWithMove k v)
1057+coincidencePatchMapWithMove e = fmapCheap unsafePatchMapWithMove $ coincidence $ ffor e $ \p -> mergeMap $ ffor (unPatchMapWithMove p) $ \ni -> case PatchMapWithMove._nodeInfo_from ni of
1058+ PatchMapWithMove.From_Delete -> fforCheap e $ \_ ->
1059+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
1060+ PatchMapWithMove.From_Move k -> fforCheap e $ \_ ->
1061+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Move k }
1062+ PatchMapWithMove.From_Insert ev -> leftmost
1063+ [ fforCheap ev $ \v ->
1064+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Insert v }
1065+ , fforCheap e $ \_ ->
1066+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
1067+ ]
1068+
1069+-- | Given a 'PatchTarget' of events (e.g., a 'Map' with 'Event' values) and an event of 'Patch'es
1070+-- (e.g., a 'PatchMap' with 'Event' values), produce an 'Event' of the 'PatchTarget' type that
1071+-- fires with the patched value.
1072+switchHoldPromptOnlyIncremental
1073+ :: forall t m p pt w
1074+ . ( Reflex t
1075+ , MonadHold t m
1076+ , Patch (p (Event t w))
1077+ , PatchTarget (p (Event t w)) ~ pt (Event t w)
1078+ , Patch (p w)
1079+ , PatchTarget (p w) ~ pt w
1080+ , Monoid (pt w)
1081+ )
1082+ => (Incremental t (p (Event t w)) -> Event t (pt w))
1083+ -> (Event t (p (Event t w)) -> Event t (p w))
1084+ -> pt (Event t w)
1085+ -> Event t (p (Event t w))
1086+ -> m (Event t (pt w))
1087+switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch e0 e' = do
1088+ lag <- mergePatchIncremental <$> holdIncremental e0 e'
1089+ pure $ ffor (align lag (coincidencePatch e')) $ \case
1090+ This old -> old
1091+ That new -> new `applyAlways` mempty
1092+ These old new -> new `applyAlways` old
1093+
8741094instance Reflex t => Align (Event t) where
8751095 nil = never
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
8761099 align = alignEventWithMaybe Just
8771100
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+
8781115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
879−-- the 'Behavior' is true at the time of occurence.
1116+-- the 'Behavior' is true at the time of occurrence.
8801117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
8811118gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
8821119
883−-- | Create a new behavior given a starting behavior and switch to a the behvior
884−-- carried by the event when it fires.
1120+-- | Create a new behavior given a starting behavior and switch to the behavior
1121+-- carried by the event when it fires.
8851122switcher :: (Reflex t, MonadHold t m)
8861123 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
8871124switcher b eb = pull . (sample <=< sample) <$> hold b eb
@@ -896,7 +1133,7 @@ zipDyn = zipDynWith (,)
8961133
8971134-- | Combine two 'Dynamic's with a combining function. The result will change
8981135-- whenever either (or both) input 'Dynamic' changes.
899−-- More efficient than liftA2.
1136+-- More efficient than 'liftA2'.
9001137zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
9011138zipDynWith f da db =
9021139 let eab = align (updated da) (updated db)
@@ -914,11 +1151,7 @@ zipDynWith f da db =
9141151
9151152instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
9161153 (<>) = zipDynWith (<>)
917−#if MIN_VERSION_semigroups(0,17,0)
9181154 stimes n = fmap $ stimes n
919−#else
920− times1p n = fmap $ times1p n
921−#endif
9221155
9231156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
9241157 mconcat = distributeListOverDynWith mconcat
@@ -927,14 +1160,23 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
9271160
9281161-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
9291162-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
930−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
1163+-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
9311164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
932−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
9331175 [] -> constDyn DMap.empty
934− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
9351177 _ ->
936− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
937− edmPre = merge $ DMap.map updated dm
1178+ let getInitial = DMap.traverseWithKey (\_ -> sample . current . nt) dm
1179+ edmPre = mergeG getCompose $ DMap.map (Compose . updated . nt) dm
9381180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
9391181 olds <- sample $ current result
9401182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -946,21 +1188,73 @@ distributeListOverDyn = distributeListOverDynWith id
9461188
9471189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
9481190distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
949−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
9501201
9511202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
9521203-- unless the second supplied 'Event' occurs simultaneously.
9531204difference :: Reflex t => Event t a -> Event t b -> Event t a
9541205difference = alignEventWithMaybe $ \case
9551206 This a -> Just a
956− _ -> Nothing
1207+ _ -> Nothing
9571208
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
1210+-- 'Nothing' values are dropped.
9581211alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
959−alignEventWithMaybe f ea eb =
960− fmapMaybe (f <=< dmapToThese)
961− $ merge
962− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
963−
1212+alignEventWithMaybe f ea eb = mapMaybe (f <=< dmapToThese) $
1213+ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1214+
1215+-- | Produces an 'Event' that fires only when the input event fires with a 'DSum' key that
1216+-- matches the provided key.
1217+filterEventKey
1218+ :: forall t m k v a.
1219+ ( Reflex t
1220+ , MonadFix m
1221+ , MonadHold t m
1222+ , GEq k
1223+ )
1224+ => k a
1225+ -> Event t (DSum k v)
1226+ -> m (Event t (v a))
1227+filterEventKey k kv' = do
1228+ let f :: DSum k v -> Maybe (v a)
1229+ f (newK :=> newV) = case newK `geq` k of
1230+ Just Refl -> Just newV
1231+ Nothing -> Nothing
1232+ takeWhileJustE f kv'
1233+
1234+-- | "Factor" the input 'DSum' 'Event' to produce an 'Event' which
1235+-- fires when the 'DSum' key changes and contains both the value of the
1236+-- 'DSum' at switchover and an 'Event' of values produced by subsequent
1237+-- firings of the input 'Event' that do not change the 'DSum' key.
1238+factorEvent
1239+ :: forall t m k v a.
1240+ ( Reflex t
1241+ , MonadFix m
1242+ , MonadHold t m
1243+ , GEq k
1244+ )
1245+ => k a
1246+ -> Event t (DSum k v)
1247+ -> m (Event t (v a), Event t (DSum k (Product v (Compose (Event t) v))))
1248+factorEvent k0 kv' = do
1249+ key :: Behavior t (Some k) <- hold (Some k0) $ fmapCheap (\(k :=> _) -> Some k) kv'
1250+ let update = flip push kv' $ \(newKey :=> newVal) -> sample key >>= \case
1251+ Some oldKey -> case newKey `geq` oldKey of
1252+ Just Refl -> return Nothing
1253+ Nothing -> do
1254+ newInner <- filterEventKey newKey kv'
1255+ return $ Just $ newKey :=> Pair newVal (Compose newInner)
1256+ eInitial <- filterEventKey k0 kv'
1257+ return (eInitial, update)
9641258
9651259--------------------------------------------------------------------------------
9661260-- Accumulator
@@ -990,26 +1284,94 @@ class Reflex t => Accumulator t f | f -> t where
9901284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
9911285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
9921286
993−accumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Dynamic t a)
1287+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1288+-- with the provided function. See 'foldDyn'.
1289+accumDyn
1290+ :: (Reflex t, MonadHold t m, MonadFix m)
1291+ => (a -> b -> a)
1292+ -> a
1293+ -> Event t b
1294+ -> m (Dynamic t a)
9941295accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
995−accumMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Dynamic t a)
1296+
1297+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1298+-- with the provided 'PushM' action.
1299+accumMDyn
1300+ :: (Reflex t, MonadHold t m, MonadFix m)
1301+ => (a -> b -> PushM t a)
1302+ -> a
1303+ -> Event t b
1304+ -> m (Dynamic t a)
9961305accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
997−accumMaybeDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Dynamic t a)
1306+
1307+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1308+-- with the provided function, discarding 'Nothing' results.
1309+accumMaybeDyn
1310+ :: (Reflex t, MonadHold t m, MonadFix m)
1311+ => (a -> b -> Maybe a)
1312+ -> a
1313+ -> Event t b
1314+ -> m (Dynamic t a)
9981315accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
999−accumMaybeMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Dynamic t a)
1316+
1317+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1318+-- with the provided 'PushM' action, discarding 'Nothing' results.
1319+accumMaybeMDyn
1320+ :: (Reflex t, MonadHold t m, MonadFix m)
1321+ => (a -> b -> PushM t (Maybe a))
1322+ -> a
1323+ -> Event t b
1324+ -> m (Dynamic t a)
10001325accumMaybeMDyn f z e = do
10011326 rec let e' = flip push e $ \o -> do
10021327 v <- sample $ current d'
10031328 f v o
10041329 d' <- holdDyn z e'
10051330 return d'
1006−mapAccumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
1331+
1332+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1333+-- with a function that both accumulates and produces a value to fire
1334+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
1335+mapAccumDyn
1336+ :: (Reflex t, MonadHold t m, MonadFix m)
1337+ => (a -> b -> (a, c))
1338+ -> a
1339+ -> Event t b
1340+ -> m (Dynamic t a, Event t c)
10071341mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1008−mapAccumMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
1342+
1343+-- | Similar to 'mapAccumDyn' except that the combining function is a
1344+-- 'PushM' action.
1345+mapAccumMDyn
1346+ :: (Reflex t, MonadHold t m, MonadFix m)
1347+ => (a -> b -> PushM t (a, c))
1348+ -> a
1349+ -> Event t b
1350+ -> m (Dynamic t a, Event t c)
10091351mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1010−mapAccumMaybeDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
1352+
1353+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event' with
1354+-- a function that both optionally accumulates and optionally produces
1355+-- a value to fire as a separate output 'Event'.
1356+-- Note that because 'Nothing's are discarded in both cases, the output
1357+-- 'Event' may fire even though the output 'Dynamic' has not changed, and
1358+-- the output 'Dynamic' may update even when the output 'Event' is not firing.
1359+mapAccumMaybeDyn
1360+ :: (Reflex t, MonadHold t m, MonadFix m)
1361+ => (a -> b -> (Maybe a, Maybe c))
1362+ -> a
1363+ -> Event t b
1364+ -> m (Dynamic t a, Event t c)
10111365mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1012−mapAccumMaybeMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
1366+
1367+-- | Like 'mapAccumMaybeDyn' except that the combining function is a
1368+-- 'PushM' action.
1369+mapAccumMaybeMDyn
1370+ :: (Reflex t, MonadHold t m, MonadFix m)
1371+ => (a -> b -> PushM t (Maybe a, Maybe c))
1372+ -> a
1373+ -> Event t b
1374+ -> m (Dynamic t a, Event t c)
10131375mapAccumMaybeMDyn f z e = do
10141376 rec let e' = flip push e $ \o -> do
10151377 v <- sample $ current d'
@@ -1017,18 +1379,42 @@ mapAccumMaybeMDyn f z e = do
10171379 return $ case result of
10181380 (Nothing, Nothing) -> Nothing
10191381 _ -> Just result
1020− d' <- holdDyn z $ fmapMaybe fst e'
1021− return (d', fmapMaybe snd e')
1382+ d' <- holdDyn z $ mapMaybe fst e'
1383+ return (d', mapMaybe snd e')
10221384
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
10231387{-# INLINE accumB #-}
1024−accumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Behavior t a)
1388+accumB
1389+ :: (Reflex t, MonadHold t m, MonadFix m)
1390+ => (a -> b -> a)
1391+ -> a
1392+ -> Event t b
1393+ -> m (Behavior t a)
10251394accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
10261397{-# INLINE accumMB #-}
1027−accumMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Behavior t a)
1398+accumMB
1399+ :: (Reflex t, MonadHold t m, MonadFix m)
1400+ => (a -> b -> PushM t a)
1401+ -> a
1402+ -> Event t b
1403+ -> m (Behavior t a)
10281404accumMB 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.
10291408{-# INLINE accumMaybeB #-}
1030−accumMaybeB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Behavior t a)
1409+accumMaybeB
1410+ :: (Reflex t, MonadHold t m, MonadFix m)
1411+ => (a -> b -> Maybe a)
1412+ -> a
1413+ -> Event t b
1414+ -> m (Behavior t a)
10311415accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
10321418{-# INLINE accumMaybeMB #-}
10331419accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
10341420accumMaybeMB f z e = do
@@ -1037,16 +1423,42 @@ accumMaybeMB f z e = do
10371423 f v o
10381424 d' <- hold z e'
10391425 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'.
10401430{-# INLINE mapAccumB #-}
1041−mapAccumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Behavior t a, Event t c)
1431+mapAccumB
1432+ :: (Reflex t, MonadHold t m, MonadFix m)
1433+ => (a -> b -> (a, c))
1434+ -> a
1435+ -> Event t b
1436+ -> m (Behavior t a, Event t c)
10421437mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
10431440{-# INLINE mapAccumMB #-}
1044−mapAccumMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Behavior t a, Event t c)
1441+mapAccumMB
1442+ :: (Reflex t, MonadHold t m, MonadFix m)
1443+ => (a -> b -> PushM t (a, c))
1444+ -> a
1445+ -> Event t b
1446+ -> m (Behavior t a, Event t c)
10451447mapAccumMB 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.
10461452{-# INLINE mapAccumMaybeB #-}
1047−mapAccumMaybeB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Behavior t a, Event t c)
1453+mapAccumMaybeB
1454+ :: (Reflex t, MonadHold t m, MonadFix m)
1455+ => (a -> b -> (Maybe a, Maybe c))
1456+ -> a
1457+ -> Event t b
1458+ -> m (Behavior t a, Event t c)
10481459mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
10491460
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
10501462{-# INLINE mapAccumMaybeMB #-}
10511463mapAccumMaybeMB :: (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)
10521464mapAccumMaybeMB f z e = do
@@ -1056,8 +1468,8 @@ mapAccumMaybeMB f z e = do
10561468 return $ case result of
10571469 (Nothing, Nothing) -> Nothing
10581470 _ -> Just result
1059− d' <- hold z $ fmapMaybe fst e'
1060− return (d', fmapMaybe snd e')
1471+ d' <- hold z $ mapMaybe fst e'
1472+ return (d', mapMaybe snd e')
10611473
10621474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
10631475-- time. Discard the underlying 'Accumulator'.
@@ -1104,7 +1516,7 @@ instance Reflex t => Accumulator t (Event t) where
11041516 accumMaybeM f z e = updated <$> accumMaybeM f z e
11051517 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
11061518
1107−-- | Create a new 'Event' by combining each occurence with the next value of the
1519+-- | Create a new 'Event' by combining each occurrence with the next value of the
11081520-- list using the supplied function. If the list runs out of items, all
11091521-- subsequent 'Event' occurrences will be ignored.
11101522zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
@@ -1114,17 +1526,17 @@ zipListWithEvent f l e = do
11141526 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
11151527 mapAccumMaybe_ f' l e
11161528
1117−-- | Assign a number to each occurence of the given 'Event', starting from 0
1529+-- | Assign a number to each occurrence of the given 'Event', starting from 0
11181530{-# INLINE numberOccurrences #-}
11191531numberOccurrences :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Event t (b, a))
11201532numberOccurrences = numberOccurrencesFrom 0
11211533
1122−-- | Assign a number to each occurence of the given 'Event'
1534+-- | Assign a number to each occurrence of the given 'Event'
11231535{-# INLINE numberOccurrencesFrom #-}
11241536numberOccurrencesFrom :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t (b, a))
11251537numberOccurrencesFrom = mapAccum_ (\n a -> let !next = n + 1 in (next, (n, a)))
11261538
1127−-- | Assign a number to each occurence of the given 'Event'; discard the occurrences' values
1539+-- | Assign a number to each occurrence of the given 'Event'; discard the occurrences' values
11281540{-# INLINE numberOccurrencesFrom_ #-}
11291541numberOccurrencesFrom_ :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t b)
11301542numberOccurrencesFrom_ = mapAccum_ (\n _ -> let !next = n + 1 in (next, n))
@@ -1197,83 +1609,74 @@ infixl 4 <@>
11971609(<@) = tag
11981610infixl 4 <@
11991611
1200−------------------
1201−-- Adjustable
1202−------------------
1203−
1204−-- | A 'Monad' that supports adjustment over time. After an action has been
1205−-- run, if the given events fire, it will adjust itself so that its net effect
1206−-- is as though it had originally been run with the new value. Note that there
1207−-- is some issue here with persistent side-effects: obviously, IO (and some
1208−-- other side-effects) cannot be undone, so it is up to the instance implementer
1209−-- to determine what the best meaning for this class is in such cases.
1210−class (Reflex t, Monad m) => Adjustable t m | m -> t where
1211− runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
1212− traverseIntMapWithKeyWithAdjust :: (IntMap.Key -> v -> m v') -> IntMap v -> Event t (PatchIntMap v) -> m (IntMap v', Event t (PatchIntMap v'))
1213− traverseDMapWithKeyWithAdjust :: GCompare k => (forall a. k a -> v a -> m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> m (DMap k v', Event t (PatchDMap k v'))
1214− traverseDMapWithKeyWithAdjustWithMove :: GCompare k => (forall a. k a -> v a -> m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> m (DMap k v', Event t (PatchDMapWithMove k v'))
1215−
1216−instance Adjustable t m => Adjustable t (ReaderT r m) where
1217− runWithReplace a0 a' = do
1218− r <- ask
1219− lift $ runWithReplace (runReaderT a0 r) $ fmap (`runReaderT` r) a'
1220− traverseIntMapWithKeyWithAdjust f dm0 dm' = do
1221− r <- ask
1222− lift $ traverseIntMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1223− traverseDMapWithKeyWithAdjust f dm0 dm' = do
1224− r <- ask
1225− lift $ traverseDMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1226− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
1227− r <- ask
1228− lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
1229−
1230−sequenceDMapWithAdjust :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
1231−sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
1232−
1233−sequenceDMapWithAdjustWithMove :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
1234−sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
1235−
1236−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'))
1237−mapMapWithAdjustWithMove f m0 m' = do
1238− (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
1239− return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
1240−
12411612------------------
12421613-- Cheap Functions
12431614------------------
12441615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
12451617{-# INLINE pushAlwaysCheap #-}
12461618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
12471619pushAlwaysCheap f = pushCheap (fmap Just . f)
12481620
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'
12491627{-# INLINE fmapMaybeCheap #-}
12501628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1251−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
12521630
1631+
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
12531633{-# INLINE fforMaybeCheap #-}
12541634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1255−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
12561636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
12571638{-# INLINE fforCheap #-}
12581639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
12591640fforCheap = flip fmapCheap
12601641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
12611643{-# INLINE fmapCheap #-}
12621644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
12631645fmapCheap f = pushCheap $ return . Just . f
12641646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
12651648{-# INLINE tagCheap #-}
12661649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
12671650tagCheap b = pushAlwaysCheap $ \_ -> sample b
12681651
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'.
12691670{-# INLINE mergeWithCheap #-}
12701671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
12711672mergeWithCheap = mergeWithCheap' id
12721673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
12731675{-# INLINE mergeWithCheap' #-}
12741676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
12751677mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
12761678
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
12771680{-# INLINE mergeWithFoldCheap' #-}
12781681mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
12791682mergeWithFoldCheap' f es =
@@ -1286,34 +1689,11 @@ mergeWithFoldCheap' f es =
12861689-- Deprecated functions
12871690--------------------------------------------------------------------------------
12881691
1289−{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
1290−type MonadAdjust = Adjustable
1291−
1292−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
1293−-- occurs. If both occur at the same time they are combined using 'mappend'.
1294−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
1295−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
1296−appendEvents = alignWith $ mergeThese mappend
1297−
1298−-- | Alias for 'headE'
1299−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1300−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
1301−onceE = headE
1302−
1303−-- | Run both sides of a 'These' monadically, combining the results.
1304−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
1305−#ifdef USE_TEMPLATE_HASKELL
1306−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
1307−#endif
1308−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
1309−sequenceThese t = case t of
1310− This ma -> fmap This ma
1311− These ma mb -> liftM2 These ma mb
1312− That mb -> fmap That mb
1313−
13141692{-# 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'
13151694switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
13161695switchPromptly = switchHoldPromptly
13171696{-# 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'
13181698switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
13191699switchPromptOnly = switchHoldPromptOnly
src/Reflex/Collection.hs+164−60
@@ -1,22 +1,23 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE RankNTypes #-}
2+{-# LANGUAGE FlexibleInstances #-}
33{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE RankNTypes #-}
46{-# LANGUAGE RecursiveDo #-}
57{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE FlexibleInstances #-}
98{-# LANGUAGE TypeFamilies #-}
109{-# LANGUAGE UndecidableInstances #-}
1110#ifdef USE_REFLEX_OPTIMIZER
1211{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1312#endif
13+-- |
14+-- Module:
15+-- Reflex.Collection
1416module Reflex.Collection
15− (
17+ (
1618 -- * Widgets on Collections
1719 listHoldWithKey
1820 , listWithKey
19− , listWithKey'
2021 , listWithKeyShallowDiff
2122 , listViewWithKey
2223 , selectViewListWithKey
@@ -26,96 +27,199 @@ module Reflex.Collection
2627 , simpleList
2728 ) where
2829
29−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
30+#ifdef MIN_VERSION_semialign
31+import Prelude hiding (zip, zipWith)
32+#if MIN_VERSION_semialign(1,1,0)
33+import Data.Zip (Zip (..))
34+#endif
35+#endif
36+
37+import Control.Monad.Identity
3038import Data.Align
39+import Data.Functor.Misc
3140import Data.Map (Map)
3241import qualified Data.Map as Map
33−import Data.Functor.Misc
3442import Data.Map.Misc
3543import Data.These
3644
3745import Reflex.Class
46+import Reflex.Adjustable.Class
3847import Reflex.Dynamic
3948import Reflex.PostBuild.Class
4049
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))
50+-- | Create a set of widgets based on the provided 'Map'. When the
51+-- input 'Event' fires, remove widgets for keys with the value 'Nothing'
52+-- and add/replace widgets for keys with 'Just' values.
53+listHoldWithKey
54+ :: forall t m k v a
55+ . (Ord k, Adjustable t m, MonadHold t m)
56+ => Map k v
57+ -> Event t (Map k (Maybe v))
58+ -> (k -> v -> m a)
59+ -> m (Dynamic t (Map k a))
4260listHoldWithKey m0 m' f = do
4361 let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
44− dm' = fmap (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey (\k v -> ComposeMaybe $ fmap (f k) v)) m'
62+ dm' = fmap
63+ (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey
64+ (\k v -> ComposeMaybe $ fmap (f k) v)
65+ )
66+ m'
4567 (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
4768
48−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
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))
69+ --TODO: Move the dmapToMap to the righthand side so it doesn't get
70+ --fully redone every time
71+ fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a'
72+
73+--TODO: Something better than Dynamic t (Map k v) - we want something
74+--where the Events carry diffs, not the whole value
75+listWithKey
76+ :: forall t k v m a
77+ . (Ord k, Adjustable t m, PostBuild t m, MonadFix m, MonadHold t m)
78+ => Dynamic t (Map k v)
79+ -> (k -> Dynamic t v -> m a)
80+ -> m (Dynamic t (Map k a))
5081listWithKey vals mkChild = do
5182 postBuild <- getPostBuild
5283 let childValChangedSelector = fanMap $ updated vals
53− -- We keep track of changes to children values in the mkChild function we pass to listHoldWithKey
54− -- The other changes we need to keep track of are child insertions and deletions. diffOnlyKeyChanges
55− -- keeps track of insertions and deletions but ignores value changes, since they're already accounted for.
56− diffOnlyKeyChanges olds news = flip Map.mapMaybe (align olds news) $ \case
57− This _ -> Just Nothing
58− These _ _ -> Nothing
59− That new -> Just $ Just new
84+
85+ -- We keep track of changes to children values in the mkChild
86+ -- function we pass to listHoldWithKey The other changes we need
87+ -- to keep track of are child insertions and
88+ -- deletions. diffOnlyKeyChanges keeps track of insertions and
89+ -- deletions but ignores value changes, since they're already
90+ -- accounted for.
91+ diffOnlyKeyChanges olds news =
92+ flip Map.mapMaybe (align olds news) $ \case
93+ This _ -> Just Nothing
94+ These _ _ -> Nothing
95+ That new -> Just $ Just new
6096 rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
6197 let changeVals :: Event t (Map k (Maybe v))
62− changeVals = attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
63− [ updated vals
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
65− ]
98+ changeVals =
99+ attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
100+ [ updated vals
101+
102+ -- TODO: This should probably be added to the
103+ -- attachWith, not to the updated; if we were using
104+ -- diffMap instead of diffMapNoEq, I think it might not
105+ -- work
106+ , tag (current vals) postBuild
107+ ]
66108 listHoldWithKey Map.empty changeVals $ \k v ->
67109 mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
68110
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)" #-}
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))
71−listWithKey' = listWithKeyShallowDiff
72−
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.
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))
111+-- | Display the given map of items (in key order) using the builder
112+-- function provided, and update it with the given event. 'Nothing'
113+-- update entries will delete the corresponding children, and 'Just'
114+-- entries will create them if they do not exist or send an update
115+-- event to them if they do.
116+listWithKeyShallowDiff
117+ :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m)
118+ => Map k v
119+ -> Event t (Map k (Maybe v))
120+ -> (k -> v -> Event t v -> m a)
121+ -> m (Dynamic t (Map k a))
75122listWithKeyShallowDiff initialVals valsChanged mkChild = do
76123 let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
77124 sentVals <- foldDyn applyMap (void initialVals) $ fmap (fmap void) valsChanged
78125 let relevantPatch patch _ = case patch of
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
80− Just _ -> Nothing -- We don't want to let spurious re-creations of items through
81− listHoldWithKey initialVals (attachWith (flip (Map.differenceWith relevantPatch)) (current sentVals) valsChanged) $ \k v ->
82− mkChild k v $ select childValChangedSelector $ Const2 k
83−
84−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
85−-- | Create a dynamically-changing set of Event-valued widgets.
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'.
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))
88−listViewWithKey vals mkChild = switch . fmap mergeMap <$> listViewWithKey' vals mkChild
89−
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))
126+
127+ -- Even if we let a Nothing through when the element doesn't
128+ -- already exist, this doesn't cause a problem because it is
129+ -- ignored
130+ Nothing -> Just Nothing
131+
132+ -- We don't want to let spurious re-creations of items through
133+ Just _ -> Nothing
134+ listHoldWithKey
135+ initialVals
136+ (attachWith (flip (Map.differenceWith relevantPatch))
137+ (current sentVals)
138+ valsChanged
139+ )
140+ $ \k v -> mkChild k v $ select childValChangedSelector $ Const2 k
141+
142+--TODO: Something better than Dynamic t (Map k v) - we want something
143+--where the Events carry diffs, not the whole value
144+-- | Create a dynamically-changing set of Event-valued widgets. This
145+-- is like 'listWithKey', specialized for widgets returning @/Event t a/@.
146+-- 'listWithKey' would return @/Dynamic t (Map k (Event t a))/@ in
147+-- this scenario, but 'listViewWithKey' flattens this to
148+-- @/Event t (Map k a)/@ via 'switch'.
149+listViewWithKey
150+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
151+ => Dynamic t (Map k v)
152+ -> (k -> Dynamic t v -> m (Event t a))
153+ -> m (Event t (Map k a))
154+listViewWithKey vals mkChild =
155+ switch . fmap mergeMap <$> listViewWithKey' vals mkChild
156+
157+listViewWithKey'
158+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
159+ => Dynamic t (Map k v)
160+ -> (k -> Dynamic t v -> m a)
161+ -> m (Behavior t (Map k a))
91162listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
92163
93−-- | Create a dynamically-changing set of widgets, one of which is selected at any time.
94−selectViewListWithKey :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
95− => Dynamic t k -- ^ Current selection key
96− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
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
98− -> m (Event t (k, a)) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
164+-- | Create a dynamically-changing set of widgets, one of which is
165+-- selected at any time.
166+selectViewListWithKey
167+ :: forall t m k v a
168+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
169+ => Dynamic t k
170+ -- ^ Current selection key
171+ -> Dynamic t (Map k v)
172+ -- ^ Dynamic key/value map
173+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
174+ -- ^ Function to create a widget for a given key from Dynamic value
175+ -- and Dynamic Bool indicating if this widget is currently selected
176+ -> m (Event t (k, a))
177+ -- ^ Event that fires when any child's return Event fires. Contains
178+ -- key of an arbitrary firing widget.
99179selectViewListWithKey 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
101182 selectChild <- listWithKey vals $ \k v -> do
102183 let selected = demuxed selectionDemux k
103184 selectSelf <- mkChild k v selected
104185 return $ fmap ((,) k) selectSelf
105186 return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
106187
107−selectViewListWithKey_ :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
108− => Dynamic t k -- ^ Current selection key
109− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
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
111− -> m (Event t k) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
112−selectViewListWithKey_ selection vals mkChild = fmap fst <$> selectViewListWithKey selection vals mkChild
188+-- | Like 'selectViewListWithKey' but discards the value of the list
189+-- item widget's output 'Event'.
190+selectViewListWithKey_
191+ :: forall t m k v a
192+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
193+ => Dynamic t k
194+ -- ^ Current selection key
195+ -> Dynamic t (Map k v)
196+ -- ^ Dynamic key/value map
197+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
198+ -- ^ Function to create a widget for a given key from Dynamic value
199+ -- and Dynamic Bool indicating if this widget is currently selected
200+ -> m (Event t k)
201+ -- ^ Event that fires when any child's return Event fires. Contains
202+ -- key of an arbitrary firing widget.
203+selectViewListWithKey_ selection vals mkChild =
204+ fmap fst <$> selectViewListWithKey selection vals mkChild
113205
114−-- | Create a dynamically-changing set of widgets from a Dynamic key/value map.
115−-- Unlike the 'withKey' variants, the child widgets are insensitive to which key they're associated with.
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))
206+-- | Create a dynamically-changing set of widgets from a Dynamic
207+-- key/value map. Unlike the 'withKey' variants, the child widgets
208+-- are insensitive to which key they're associated with.
209+list
210+ :: (Ord k, Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
211+ => Dynamic t (Map k v)
212+ -> (Dynamic t v -> m a)
213+ -> m (Dynamic t (Map k a))
117214list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
118215
119216-- | Create a dynamically-changing set of widgets from a Dynamic list.
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])
121−simpleList xs mkChild = fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap (Map.fromList . zip [(1::Int)..]) xs
217+simpleList
218+ :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
219+ => Dynamic t [v]
220+ -> (Dynamic t v -> m a)
221+ -> m (Dynamic t [a])
222+simpleList xs mkChild =
223+ fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap
224+ (Map.fromList . zip [(1 :: Int) ..])
225+ xs
src/Reflex/Dynamic.hs+66−216
@@ -17,8 +17,12 @@
1717#ifdef USE_REFLEX_OPTIMIZER
1818{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1919#endif
20−-- | This module contains various functions for working with 'Dynamic' values.
21−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
20+-- |
21+-- Module:
22+-- Reflex.Dynamic
23+-- Description:
24+-- This module contains various functions for working with 'Dynamic' values.
25+-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
2226module Reflex.Dynamic
2327 ( -- * Basics
2428 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
@@ -49,15 +53,18 @@ module Reflex.Dynamic
4953 , foldDynMaybe
5054 , foldDynMaybeM
5155 , joinDynThroughMap
56+ , joinDynThroughIntMap
5257 , traceDyn
5358 , traceDynWith
5459 , splitDynPure
5560 , distributeMapOverDynPure
61+ , distributeIntMapOverDynPure
5662 , distributeDMapOverDynPure
5763 , distributeListOverDynPure
5864 , Demux
5965 , demux
6066 , demuxed
67+ -- * Miscellaneous
6168 -- Things that probably aren't very useful:
6269 , HList (..)
6370 , FHList (..)
@@ -67,34 +74,14 @@ module Reflex.Dynamic
6774 , AllAreFunctors (..)
6875 , HListPtr (..)
6976 , distributeFHListOverDynPure
70− -- Unsafe
77+ -- * Unsafe
7178 , unsafeDynamic
72− -- * Deprecated functions
73− , apDyn
74− , attachDyn
75− , attachDynWith
76− , attachDynWithMaybe
77− , collectDyn
78− , combineDyn
79− , distributeDMapOverDyn
80− , distributeFHListOverDyn
81− , forDyn
82− , getDemuxed
83− , joinDyn
84− , mapDyn
85− , mconcatDyn
86− , nubDyn
87− , splitDyn
88− , tagDyn
89− , uniqDyn
90− , uniqDynBy
9179 ) where
9280
9381import Data.Functor.Compose
9482import Data.Functor.Misc
9583import Reflex.Class
9684
97−import Control.Applicative ((<*>))
9885import Control.Monad
9986import Control.Monad.Fix
10087import Control.Monad.Identity
@@ -102,11 +89,14 @@ import Data.Align
10289import Data.Dependent.Map (DMap)
10390import qualified Data.Dependent.Map as DMap
10491import Data.Dependent.Sum (DSum (..))
105−import Data.GADT.Compare ((:~:) (..), GCompare (..), GEq (..), GOrdering (..))
92+import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
93+import Data.IntMap (IntMap)
94+import qualified Data.IntMap as IntMap
10695import Data.Map (Map)
10796import Data.Maybe
108−import Data.Monoid
97+import Data.Monoid ((<>))
10998import Data.These
99+import Data.Type.Equality ((:~:) (..))
110100
111101import Debug.Trace
112102
@@ -129,7 +119,7 @@ holdUniqDyn = holdUniqDynBy (==)
129119holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
130120holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
131121
132−-- | Dynamic Maybe that can only update from Nothing to Just or Just to Just (i.e., cannot revert to Nothing)
122+-- | @/Dynamic Maybe/@ that can only update from @/Nothing/@ to @/Just/@ or @/Just/@ to @/Just/@ (i.e., cannot revert to @/Nothing/@)
133123improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
134124improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
135125
@@ -173,7 +163,7 @@ foldDynMaybe = accumMaybeDyn . flip
173163foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
174164foldDynMaybeM = accumMaybeMDyn . flip
175165
176−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
166+-- | Create a new 'Dynamic' that counts the occurrences of the 'Event'.
177167count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
178168count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
179169
@@ -194,9 +184,9 @@ switchDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
194184switchDyn d = switch (current d)
195185
196186-- | Switches to the new 'Event' whenever it receives one. Switching occurs
197−-- *before* the inner 'Event' fires - so if the 'Dynamic' changes and both the
187+-- __before__ the inner 'Event' fires - so if the 'Dynamic' changes and both the
198188-- old and new inner Events fire simultaneously, the output will fire with the
199−-- value of the *new* 'Event'.
189+-- value of the __new__ 'Event'.
200190--
201191-- Prefer 'switchDyn' to this where possible. The timing requirements that
202192-- switching before imposes are likely to bring down your app unless you are
@@ -216,28 +206,30 @@ splitDynPure d = (fmap fst d, fmap snd d)
216206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
217207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
218208
209+-- | Convert an 'IntMap' with 'Dynamic' elements into a 'Dynamic' of an 'IntMap' with
210+-- non-'Dynamic' elements.
211+distributeIntMapOverDynPure :: (Reflex t) => IntMap (Dynamic t v) -> Dynamic t (IntMap v)
212+distributeIntMapOverDynPure = fmap dmapToIntMap . distributeDMapOverDynPure . intMapWithFunctorToDMap
213+
219214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
220215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
221217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
222−distributeListOverDynPure =
223− fmap (map fromDSum . DMap.toAscList) .
224− distributeDMapOverDynPure .
225− DMap.fromDistinctAscList .
226− zipWith toDSum [0..]
227− where
228− toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
229− toDSum k v = Const2 k :=> v
230− fromDSum :: DSum (Const2 Int a) Identity -> a
231− fromDSum (Const2 _ :=> Identity v) = v
218+distributeListOverDynPure = distributeListOverDyn
232219
233220--TODO: Generalize this to functors other than Maps
234221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
235222-- with the current values of the 'Dynamic's in a map.
236223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
237−joinDynThroughMap = joinDyn . fmap distributeMapOverDynPure
224+joinDynThroughMap = (distributeMapOverDynPure =<<)
225+
226+-- | Combine a 'Dynamic' of an 'IntMap' of 'Dynamic's into a 'Dynamic'
227+-- with the current values of the 'Dynamic's in a map.
228+joinDynThroughIntMap :: forall t a. (Reflex t) => Dynamic t (IntMap (Dynamic t a)) -> Dynamic t (IntMap a)
229+joinDynThroughIntMap = (distributeIntMapOverDynPure =<<)
238230
239231-- | Print the value of the 'Dynamic' when it is first read and on each
240−-- subsequent change that is observed (as traceEvent), prefixed with the
232+-- subsequent change that is observed (as 'traceEvent'), prefixed with the
241233-- provided string. This should /only/ be used for debugging.
242234--
243235-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -247,7 +239,7 @@ traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
247239
248240-- | Print the result of applying the provided function to the value
249241-- of the 'Dynamic' when it is first read and on each subsequent change
250−-- that is observed (as traceEvent). This should /only/ be used for
242+-- that is observed (as 'traceEvent'). This should /only/ be used for
251243-- debugging.
252244--
253245-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -263,36 +255,35 @@ traceDynWith f d =
263255-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
264256-- each time the 'Event' occurs.
265257--
266−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
267−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
268−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
258+-- Note: @/tagPromptlyDyn d e/@ differs from @/tag (current d) e/@ in the case that @/e/@ is firing
259+-- at the same time that @/d/@ is changing. With @/tagPromptlyDyn d e/@, the __new__ value of @/d/@
260+-- will replace the value of @/e/@, whereas with @/tag (current d) e/@, the __old__ value
269261-- will be used, since the 'Behavior' won't be updated until the end of the frame.
270262-- Additionally, this means that the output 'Event' may not be used to directly change
271−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
272−-- cyclic data flows, generally `tag (current d) e` is preferred.
263+-- the input 'Dynamic', because that would mean its value depends on itself. __When creating__
264+-- __cyclic data flows, generally @/tag (current d) e/@ is preferred.__
273265tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
274266tagPromptlyDyn = attachPromptlyDynWith const
275267
276268-- | Attach the current value of the 'Dynamic' to the value of the
277269-- 'Event' each time it occurs.
278270--
279−-- Note: `attachPromptlyDyn d` is not the same as `attach (current d)`. See 'tagPromptlyDyn' for details.
271+-- Note: @/attachPromptlyDyn d/@ is not the same as @/attach (current d)/@. See 'tagPromptlyDyn' for details.
280272attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
281273attachPromptlyDyn = attachPromptlyDynWith (,)
282274
283275-- | Combine the current value of the 'Dynamic' with the value of the
284276-- 'Event' each time it occurs.
285277--
286−-- Note: `attachPromptlyDynWith f d` is not the same as `attachWith f (current d)`. See 'tagPromptlyDyn' for details.
278+-- Note: @/attachPromptlyDynWith f d/@ is not the same as @/attachWith f (current d)/@. See 'tagPromptlyDyn' for details.
287279attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
288280attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
289281
290−-- | Create a new 'Event' by combining the value at each occurence with the
282+-- | Create a new 'Event' by combining the value at each occurrence with the
291283-- current value of the 'Dynamic' value and possibly filtering if the combining
292284-- function returns 'Nothing'.
293285--
294−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
295−-- (current d)`. See 'tagPromptlyDyn' for details.
286+-- Note: @/attachPromptlyDynWithMaybe f d/@ is not the same as @/attachWithMaybe f (current d)/@. See 'tagPromptlyDyn' for details.
296287attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
297288attachPromptlyDynWithMaybe f d e =
298289 let e' = attach (current d) e
@@ -301,8 +292,8 @@ attachPromptlyDynWithMaybe f d e =
301292 These (_, b) a -> f a b -- Both events are firing, so use the newer value
302293 That _ -> Nothing -- The tagging event isn't firing, so don't fire
303294
304−-- | Factor a @Dynamic t (Maybe a)@ into a @Dynamic t (Maybe (Dynamic t a))@,
305−-- such that the outer 'Dynamic' is updated only when the 'Maybe''s constructor
295+-- | Factor a @/Dynamic t (Maybe a)/@ into a @/Dynamic t (Maybe (Dynamic t a))/@,
296+-- such that the outer 'Dynamic' is updated only when the "Maybe"'s constructor
306297-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
307298-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
308299-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
@@ -317,6 +308,8 @@ maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
317308 Left _ -> Nothing
318309 Right a -> Just a
319310
311+-- | Turns a 'Dynamic t (Either a b)' into a 'Dynamic t (Either (Dynamic t a) (Dynamic t b))' such that
312+-- the outer 'Dynamic' is updated only when the 'Either' constructor changes (e.g., from 'Left' to 'Right').
320313eitherDyn :: forall t a b m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Either a b) -> m (Dynamic t (Either (Dynamic t a) (Dynamic t b)))
321314eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
322315 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
@@ -324,26 +317,23 @@ eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
324317 LeftTag :=> Compose a -> Left $ coerceDynamic a
325318 RightTag :=> Compose b -> Right $ coerceDynamic b
326319
327−factorDyn :: forall t m k v. (Reflex t, MonadFix m, MonadHold t m, GEq k) => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
328−factorDyn d = do
329− let inner :: forall m' a. (MonadFix m', MonadHold t m') => k a -> v a -> m' (Dynamic t (v a))
330− inner k v0 = holdDyn v0 . fmapMaybe id =<< takeWhileE isJust newVal
331− where newVal = ffor (updated d) $ \(newK :=> newV) -> case newK `geq` k of
332− Just Refl -> Just newV
333− Nothing -> Nothing
334− getInitial = do
335− k0 :=> (v0 :: v a) <- sample $ current d
336− i0 <- inner k0 v0
337− return $ k0 :=> Compose i0
338− update = flip push (updated d) $ \(newKey :=> newVal) -> do
339− (oldKey :=> _) <- sample $ current d
340− case newKey `geq` oldKey of
341− Just Refl -> return Nothing
342− Nothing -> do
343− newInner <- inner newKey newVal
344− return $ Just $ newKey :=> Compose newInner
345− o0 <- getInitial --TODO: Figure out how to get this to run inside something like the first argument to buildDynamic
346− holdDyn o0 update
320+-- | Factor a 'Dynamic t DSum' into a 'Dynamic' 'DSum' containing nested 'Dynamic' values.
321+-- The outer 'Dynamic' updates only when the key of the 'DSum' changes, while the update of the inner
322+-- 'Dynamic' represents updates within the current key.
323+factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k)
324+ => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
325+factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
326+ update :: Event t (DSum k (Compose (Dynamic t) v))
327+ update = flip push (updated d) $ \(newKey :=> newVal) -> do
328+ (oldKey :=> _) <- sample (current d)
329+ case newKey `geq` oldKey of
330+ Just Refl -> return Nothing
331+ Nothing -> Just <$> holdKey (newKey :=> newVal)
332+
333+ holdKey (k :=> v) = do
334+ inner' <- filterEventKey k (updated d)
335+ inner <- holdDyn v inner'
336+ return $ k :=> Compose inner
347337
348338--------------------------------------------------------------------------------
349339-- Demux
@@ -358,7 +348,7 @@ factorDyn d = do
358348--
359349-- > demuxed (demux d) k === fmap (== k) d
360350--
361−-- However, the when getDemuxed is used multiple times, the complexity is only
351+-- However, when 'demuxed' is used multiple times, the complexity is only
362352-- /O(log(n))/, rather than /O(n)/ for fmap.
363353data Demux t k = Demux { demuxValue :: Behavior t k
364354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -428,21 +418,12 @@ data FHList f l where
428418 FHCons :: f e -> FHList f l -> FHList f (e ': l)
429419
430420instance GEq (HListPtr l) where
431−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
432− geqToEq _ = id
433− geqUnify HHeadPtr HHeadPtr _ same = same
434− geqUnify (HTailPtr a) (HTailPtr b) different same = geqUnify a b different same
435− geqUnify _ _ different _ = different
436−#endif
437421 HHeadPtr `geq` HHeadPtr = Just Refl
438422 HHeadPtr `geq` HTailPtr _ = Nothing
439423 HTailPtr _ `geq` HHeadPtr = Nothing
440424 HTailPtr a `geq` HTailPtr b = a `geq` b
441425
442426instance GCompare (HListPtr l) where -- Warning: This ordering can't change, dmapTo*HList will break
443−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
444− gcompareToOrd _ = id
445−#endif
446427 HHeadPtr `gcompare` HHeadPtr = GEQ
447428 HHeadPtr `gcompare` HTailPtr _ = GLT
448429 HTailPtr _ `gcompare` HHeadPtr = GGT
@@ -521,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
521502
522503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
523504-- single 'Dynamic' whose value represents all the current values of the input's
524−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
525506collectDynPure :: ( RebuildSortedHList (HListElems b)
526507 , IsHList a, IsHList b
527508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -562,134 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
562543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
563544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
564545#endif
565−
566−--------------------------------------------------------------------------------
567−-- Deprecated functions
568−--------------------------------------------------------------------------------
569−
570−-- | Map a function over a 'Dynamic'.
571−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
572−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
573−mapDyn f = return . fmap f
574−
575−-- | Flipped version of 'mapDyn'.
576−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
577−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
578−forDyn a = return . ffor a
579−
580−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
581−-- of the tuple.
582−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
583−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
584−splitDyn = return . splitDynPure
585−
586−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
587−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
588−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
589−mconcatDyn = return . mconcat
590−
591−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
592−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
593−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
594−distributeDMapOverDyn = return . distributeDMapOverDynPure
595−
596−-- | Merge two 'Dynamic's into a new one using the provided function. The new
597−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
598−-- its value.
599−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
600−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
601−combineDyn f a b = return $ zipDynWith f a b
602−
603−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
604−--
605−-- > do
606−-- > person <- Person `mapDyn` dynFirstName
607−-- > `apDyn` dynListName
608−-- > `apDyn` dynAge
609−-- > `apDyn` dynAddress
610−{-# 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" #-}
611−#ifdef USE_TEMPLATE_HASKELL
612−{-# ANN apDyn "HLint: ignore Use fmap" #-}
613−#endif
614−apDyn :: forall t m a b. (Reflex t, Monad m)
615− => m (Dynamic t (a -> b))
616− -> Dynamic t a
617− -> m (Dynamic t b)
618−apDyn m a = fmap (<*> a) m
619−
620−--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
621−-- | This function no longer needs to be monadic, so it has been replaced by
622−-- 'demuxed', which is pure.
623−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
624−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
625−getDemuxed d = return . demuxed d
626−
627−-- | This function no longer needs to be monadic, so it has been replaced by
628−-- 'distributeFHListOverDynPure', which is pure.
629−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
630−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
631−distributeFHListOverDyn = return . distributeFHListOverDynPure
632−
633−-- | This function no longer needs to be monadic, so it has been replaced by
634−-- 'collectDynPure', which is pure.
635−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
636−collectDyn :: ( RebuildSortedHList (HListElems b)
637− , IsHList a, IsHList b
638− , AllAreFunctors (Dynamic t) (HListElems b)
639− , Reflex t, Monad m
640− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
641− ) => a -> m (Dynamic t b)
642−collectDyn = return . collectDynPure
643−
644−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
645−-- semantics.
646−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
647−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
648−tagDyn = tagPromptlyDyn
649−
650−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
651−-- semantics.
652−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
653−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
654−attachDyn = attachPromptlyDyn
655−
656−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
657−-- semantics.
658−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
659−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
660−attachDynWith = attachPromptlyDynWith
661−
662−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
663−-- its semantics.
664−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
665−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
666−attachDynWithMaybe = attachPromptlyDynWithMaybe
667−
668−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
669−-- current value will always be equal to the current value's current value, and
670−-- will change whenever either the inner or the outer (or both) values change.
671−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
672−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
673−joinDyn = join
674−
675−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
676−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
677−-- circumstances. Also, note that, unlike 'nub', this function does not prevent
678−-- all recurrences of a value, only consecutive recurrences.
679−{-# DEPRECATED nubDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
680−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
681−nubDyn = uniqDyn
682−
683−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
684−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
685−-- circumstances.
686−{-# DEPRECATED uniqDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
687−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
688−uniqDyn = uniqDynBy (==)
689−
690−-- | WARNING: This function is impure. Use 'holdUniqDynBy' instead.
691−{-# DEPRECATED uniqDynBy "Use 'holdUniqDynBy' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
692−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
693−uniqDynBy eq d =
694− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
695− in unsafeDynamic (current d) e'
src/Reflex/Dynamic/TH.hs+4−28
@@ -13,9 +13,6 @@ module Reflex.Dynamic.TH
1313 ( qDynPure
1414 , unqDyn
1515 , mkDynPure
16− -- * Deprecated functions
17− , qDyn
18− , mkDyn
1916 ) where
2017
2118import Reflex.Dynamic
@@ -23,7 +20,7 @@ import Reflex.Dynamic
2320import Control.Monad.State
2421import Data.Data
2522import Data.Generics
26−import Data.Monoid
23+import Data.Monoid ((<>))
2724import qualified Language.Haskell.Exts as Hs
2825import qualified Language.Haskell.Meta.Syntax.Translate as Hs
2926import Language.Haskell.TH
@@ -47,8 +44,8 @@ qDynPure qe = do
4744 _ -> gmapM f d
4845 (e', exprsReversed) <- runStateT (gmapM f e) []
4946 let exprs = reverse exprsReversed
50− arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
51− param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
47+ arg = foldr (\a b -> ConE 'FHCons `AppE` snd a `AppE` b) (ConE 'FHNil) exprs
48+ param = foldr (\a b -> ConP 'HCons [VarP (fst a), b]) (ConP 'HNil []) exprs
5249 [| $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
5350
5451-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
@@ -84,7 +81,7 @@ mkDynPure = QuasiQuoter
8481 }
8582
8683mkDynExp :: String -> Q Exp
87−mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] }) s of
84+mkDynExp s = case Hs.parseExpWithMode Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] } s of
8885 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
8986 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
9087 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
@@ -107,24 +104,3 @@ mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ H
107104 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
108105 | modName == modName' && occName == occName' = 'unqMarker
109106 reinstateUnqDyn x = x
110−
111−--------------------------------------------------------------------------------
112−-- Deprecated
113−--------------------------------------------------------------------------------
114−
115−{-# DEPRECATED qDyn "Instead of $(qDyn x), use return $(qDynPure x)" #-}
116−-- | Like 'qDynPure', but wraps its result monadically using 'return'. This is
117−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
118−qDyn :: Q Exp -> Q Exp
119−qDyn qe = [| return $(qDynPure qe) |]
120−
121−{-# DEPRECATED mkDyn "Instead of [mkDyn| x |], use return [mkDynPure| x |]" #-}
122−-- | Like 'mkDynPure', but wraps its result monadically using 'return'. This is
123−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
124−mkDyn :: QuasiQuoter
125−mkDyn = QuasiQuoter
126− { quoteExp = \s -> [| return $(mkDynExp s) |]
127− , quotePat = error "mkDyn: pattern splices are not supported"
128− , quoteType = error "mkDyn: type splices are not supported"
129− , quoteDec = error "mkDyn: declaration splices are not supported"
130− }
src/Reflex/DynamicWriter.hs+4−221
@@ -1,224 +1,7 @@
1−-- | This module defines 'MonadDynamicWriter' and 'DynamicWriterT', its standard
2−-- implementation.
3−{-# LANGUAGE CPP #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8−{-# LANGUAGE LambdaCase #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−#ifdef USE_REFLEX_OPTIMIZER
15−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
16−#endif
171module Reflex.DynamicWriter
18− ( MonadDynamicWriter (..)
19− , DynamicWriterT (..)
20− , runDynamicWriterT
21− , withDynamicWriterT
2+ {-# DEPRECATED "Use 'Reflex.DynamicWriter.Class' and 'Reflex.DynamicWrite.Base' instead, or just import 'Reflex'" #-}
3+ ( module X
224 ) where
235
24−import Control.Monad.Exception
25−import Control.Monad.Identity
26−import Control.Monad.IO.Class
27−import Control.Monad.Reader
28−import Control.Monad.Ref
29−import Control.Monad.State.Strict
30−import Data.Align
31−import Data.Dependent.Map (DMap)
32−import qualified Data.Dependent.Map as DMap
33−import Data.FastMutableIntMap
34−import Data.Functor.Misc
35−import Data.IntMap (IntMap)
36−import qualified Data.IntMap as IntMap
37−import Data.Map (Map)
38−import qualified Data.Map as Map
39−import Data.Semigroup
40−import Data.Some (Some)
41−import Data.These
42−import Reflex.Class
43−import Reflex.Host.Class
44−import qualified Reflex.Patch.MapWithMove as MapWithMove
45−import Reflex.PerformEvent.Class
46−import Reflex.PostBuild.Class
47−import Reflex.Requester.Class
48−import Reflex.TriggerEvent.Class
49−
50−instance MonadTrans (DynamicWriterT t w) where
51− lift = DynamicWriterT . lift
52−
53−mapIncrementalMapValues :: (Reflex t, Patch (p v), Patch (p v'), PatchTarget (p v) ~ f v, PatchTarget (p v') ~ f v', Functor p, Functor f) => (v -> v') -> Incremental t (p v) -> Incremental t (p v')
54−mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
55−
56−mergeDynIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Dynamic t v)) -> Incremental t (PatchMap k v)
57−mergeDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
58− where changedValues = fmap (PatchMap . fmap Just) $ mergeMapIncremental $ mapIncrementalMapValues updated a
59− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchMap m) -> PatchMap <$> mapM (mapM (sample . current)) m
60−
61−mergeIntMapDynIncremental :: Reflex t => Incremental t (PatchIntMap (Dynamic t v)) -> Incremental t (PatchIntMap v)
62−mergeIntMapDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
63− where changedValues = fmap (PatchIntMap . fmap Just) $ mergeIntMapIncremental $ mapIncrementalMapValues updated a
64− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchIntMap m) -> PatchIntMap <$> mapM (mapM (sample . current)) m
65−
66−mergeDynIncrementalWithMove :: forall t k v. (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Dynamic t v)) -> Incremental t (PatchMapWithMove k v)
67−mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ alignWith f addedAndRemovedValues changedValues
68− where changedValues = mergeMapIncrementalWithMove $ mapIncrementalMapValues updated a
69− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ fmap unsafePatchMapWithMove . mapM (mapM (sample . current)) . unPatchMapWithMove
70− f :: These (PatchMapWithMove k v) (Map k v) -> PatchMapWithMove k v
71− f x = unsafePatchMapWithMove $
72− let (p, changed) = case x of
73− This p_ -> (unPatchMapWithMove p_, mempty)
74− That c -> (mempty, c)
75− These p_ c -> (unPatchMapWithMove p_, c)
76− (pWithNewVals, noLongerMoved) = flip runState [] $ forM p $ MapWithMove.nodeInfoMapMFrom $ \case
77− MapWithMove.From_Insert v -> return $ MapWithMove.From_Insert v
78− MapWithMove.From_Delete -> return $ MapWithMove.From_Delete
79− MapWithMove.From_Move k -> case Map.lookup k changed of
80− Nothing -> return $ MapWithMove.From_Move k
81− Just v -> do
82− modify (k:)
83− return $ MapWithMove.From_Insert v
84− noLongerMovedMap = Map.fromList $ fmap (\k -> (k, ())) noLongerMoved
85− in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
86−
87−-- | A basic implementation of 'MonadDynamicWriter'.
88−newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT [Dynamic t w] m a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadHold t, MonadSample t, MonadAsyncException, MonadException) -- The list is kept in reverse order
89−
90−instance MonadRef m => MonadRef (DynamicWriterT t w m) where
91− type Ref (DynamicWriterT t w m) = Ref m
92− newRef = lift . newRef
93− readRef = lift . readRef
94− writeRef r = lift . writeRef r
95−
96−instance MonadAtomicRef m => MonadAtomicRef (DynamicWriterT t w m) where
97− atomicModifyRef r = lift . atomicModifyRef r
98−
99−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DynamicWriterT t w m) where
100− newEventWithTrigger = lift . newEventWithTrigger
101− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
102−
103−-- | Run a 'DynamicWriterT' action. The dynamic writer output will be provided
104−-- along with the result of the action.
105−runDynamicWriterT :: (MonadFix m, Reflex t, Monoid w) => DynamicWriterT t w m a -> m (a, Dynamic t w)
106−runDynamicWriterT (DynamicWriterT a) = do
107− (result, ws) <- runStateT a []
108− return (result, mconcat $ reverse ws)
109−
110−-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
111−-- and combines them monoidally to provide a 'Dynamic' result.
112−class (Monad m, Monoid w) => MonadDynamicWriter t w m | m -> t w where
113− tellDyn :: Dynamic t w -> m ()
114−
115−instance (Monad m, Monoid w, Reflex t) => MonadDynamicWriter t w (DynamicWriterT t w m) where
116− tellDyn w = DynamicWriterT $ modify (w :)
117−
118−instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
119− ask = lift ask
120− local f (DynamicWriterT a) = DynamicWriterT $ mapStateT (local f) a
121− reader = lift . reader
122−
123−instance PerformEvent t m => PerformEvent t (DynamicWriterT t w m) where
124− type Performable (DynamicWriterT t w m) = Performable m
125− performEvent_ = lift . performEvent_
126− performEvent = lift . performEvent
127−
128−instance TriggerEvent t m => TriggerEvent t (DynamicWriterT t w m) where
129− newTriggerEvent = lift newTriggerEvent
130− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
131− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
132−
133−instance PostBuild t m => PostBuild t (DynamicWriterT t w m) where
134− getPostBuild = lift getPostBuild
135−
136−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (ReaderT r m) where
137− tellDyn = lift . tellDyn
138−
139−instance MonadState s m => MonadState s (DynamicWriterT t w m) where
140− get = lift get
141− put = lift . put
142−
143−newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
144−
145−-- | When the execution of a 'DynamicWriterT' action is adjusted using
146−-- 'Adjustable', the 'Dynamic' output of that action will also be updated to
147−-- match.
148−instance (Adjustable t m, MonadFix m, Monoid w, MonadHold t m, Reflex t) => Adjustable t (DynamicWriterT t w m) where
149− runWithReplace a0 a' = do
150− (result0, result') <- lift $ runWithReplace (runDynamicWriterT a0) $ runDynamicWriterT <$> a'
151− tellDyn . join =<< holdDyn (snd result0) (snd <$> result')
152− return (fst result0, fst <$> result')
153− traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustImpl traverseIntMapWithKeyWithAdjust mergeIntMapDynIncremental
154− traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap weakenPatchDMapWith mergeDynIncremental
155− traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeDynIncrementalWithMove
156−
157−traverseDMapWithKeyWithAdjustImpl :: forall t w k v' p p' v m. (PatchTarget (p' (Some k) (Dynamic t w)) ~ Map (Some k) (Dynamic t w), PatchTarget (p' (Some k) w) ~ Map (Some k) w, Patch (p' (Some k) w), Patch (p' (Some k) (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m)
158− => ( (forall a. k a -> v a -> m (DynamicWriterTLoweredResult t w v' a))
159− -> DMap k v
160− -> Event t (p k v)
161− -> m (DMap k (DynamicWriterTLoweredResult t w v'), Event t (p k (DynamicWriterTLoweredResult t w v')))
162− )
163− -> ((forall a. DynamicWriterTLoweredResult t w v' a -> v' a) -> p k (DynamicWriterTLoweredResult t w v') -> p k v')
164− -> ((forall a. DynamicWriterTLoweredResult t w v' a -> Dynamic t w) -> p k (DynamicWriterTLoweredResult t w v') -> p' (Some k) (Dynamic t w))
165− -> (Incremental t (p' (Some k) (Dynamic t w)) -> Incremental t (p' (Some k) w))
166− -> (forall a. k a -> v a -> DynamicWriterT t w m (v' a))
167− -> DMap k v
168− -> Event t (p k v)
169− -> DynamicWriterT t w m (DMap k v', Event t (p k v'))
170−traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith mergeMyDynIncremental f (dm0 :: DMap k v) dm' = do
171− (result0, result') <- lift $ base (\k v -> fmap DynamicWriterTLoweredResult $ runDynamicWriterT $ f k v) dm0 dm'
172− let getValue (DynamicWriterTLoweredResult (v, _)) = v
173− getWritten (DynamicWriterTLoweredResult (_, w)) = w
174− liftedResult0 = DMap.map getValue result0
175− liftedResult' = ffor result' $ mapPatch getValue
176− liftedWritten0 :: Map (Some k) (Dynamic t w)
177− liftedWritten0 = weakenDMapWith getWritten result0
178− liftedWritten' = ffor result' $ weakenPatchWith getWritten
179− --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
180− i <- holdIncremental liftedWritten0 liftedWritten'
181− tellDyn $ fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
182− return (liftedResult0, liftedResult')
183−
184−traverseIntMapWithKeyWithAdjustImpl :: forall t w v' p p' v m. (PatchTarget (p' (Dynamic t w)) ~ IntMap (Dynamic t w), PatchTarget (p' w) ~ IntMap w, Patch (p' w), Patch (p' (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m, Functor p, p ~ p')
185− => ( (IntMap.Key -> v -> m ((v', Dynamic t w)))
186− -> IntMap v
187− -> Event t (p v)
188− -> m (IntMap (v', Dynamic t w), Event t (p (v', Dynamic t w)))
189− )
190− -> (Incremental t (p' (Dynamic t w)) -> Incremental t (p' w))
191− -> (IntMap.Key -> v -> DynamicWriterT t w m v')
192− -> IntMap v
193− -> Event t (p v)
194− -> DynamicWriterT t w m (IntMap v', Event t (p v'))
195−traverseIntMapWithKeyWithAdjustImpl base mergeMyDynIncremental f (dm0 :: IntMap v) dm' = do
196− (result0, result') <- lift $ base (\k v -> runDynamicWriterT $ f k v) dm0 dm'
197− let liftedResult0 = fmap fst result0
198− liftedResult' = fmap (fmap fst) result'
199− liftedWritten0 :: IntMap (Dynamic t w)
200− liftedWritten0 = fmap snd result0
201− liftedWritten' = fmap (fmap snd) result'
202− --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
203− i <- holdIncremental liftedWritten0 liftedWritten'
204− tellDyn $ fmap (mconcat . IntMap.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
205− return (liftedResult0, liftedResult')
206−
207−-- | Map a function over the output of a 'DynamicWriterT'.
208−withDynamicWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m, MonadFix m)
209− => (w -> w')
210− -> DynamicWriterT t w m a
211− -> DynamicWriterT t w' m a
212−withDynamicWriterT f dw = do
213− (r, d) <- lift $ do
214− (r, d) <- runDynamicWriterT dw
215− let d' = fmap f d
216− return (r, d')
217− tellDyn d
218− return r
219−
220−instance Requester t m => Requester t (DynamicWriterT t w m) where
221− type Request (DynamicWriterT t w m) = Request m
222− type Response (DynamicWriterT t w m) = Response m
223− requesting = lift . requesting
224− requesting_ = lift . requesting_
6+import Reflex.DynamicWriter.Base as X
7+import Reflex.DynamicWriter.Class as X
src/Reflex/DynamicWriter/Base.hsnew file+246
@@ -0,0 +1,246 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleInstances #-}
3+{-# LANGUAGE GADTs #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE RankNTypes #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE UndecidableInstances #-}
12+{-# LANGUAGE StandaloneDeriving #-}
13+#ifdef USE_REFLEX_OPTIMIZER
14+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15+#endif
16+module Reflex.DynamicWriter.Base
17+ ( DynamicWriterT (..)
18+ , runDynamicWriterT
19+ , withDynamicWriterT
20+ ) where
21+
22+import Control.Monad.Exception
23+import Control.Monad.Identity
24+import Control.Monad.IO.Class
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
27+import Control.Monad.Reader
28+import Control.Monad.Ref
29+import Control.Monad.State.Strict
30+import Data.Align
31+import Data.Dependent.Map (DMap)
32+import qualified Data.Dependent.Map as DMap
33+import Data.FastMutableIntMap
34+import Data.Functor.Misc
35+import Data.IntMap (IntMap)
36+import qualified Data.IntMap as IntMap
37+import Data.Map (Map)
38+import qualified Data.Map as Map
39+import Data.Semigroup (Semigroup(..))
40+import Data.Some (Some)
41+import Data.These
42+
43+import Reflex.Adjustable.Class
44+import Reflex.Class
45+import Reflex.DynamicWriter.Class
46+import Reflex.EventWriter.Class (EventWriter, tellEvent)
47+import Reflex.Host.Class
48+import qualified Data.Patch.MapWithMove as MapWithMove
49+import Reflex.PerformEvent.Class
50+import Reflex.PostBuild.Class
51+import Reflex.Query.Class
52+import Reflex.Requester.Class
53+import Reflex.TriggerEvent.Class
54+
55+mapIncrementalMapValues :: (Reflex t, Patch (p v), Patch (p v'), PatchTarget (p v) ~ f v, PatchTarget (p v') ~ f v', Functor p, Functor f) => (v -> v') -> Incremental t (p v) -> Incremental t (p v')
56+mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
57+
58+mergeDynIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Dynamic t v)) -> Incremental t (PatchMap k v)
59+mergeDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
60+ where changedValues = fmap (PatchMap . fmap Just) $ mergeMapIncremental $ mapIncrementalMapValues updated a
61+ addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchMap m) -> PatchMap <$> mapM (mapM (sample . current)) m
62+
63+mergeIntMapDynIncremental :: Reflex t => Incremental t (PatchIntMap (Dynamic t v)) -> Incremental t (PatchIntMap v)
64+mergeIntMapDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
65+ where changedValues = fmap (PatchIntMap . fmap Just) $ mergeIntMapIncremental $ mapIncrementalMapValues updated a
66+ addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchIntMap m) -> PatchIntMap <$> mapM (mapM (sample . current)) m
67+
68+mergeDynIncrementalWithMove :: forall t k v. (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Dynamic t v)) -> Incremental t (PatchMapWithMove k v)
69+mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ alignWith f addedAndRemovedValues changedValues
70+ where changedValues = mergeMapIncrementalWithMove $ mapIncrementalMapValues updated a
71+ addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ fmap unsafePatchMapWithMove . mapM (mapM (sample . current)) . unPatchMapWithMove
72+ f :: These (PatchMapWithMove k v) (Map k v) -> PatchMapWithMove k v
73+ f x = unsafePatchMapWithMove $
74+ let (p, changed) = case x of
75+ This p_ -> (unPatchMapWithMove p_, mempty)
76+ That c -> (mempty, c)
77+ These p_ c -> (unPatchMapWithMove p_, c)
78+ (pWithNewVals, noLongerMoved) = flip runState [] $ forM p $ MapWithMove.nodeInfoMapMFrom $ \case
79+ MapWithMove.From_Insert v -> return $ MapWithMove.From_Insert v
80+ MapWithMove.From_Delete -> return MapWithMove.From_Delete
81+ MapWithMove.From_Move k -> case Map.lookup k changed of
82+ Nothing -> return $ MapWithMove.From_Move k
83+ Just v -> do
84+ modify (k:)
85+ return $ MapWithMove.From_Insert v
86+ noLongerMovedMap = Map.fromList $ fmap (, ()) noLongerMoved
87+ in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
88+
89+-- | A basic implementation of 'DynamicWriter'.
90+newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT [Dynamic t w] m a }
91+ -- The list is kept in reverse order
92+ deriving
93+ ( Functor
94+ , Applicative
95+ , Monad
96+ , MonadTrans
97+ , MFunctor
98+ , MonadIO
99+ , MonadFix
100+ , MonadAsyncException
101+ , MonadException
102+ )
103+
104+deriving instance MonadHold t m => MonadHold t (DynamicWriterT t w m)
105+deriving instance MonadSample t m => MonadSample t (DynamicWriterT t w m)
106+
107+
108+instance MonadRef m => MonadRef (DynamicWriterT t w m) where
109+ type Ref (DynamicWriterT t w m) = Ref m
110+ newRef = lift . newRef
111+ readRef = lift . readRef
112+ writeRef r = lift . writeRef r
113+
114+instance MonadAtomicRef m => MonadAtomicRef (DynamicWriterT t w m) where
115+ atomicModifyRef r = lift . atomicModifyRef r
116+
117+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DynamicWriterT t w m) where
118+ newEventWithTrigger = lift . newEventWithTrigger
119+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
120+
121+-- | Run a 'DynamicWriterT' action. The dynamic writer output will be provided
122+-- along with the result of the action.
123+runDynamicWriterT :: (MonadFix m, Reflex t, Monoid w) => DynamicWriterT t w m a -> m (a, Dynamic t w)
124+runDynamicWriterT (DynamicWriterT a) = do
125+ (result, ws) <- runStateT a []
126+ return (result, mconcat $ reverse ws)
127+
128+instance (Monad m, Monoid w, Reflex t) => DynamicWriter t w (DynamicWriterT t w m) where
129+ tellDyn w = DynamicWriterT $ modify (w :)
130+
131+instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
132+ ask = lift ask
133+ local f (DynamicWriterT a) = DynamicWriterT $ mapStateT (local f) a
134+ reader = lift . reader
135+
136+instance PerformEvent t m => PerformEvent t (DynamicWriterT t w m) where
137+ type Performable (DynamicWriterT t w m) = Performable m
138+ performEvent_ = lift . performEvent_
139+ performEvent = lift . performEvent
140+
141+instance TriggerEvent t m => TriggerEvent t (DynamicWriterT t w m) where
142+ newTriggerEvent = lift newTriggerEvent
143+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
144+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
145+
146+instance PostBuild t m => PostBuild t (DynamicWriterT t w m) where
147+ getPostBuild = lift getPostBuild
148+
149+instance MonadState s m => MonadState s (DynamicWriterT t w m) where
150+ get = lift get
151+ put = lift . put
152+
153+instance PrimMonad m => PrimMonad (DynamicWriterT t w m) where
154+ type PrimState (DynamicWriterT t w m) = PrimState m
155+ primitive = lift . primitive
156+
157+newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
158+
159+-- | When the execution of a 'DynamicWriterT' action is adjusted using
160+-- 'Adjustable', the 'Dynamic' output of that action will also be updated to
161+-- match.
162+instance (Adjustable t m, MonadFix m, Monoid w, MonadHold t m, Reflex t) => Adjustable t (DynamicWriterT t w m) where
163+ runWithReplace a0 a' = do
164+ (result0, result') <- lift $ runWithReplace (runDynamicWriterT a0) $ runDynamicWriterT <$> a'
165+ tellDyn . join =<< holdDyn (snd result0) (snd <$> result')
166+ return (fst result0, fst <$> result')
167+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustImpl traverseIntMapWithKeyWithAdjust mergeIntMapDynIncremental
168+ traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap weakenPatchDMapWith mergeDynIncremental
169+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeDynIncrementalWithMove
170+
171+traverseDMapWithKeyWithAdjustImpl :: forall t w k v' p p' v m. (PatchTarget (p' (Some k) (Dynamic t w)) ~ Map (Some k) (Dynamic t w), PatchTarget (p' (Some k) w) ~ Map (Some k) w, Patch (p' (Some k) w), Patch (p' (Some k) (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m)
172+ => ( (forall a. k a -> v a -> m (DynamicWriterTLoweredResult t w v' a))
173+ -> DMap k v
174+ -> Event t (p k v)
175+ -> m (DMap k (DynamicWriterTLoweredResult t w v'), Event t (p k (DynamicWriterTLoweredResult t w v')))
176+ )
177+ -> ((forall a. DynamicWriterTLoweredResult t w v' a -> v' a) -> p k (DynamicWriterTLoweredResult t w v') -> p k v')
178+ -> ((forall a. DynamicWriterTLoweredResult t w v' a -> Dynamic t w) -> p k (DynamicWriterTLoweredResult t w v') -> p' (Some k) (Dynamic t w))
179+ -> (Incremental t (p' (Some k) (Dynamic t w)) -> Incremental t (p' (Some k) w))
180+ -> (forall a. k a -> v a -> DynamicWriterT t w m (v' a))
181+ -> DMap k v
182+ -> Event t (p k v)
183+ -> DynamicWriterT t w m (DMap k v', Event t (p k v'))
184+traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith mergeMyDynIncremental f (dm0 :: DMap k v) dm' = do
185+ (result0, result') <- lift $ base (\k v -> fmap DynamicWriterTLoweredResult $ runDynamicWriterT $ f k v) dm0 dm'
186+ let getValue (DynamicWriterTLoweredResult (v, _)) = v
187+ getWritten (DynamicWriterTLoweredResult (_, w)) = w
188+ liftedResult0 = DMap.map getValue result0
189+ liftedResult' = ffor result' $ mapPatch getValue
190+ liftedWritten0 :: Map (Some k) (Dynamic t w)
191+ liftedWritten0 = weakenDMapWith getWritten result0
192+ liftedWritten' = ffor result' $ weakenPatchWith getWritten
193+ --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
194+ i <- holdIncremental liftedWritten0 liftedWritten'
195+ tellDyn $ fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
196+ return (liftedResult0, liftedResult')
197+
198+traverseIntMapWithKeyWithAdjustImpl :: forall t w v' p p' v m. (PatchTarget (p' (Dynamic t w)) ~ IntMap (Dynamic t w), PatchTarget (p' w) ~ IntMap w, Patch (p' w), Patch (p' (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m, Functor p, p ~ p')
199+ => ( (IntMap.Key -> v -> m (v', Dynamic t w))
200+ -> IntMap v
201+ -> Event t (p v)
202+ -> m (IntMap (v', Dynamic t w), Event t (p (v', Dynamic t w)))
203+ )
204+ -> (Incremental t (p' (Dynamic t w)) -> Incremental t (p' w))
205+ -> (IntMap.Key -> v -> DynamicWriterT t w m v')
206+ -> IntMap v
207+ -> Event t (p v)
208+ -> DynamicWriterT t w m (IntMap v', Event t (p v'))
209+traverseIntMapWithKeyWithAdjustImpl base mergeMyDynIncremental f (dm0 :: IntMap v) dm' = do
210+ (result0, result') <- lift $ base (\k v -> runDynamicWriterT $ f k v) dm0 dm'
211+ let liftedResult0 = fmap fst result0
212+ liftedResult' = fmap (fmap fst) result'
213+ liftedWritten0 :: IntMap (Dynamic t w)
214+ liftedWritten0 = fmap snd result0
215+ liftedWritten' = fmap (fmap snd) result'
216+ --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
217+ i <- holdIncremental liftedWritten0 liftedWritten'
218+ tellDyn $ fmap (mconcat . IntMap.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
219+ return (liftedResult0, liftedResult')
220+
221+-- | Map a function over the output of a 'DynamicWriterT'.
222+withDynamicWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m, MonadFix m)
223+ => (w -> w')
224+ -> DynamicWriterT t w m a
225+ -> DynamicWriterT t w' m a
226+withDynamicWriterT f dw = do
227+ (r, d) <- lift $ do
228+ (r, d) <- runDynamicWriterT dw
229+ let d' = fmap f d
230+ return (r, d')
231+ tellDyn d
232+ return r
233+
234+instance Requester t m => Requester t (DynamicWriterT t w m) where
235+ type Request (DynamicWriterT t w m) = Request m
236+ type Response (DynamicWriterT t w m) = Response m
237+ requesting = lift . requesting
238+ requesting_ = lift . requesting_
239+
240+instance (MonadQuery t q m, Monad m) => MonadQuery t q (DynamicWriterT t w m) where
241+ tellQueryIncremental = lift . tellQueryIncremental
242+ askQueryResult = lift askQueryResult
243+ queryIncremental = lift . queryIncremental
244+
245+instance EventWriter t w m => EventWriter t w (DynamicWriterT t v m) where
246+ tellEvent = lift . tellEvent
src/Reflex/DynamicWriter/Class.hsnew file+28
@@ -0,0 +1,28 @@
1+-- | This module defines the 'DynamicWriter' class.
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE CPP #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FunctionalDependencies #-}
6+{-# LANGUAGE UndecidableInstances #-}
7+#ifdef USE_REFLEX_OPTIMIZER
8+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
9+#endif
10+module Reflex.DynamicWriter.Class
11+ ( MonadDynamicWriter
12+ , DynamicWriter(..)
13+ ) where
14+
15+import Control.Monad.Reader (ReaderT, lift)
16+import Reflex.Class (Dynamic)
17+
18+{-# DEPRECATED MonadDynamicWriter "Use 'DynamicWriter' instead" #-}
19+-- | Type synonym for 'DynamicWriter'
20+type MonadDynamicWriter = DynamicWriter
21+
22+-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
23+-- and combines them monoidally to provide a 'Dynamic' result.
24+class (Monad m, Monoid w) => DynamicWriter t w m | m -> t w where
25+ tellDyn :: Dynamic t w -> m ()
26+
27+instance DynamicWriter t w m => DynamicWriter t w (ReaderT r m) where
28+ tellDyn = lift . tellDyn
src/Reflex/EventWriter.hs+4−279
@@ -1,282 +1,7 @@
1−-- | This module provides 'EventWriterT', the standard implementation of
2−-- 'EventWriter'.
3−{-# LANGUAGE CPP #-}
4−{-# LANGUAGE ExistentialQuantification #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE Rank2Types #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−#ifdef USE_REFLEX_OPTIMIZER
15−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
16−#endif
171module Reflex.EventWriter
18− ( EventWriterT (..)
19− , runEventWriterT
20− , EventWriter (..)
21− , runWithReplaceEventWriterTWith
22− , sequenceDMapWithAdjustEventWriterTWith
23− , withEventWriterT
2+ {-# DEPRECATED "Use 'Reflex.EventWriter.Class' and 'Reflex.EventWriter.Base' instead, or just import 'Reflex'" #-}
3+ ( module X
244 ) where
255
26−import Reflex.Class
27−import Reflex.Host.Class
28−import Reflex.PerformEvent.Class
29−import Reflex.PostBuild.Class
30−import Reflex.Query.Class
31−import Reflex.Requester.Class
32−import Reflex.TriggerEvent.Class
33−
34−import Control.Monad.Exception
35−import Control.Monad.Identity
36−import Control.Monad.Reader
37−import Control.Monad.Ref
38−import Control.Monad.State.Strict
39−import Data.Dependent.Map (DMap, DSum (..))
40−import qualified Data.Dependent.Map as DMap
41−import Data.Foldable
42−import Data.Functor.Compose
43−import Data.Functor.Misc
44−import Data.GADT.Compare (GEq (..), GCompare (..), GOrdering (..))
45−import Data.IntMap.Strict (IntMap)
46−import qualified Data.IntMap.Strict as IntMap
47−import Data.List.NonEmpty (NonEmpty (..))
48−import Data.Map (Map)
49−import Data.Semigroup
50−import Data.Some (Some)
51−import Data.Tuple
52−import Data.Type.Equality
53−
54−import Unsafe.Coerce
55−
56−-- | 'EventWriter' efficiently collects 'Event' values using 'tellEvent'
57−-- and combines them monoidally to provide an 'Event' result.
58−class (Monad m, Semigroup w) => EventWriter t w m | m -> t w where
59− tellEvent :: Event t w -> m ()
60−
61−{-# DEPRECATED TellId "Do not construct this directly; use tellId instead" #-}
62−newtype TellId w x
63− = TellId Int -- ^ WARNING: Do not construct this directly; use 'TellId' instead
64− deriving (Show, Eq, Ord, Enum)
65−
66−tellId :: Int -> TellId w w
67−tellId = TellId
68−{-# INLINE tellId #-}
69−
70−tellIdRefl :: TellId w x -> w :~: x
71−tellIdRefl _ = unsafeCoerce Refl
72−
73−withTellIdRefl :: TellId w x -> (w ~ x => r) -> r
74−withTellIdRefl tid r = case tellIdRefl tid of
75− Refl -> r
76−
77−instance GEq (TellId w) where
78− a `geq` b =
79− withTellIdRefl a $
80− withTellIdRefl b $
81− if a == b
82− then Just Refl
83− else Nothing
84−
85−instance GCompare (TellId w) where
86− a `gcompare` b =
87− withTellIdRefl a $
88− withTellIdRefl b $
89− case a `compare` b of
90− LT -> GLT
91− EQ -> GEQ
92− GT -> GGT
93−
94−data EventWriterState t w = EventWriterState
95− { _eventWriterState_nextId :: {-# UNPACK #-} !Int -- Always negative (and decreasing over time)
96− , _eventWriterState_told :: ![DSum (TellId w) (Event t)] -- In increasing order
97− }
98−
99−-- | A basic implementation of 'EventWriter'.
100−newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (EventWriterState t w) m a }
101− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
102−
103−-- | Run a 'EventWriterT' action.
104−runEventWriterT :: forall t m w a. (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
105−runEventWriterT (EventWriterT a) = do
106− (result, requests) <- runStateT a $ EventWriterState (-1) []
107− let combineResults :: DMap (TellId w) Identity -> w
108− combineResults = sconcat
109− . (\(h : t) -> h :| t) -- Unconditional; 'merge' guarantees that it will only fire with non-empty DMaps
110− . DMap.foldlWithKey (\vs tid (Identity v) -> withTellIdRefl tid $ v : vs) [] -- This is where we finally reverse the DMap to get things in the correct order
111− return (result, fmap combineResults $ merge $ DMap.fromDistinctAscList $ _eventWriterState_told requests) --TODO: We can probably make this fromDistinctAscList more efficient by knowing the length in advance, but this will require exposing internals of DMap; also converting it to use a strict list might help
112−
113−instance (Reflex t, Monad m, Semigroup w) => EventWriter t w (EventWriterT t w m) where
114− tellEvent w = EventWriterT $ modify $ \old ->
115− let myId = _eventWriterState_nextId old
116− in EventWriterState
117− { _eventWriterState_nextId = pred myId
118− , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
119− }
120−
121−instance EventWriter t w m => EventWriter t w (ReaderT r m) where
122− tellEvent = lift . tellEvent
123−
124−instance MonadTrans (EventWriterT t w) where
125− lift = EventWriterT . lift
126−
127−instance MonadSample t m => MonadSample t (EventWriterT t w m) where
128− sample = lift . sample
129−
130−instance MonadHold t m => MonadHold t (EventWriterT t w m) where
131− {-# INLINABLE hold #-}
132− hold v0 = lift . hold v0
133− {-# INLINABLE holdDyn #-}
134− holdDyn v0 = lift . holdDyn v0
135− {-# INLINABLE holdIncremental #-}
136− holdIncremental v0 = lift . holdIncremental v0
137− {-# INLINABLE buildDynamic #-}
138− buildDynamic a0 = lift . buildDynamic a0
139− {-# INLINABLE headE #-}
140− headE = lift . headE
141−
142−instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
143− runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
144− traverseIntMapWithKeyWithAdjust = sequenceIntMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElements mergeIntIncremental
145− traverseDMapWithKeyWithAdjust = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElements mergeMapIncremental
146− traverseDMapWithKeyWithAdjustWithMove = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElements mergeMapIncrementalWithMove
147−
148−instance Requester t m => Requester t (EventWriterT t w m) where
149− type Request (EventWriterT t w m) = Request m
150− type Response (EventWriterT t w m) = Response m
151− requesting = lift . requesting
152− requesting_ = lift . requesting_
153−
154−-- | Given a function like 'runWithReplace' for the underlying monad, implement
155−-- 'runWithReplace' for 'EventWriterT'. This is necessary when the underlying
156−-- monad doesn't have a 'Adjustable' instance or to override the default
157−-- 'Adjustable' behavior.
158−runWithReplaceEventWriterTWith :: forall m t w a b. (Reflex t, MonadHold t m, Semigroup w)
159− => (forall a' b'. m a' -> Event t (m b') -> EventWriterT t w m (a', Event t b'))
160− -> EventWriterT t w m a
161− -> Event t (EventWriterT t w m b)
162− -> EventWriterT t w m (a, Event t b)
163−runWithReplaceEventWriterTWith f a0 a' = do
164− (result0, result') <- f (runEventWriterT a0) $ fmapCheap runEventWriterT a'
165− request <- holdDyn (snd result0) $ fmapCheap snd result'
166− -- We add these two separately to take advantage of the free merge being done later. The coincidence case must come first so that it has precedence if both fire simultaneously. (Really, we should probably block the 'switch' whenever 'updated' fires, but switchPromptlyDyn has the same issue.)
167− tellEvent $ coincidence $ updated request
168− tellEvent $ switch $ current request
169− return (fst result0, fmapCheap fst result')
170−
171−-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceIntMapWithAdjust'.
172−sequenceIntMapWithAdjustEventWriterTWith :: forall t m p w v v'. (Reflex t, MonadHold t m, Semigroup w, Semigroup w, Functor p, Patch (p (Event t w)), PatchTarget (p (Event t w)) ~ IntMap (Event t w))
173− => ( (IntMap.Key -> v -> m (Event t w, v'))
174− -> IntMap v
175− -> Event t (p v)
176− -> EventWriterT t w m (IntMap (Event t w, v'), Event t (p (Event t w, v')))
177− )
178− -> (p (Event t w) -> [Event t w])
179− -> (Incremental t (p (Event t w)) -> Event t (IntMap w))
180− -> (IntMap.Key -> v -> EventWriterT t w m v')
181− -> IntMap v
182− -> Event t (p v)
183− -> EventWriterT t w m (IntMap v', Event t (p v'))
184−sequenceIntMapWithAdjustEventWriterTWith base patchNewElements mergePatchIncremental f dm0 dm' = do
185− let f' :: IntMap.Key -> v -> m (Event t w, v')
186− f' k v = swap <$> runEventWriterT (f k v)
187− (children0, children') <- base f' dm0 dm'
188− let result0 = fmap snd children0
189− result' = fmapCheap (fmap snd) children'
190− requests0 :: IntMap (Event t w)
191− requests0 = fmap fst children0
192− requests' :: Event t (p (Event t w))
193− requests' = fmapCheap (fmap fst) children'
194− childRequestMap :: Incremental t (p (Event t w)) <- holdIncremental requests0 requests'
195− -- We add these two separately to take advantage of the free merge being done later. The coincidence case must come first so that it has precedence if both fire simultaneously. (Really, we should probably block the 'switch' whenever 'updated' fires, but switchPromptlyDyn has the same issue.)
196− tellEvent $ coincidence $ fforCheap requests' $ \p -> mconcat $ patchNewElements p --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
197− tellEvent $ fforMaybeCheap (mergePatchIncremental childRequestMap) $ \m -> case toList m of
198− [] -> Nothing
199− h : t -> Just $ sconcat $ h :| t
200− return (result0, result')
201−
202−-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceDMapWithAdjust'.
203−sequenceDMapWithAdjustEventWriterTWith :: forall t m p p' w k v v'. (Reflex t, MonadHold t m, Semigroup w, Patch (p' (Some k) (Event t w)), PatchTarget (p' (Some k) (Event t w)) ~ Map (Some k) (Event t w))
204− => ( (forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a))
205− -> DMap k v
206− -> Event t (p k v)
207− -> EventWriterT t w m (DMap k (Compose ((,) (Event t w)) v'), Event t (p k (Compose ((,) (Event t w)) v')))
208− )
209− -> ((forall a. Compose ((,) (Event t w)) v' a -> v' a) -> p k (Compose ((,) (Event t w)) v') -> p k v')
210− -> ((forall a. Compose ((,) (Event t w)) v' a -> Event t w) -> p k (Compose ((,) (Event t w)) v') -> p' (Some k) (Event t w))
211− -> (p' (Some k) (Event t w) -> [Event t w])
212− -> (Incremental t (p' (Some k) (Event t w)) -> Event t (Map (Some k) w))
213− -> (forall a. k a -> v a -> EventWriterT t w m (v' a))
214− -> DMap k v
215− -> Event t (p k v)
216− -> EventWriterT t w m (DMap k v', Event t (p k v'))
217−sequenceDMapWithAdjustEventWriterTWith base mapPatch weakenPatchWith patchNewElements mergePatchIncremental f dm0 dm' = do
218− let f' :: forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a)
219− f' k v = Compose . swap <$> runEventWriterT (f k v)
220− (children0, children') <- base f' dm0 dm'
221− let result0 = DMap.map (snd . getCompose) children0
222− result' = fforCheap children' $ mapPatch $ snd . getCompose
223− requests0 :: Map (Some k) (Event t w)
224− requests0 = weakenDMapWith (fst . getCompose) children0
225− requests' :: Event t (p' (Some k) (Event t w))
226− requests' = fforCheap children' $ weakenPatchWith $ fst . getCompose
227− childRequestMap :: Incremental t (p' (Some k) (Event t w)) <- holdIncremental requests0 requests'
228− -- We add these two separately to take advantage of the free merge being done later. The coincidence case must come first so that it has precedence if both fire simultaneously. (Really, we should probably block the 'switch' whenever 'updated' fires, but switchPromptlyDyn has the same issue.)
229− tellEvent $ coincidence $ fforCheap requests' $ \p -> mconcat $ patchNewElements p --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
230− tellEvent $ fforMaybeCheap (mergePatchIncremental childRequestMap) $ \m -> case toList m of
231− [] -> Nothing
232− h : t -> Just $ sconcat $ h :| t
233− return (result0, result')
234−
235−instance PerformEvent t m => PerformEvent t (EventWriterT t w m) where
236− type Performable (EventWriterT t w m) = Performable m
237− performEvent_ = lift . performEvent_
238− performEvent = lift . performEvent
239−
240−instance PostBuild t m => PostBuild t (EventWriterT t w m) where
241− getPostBuild = lift getPostBuild
242−
243−instance TriggerEvent t m => TriggerEvent t (EventWriterT t w m) where
244− newTriggerEvent = lift newTriggerEvent
245− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
246− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
247−
248−instance MonadReader r m => MonadReader r (EventWriterT t w m) where
249− ask = lift ask
250− local f (EventWriterT a) = EventWriterT $ mapStateT (local f) a
251− reader = lift . reader
252−
253−instance MonadRef m => MonadRef (EventWriterT t w m) where
254− type Ref (EventWriterT t w m) = Ref m
255− newRef = lift . newRef
256− readRef = lift . readRef
257− writeRef r = lift . writeRef r
258−
259−instance MonadAtomicRef m => MonadAtomicRef (EventWriterT t w m) where
260− atomicModifyRef r = lift . atomicModifyRef r
261−
262−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (EventWriterT t w m) where
263− newEventWithTrigger = lift . newEventWithTrigger
264− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
265−
266−instance (MonadQuery t q m, Monad m) => MonadQuery t q (EventWriterT t w m) where
267− tellQueryIncremental = lift . tellQueryIncremental
268− askQueryResult = lift askQueryResult
269− queryIncremental = lift . queryIncremental
270−
271−-- | Map a function over the output of a 'EventWriterT'.
272−withEventWriterT :: (Semigroup w, Semigroup w', Reflex t, MonadHold t m, MonadFix m)
273− => (w -> w')
274− -> EventWriterT t w m a
275− -> EventWriterT t w' m a
276−withEventWriterT f ew = do
277− (r, e) <- lift $ do
278− (r, e) <- runEventWriterT ew
279− let e' = fmap f e
280− return (r, e')
281− tellEvent e
282− return r
6+import Reflex.EventWriter.Base as X
7+import Reflex.EventWriter.Class as X
src/Reflex/EventWriter/Base.hsnew file+317
@@ -0,0 +1,317 @@
1+-- | This module provides 'EventWriterT', the standard implementation of
2+-- 'EventWriter'.
3+{-# LANGUAGE CPP #-}
4+{-# LANGUAGE ExistentialQuantification #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE Rank2Types #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE TypeOperators #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+#ifdef USE_REFLEX_OPTIMIZER
14+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15+#endif
16+module Reflex.EventWriter.Base
17+ ( EventWriterT (..)
18+ , runEventWriterT
19+ , runWithReplaceEventWriterTWith
20+ , sequenceDMapWithAdjustEventWriterTWith
21+ , mapEventWriterT
22+ , withEventWriterT
23+ ) where
24+
25+import Reflex.Adjustable.Class
26+import Reflex.Class
27+import Reflex.EventWriter.Class (EventWriter, tellEvent)
28+import Reflex.DynamicWriter.Class (DynamicWriter, tellDyn)
29+import Reflex.Host.Class
30+import Reflex.PerformEvent.Class
31+import Reflex.PostBuild.Class
32+import Reflex.Query.Class
33+import Reflex.Requester.Class
34+import Reflex.TriggerEvent.Class
35+
36+import Control.Monad.Exception
37+import Control.Monad.Identity
38+import Control.Monad.Morph
39+import Control.Monad.Primitive
40+import Control.Monad.Reader
41+import Control.Monad.Ref
42+import Control.Monad.State.Strict
43+import Data.Dependent.Map (DMap)
44+import qualified Data.Dependent.Map as DMap
45+import Data.Dependent.Sum (DSum (..))
46+import Data.Functor.Compose
47+import Data.Functor.Misc
48+import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
49+import Data.IntMap.Strict (IntMap)
50+import qualified Data.IntMap.Strict as IntMap
51+import Data.List.NonEmpty (NonEmpty (..))
52+import Data.Map (Map)
53+import qualified Data.Map as Map
54+import Data.Semigroup
55+import Data.Some (Some)
56+import Data.Tuple
57+import Data.Type.Equality
58+
59+import Unsafe.Coerce
60+
61+{-# DEPRECATED TellId "Do not construct this directly; use tellId instead" #-}
62+newtype TellId w x
63+ = TellId Int -- ^ WARNING: Do not construct this directly; use 'tellId' instead
64+ deriving (Show, Eq, Ord, Enum)
65+
66+tellId :: Int -> TellId w w
67+tellId = TellId
68+{-# INLINE tellId #-}
69+
70+tellIdRefl :: TellId w x -> w :~: x
71+tellIdRefl _ = unsafeCoerce Refl
72+
73+withTellIdRefl :: TellId w x -> (w ~ x => r) -> r
74+withTellIdRefl tid r = case tellIdRefl tid of
75+ Refl -> r
76+
77+instance GEq (TellId w) where
78+ a `geq` b =
79+ withTellIdRefl a $
80+ withTellIdRefl b $
81+ if a == b
82+ then Just Refl
83+ else Nothing
84+
85+instance GCompare (TellId w) where
86+ a `gcompare` b =
87+ withTellIdRefl a $
88+ withTellIdRefl b $
89+ case a `compare` b of
90+ LT -> GLT
91+ EQ -> GEQ
92+ GT -> GGT
93+
94+data EventWriterState t w = EventWriterState
95+ { _eventWriterState_nextId :: {-# UNPACK #-} !Int -- Always negative (and decreasing over time)
96+ , _eventWriterState_told :: ![DSum (TellId w) (Event t)] -- In increasing order
97+ }
98+
99+-- | A basic implementation of 'EventWriter'.
100+newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (EventWriterState t w) m a }
101+ deriving
102+ ( Functor
103+ , Applicative
104+ , Monad
105+ , MonadTrans
106+ , MFunctor
107+ , MonadFix
108+ , MonadIO
109+ , MonadException
110+ , MonadAsyncException
111+ )
112+
113+-- | Run a 'EventWriterT' action.
114+runEventWriterT :: forall t m w a. (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
115+runEventWriterT (EventWriterT a) = do
116+ (result, requests) <- runStateT a $ EventWriterState (-1) []
117+ let combineResults :: DMap (TellId w) Identity -> w
118+ combineResults = sconcat
119+ . (\(h : t) -> h :| t) -- Unconditional; 'merge' guarantees that it will only fire with non-empty DMaps
120+ . DMap.foldlWithKey (\vs tid (Identity v) -> withTellIdRefl tid $ v : vs) [] -- This is where we finally reverse the DMap to get things in the correct order
121+ return (result, fmap combineResults $ merge $ DMap.fromDistinctAscList $ _eventWriterState_told requests) --TODO: We can probably make this fromDistinctAscList more efficient by knowing the length in advance, but this will require exposing internals of DMap; also converting it to use a strict list might help
122+
123+instance (Reflex t, Monad m, Semigroup w) => EventWriter t w (EventWriterT t w m) where
124+ tellEvent w = EventWriterT $ modify $ \old ->
125+ let myId = _eventWriterState_nextId old
126+ in EventWriterState
127+ { _eventWriterState_nextId = pred myId
128+ , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
129+ }
130+
131+instance MonadSample t m => MonadSample t (EventWriterT t w m) where
132+ sample = lift . sample
133+
134+instance MonadHold t m => MonadHold t (EventWriterT t w m) where
135+ {-# INLINABLE hold #-}
136+ hold v0 = lift . hold v0
137+ {-# INLINABLE holdDyn #-}
138+ holdDyn v0 = lift . holdDyn v0
139+ {-# INLINABLE holdIncremental #-}
140+ holdIncremental v0 = lift . holdIncremental v0
141+ {-# INLINABLE buildDynamic #-}
142+ buildDynamic a0 = lift . buildDynamic a0
143+ {-# INLINABLE headE #-}
144+ headE = lift . headE
145+ {-# INLINABLE now #-}
146+ now = lift now
147+
148+instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
149+ runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
150+ traverseIntMapWithKeyWithAdjust = sequenceIntMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') mergeIntIncremental coincidencePatchIntMap
151+ traverseDMapWithKeyWithAdjust = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith mergeMapIncremental coincidencePatchMap
152+ traverseDMapWithKeyWithAdjustWithMove = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeMapIncrementalWithMove coincidencePatchMapWithMove
153+
154+instance Requester t m => Requester t (EventWriterT t w m) where
155+ type Request (EventWriterT t w m) = Request m
156+ type Response (EventWriterT t w m) = Response m
157+ requesting = lift . requesting
158+ requesting_ = lift . requesting_
159+
160+-- | Given a function like 'runWithReplace' for the underlying monad, implement
161+-- 'runWithReplace' for 'EventWriterT'. This is necessary when the underlying
162+-- monad doesn't have a 'Adjustable' instance or to override the default
163+-- 'Adjustable' behavior.
164+runWithReplaceEventWriterTWith :: forall m t w a b. (Reflex t, MonadHold t m, Semigroup w)
165+ => (forall a' b'. m a' -> Event t (m b') -> EventWriterT t w m (a', Event t b'))
166+ -> EventWriterT t w m a
167+ -> Event t (EventWriterT t w m b)
168+ -> EventWriterT t w m (a, Event t b)
169+runWithReplaceEventWriterTWith f a0 a' = do
170+ (result0, result') <- f (runEventWriterT a0) $ fmapCheap runEventWriterT a'
171+ tellEvent =<< switchHoldPromptOnly (snd result0) (fmapCheap snd result')
172+ return (fst result0, fmapCheap fst result')
173+
174+-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceIntMapWithAdjust'.
175+sequenceIntMapWithAdjustEventWriterTWith
176+ :: forall t m p w v v'
177+ . ( Reflex t
178+ , MonadHold t m
179+ , Semigroup w
180+ , Functor p
181+ , Patch (p (Event t w))
182+ , PatchTarget (p (Event t w)) ~ IntMap (Event t w)
183+ , Patch (p w)
184+ , PatchTarget (p w) ~ IntMap w
185+ )
186+ => ( (IntMap.Key -> v -> m (Event t w, v'))
187+ -> IntMap v
188+ -> Event t (p v)
189+ -> EventWriterT t w m (IntMap (Event t w, v'), Event t (p (Event t w, v')))
190+ )
191+ -> (Incremental t (p (Event t w)) -> Event t (PatchTarget (p w)))
192+ -> (Event t (p (Event t w)) -> Event t (p w))
193+ -> (IntMap.Key -> v -> EventWriterT t w m v')
194+ -> IntMap v
195+ -> Event t (p v)
196+ -> EventWriterT t w m (IntMap v', Event t (p v'))
197+sequenceIntMapWithAdjustEventWriterTWith base mergePatchIncremental coincidencePatch f dm0 dm' = do
198+ let f' :: IntMap.Key -> v -> m (Event t w, v')
199+ f' k v = swap <$> runEventWriterT (f k v)
200+ (children0, children') <- base f' dm0 dm'
201+ let result0 = fmap snd children0
202+ result' = fmapCheap (fmap snd) children'
203+ requests0 :: IntMap (Event t w)
204+ requests0 = fmap fst children0
205+ requests' :: Event t (p (Event t w))
206+ requests' = fmapCheap (fmap fst) children'
207+ e <- switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch requests0 requests'
208+ tellEvent $ fforMaybeCheap e $ \m ->
209+ case IntMap.elems m of
210+ [] -> Nothing
211+ h : t -> Just $ sconcat $ h :| t
212+ return (result0, result')
213+
214+-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceDMapWithAdjust'.
215+sequenceDMapWithAdjustEventWriterTWith
216+ :: forall t m p p' w k v v'
217+ . ( Reflex t
218+ , MonadHold t m
219+ , Semigroup w
220+ , Patch (p' (Some k) (Event t w))
221+ , PatchTarget (p' (Some k) (Event t w)) ~ Map (Some k) (Event t w)
222+ , GCompare k
223+ , Patch (p' (Some k) w)
224+ , PatchTarget (p' (Some k) w) ~ Map (Some k) w
225+ )
226+ => ( (forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a))
227+ -> DMap k v
228+ -> Event t (p k v)
229+ -> EventWriterT t w m (DMap k (Compose ((,) (Event t w)) v'), Event t (p k (Compose ((,) (Event t w)) v')))
230+ )
231+ -> ((forall a. Compose ((,) (Event t w)) v' a -> v' a) -> p k (Compose ((,) (Event t w)) v') -> p k v')
232+ -> ((forall a. Compose ((,) (Event t w)) v' a -> Event t w) -> p k (Compose ((,) (Event t w)) v') -> p' (Some k) (Event t w))
233+ -> (Incremental t (p' (Some k) (Event t w)) -> Event t (PatchTarget (p' (Some k) w)))
234+ -> (Event t (p' (Some k) (Event t w)) -> Event t (p' (Some k) w))
235+ -> (forall a. k a -> v a -> EventWriterT t w m (v' a))
236+ -> DMap k v
237+ -> Event t (p k v)
238+ -> EventWriterT t w m (DMap k v', Event t (p k v'))
239+sequenceDMapWithAdjustEventWriterTWith base mapPatch weakenPatchWith mergePatchIncremental coincidencePatch f dm0 dm' = do
240+ let f' :: forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a)
241+ f' k v = Compose . swap <$> runEventWriterT (f k v)
242+ (children0, children') <- base f' dm0 dm'
243+ let result0 = DMap.map (snd . getCompose) children0
244+ result' = fforCheap children' $ mapPatch $ snd . getCompose
245+ requests0 :: Map (Some k) (Event t w)
246+ requests0 = weakenDMapWith (fst . getCompose) children0
247+ requests' :: Event t (p' (Some k) (Event t w))
248+ requests' = fforCheap children' $ weakenPatchWith $ fst . getCompose
249+ e <- switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch requests0 requests'
250+ tellEvent $ fforMaybeCheap e $ \m ->
251+ case Map.elems m of
252+ [] -> Nothing
253+ h : t -> Just $ sconcat $ h :| t
254+ return (result0, result')
255+
256+instance PerformEvent t m => PerformEvent t (EventWriterT t w m) where
257+ type Performable (EventWriterT t w m) = Performable m
258+ performEvent_ = lift . performEvent_
259+ performEvent = lift . performEvent
260+
261+instance PostBuild t m => PostBuild t (EventWriterT t w m) where
262+ getPostBuild = lift getPostBuild
263+
264+instance TriggerEvent t m => TriggerEvent t (EventWriterT t w m) where
265+ newTriggerEvent = lift newTriggerEvent
266+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
267+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
268+
269+instance MonadReader r m => MonadReader r (EventWriterT t w m) where
270+ ask = lift ask
271+ local f (EventWriterT a) = EventWriterT $ mapStateT (local f) a
272+ reader = lift . reader
273+
274+instance MonadRef m => MonadRef (EventWriterT t w m) where
275+ type Ref (EventWriterT t w m) = Ref m
276+ newRef = lift . newRef
277+ readRef = lift . readRef
278+ writeRef r = lift . writeRef r
279+
280+instance MonadAtomicRef m => MonadAtomicRef (EventWriterT t w m) where
281+ atomicModifyRef r = lift . atomicModifyRef r
282+
283+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (EventWriterT t w m) where
284+ newEventWithTrigger = lift . newEventWithTrigger
285+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
286+
287+instance (MonadQuery t q m, Monad m) => MonadQuery t q (EventWriterT t w m) where
288+ tellQueryIncremental = lift . tellQueryIncremental
289+ askQueryResult = lift askQueryResult
290+ queryIncremental = lift . queryIncremental
291+
292+instance DynamicWriter t w m => DynamicWriter t w (EventWriterT t v m) where
293+ tellDyn = lift . tellDyn
294+
295+instance PrimMonad m => PrimMonad (EventWriterT t w m) where
296+ type PrimState (EventWriterT t w m) = PrimState m
297+ primitive = lift . primitive
298+
299+-- | Map a function over the output of a 'EventWriterT'.
300+withEventWriterT :: (Semigroup w, Semigroup w', Reflex t, MonadHold t m)
301+ => (w -> w')
302+ -> EventWriterT t w m a
303+ -> EventWriterT t w' m a
304+withEventWriterT f ew = do
305+ (r, e) <- lift $ do
306+ (r, e) <- runEventWriterT ew
307+ let e' = fmap f e
308+ return (r, e')
309+ tellEvent e
310+ return r
311+
312+-- | Change the monad underlying an EventWriterT
313+mapEventWriterT
314+ :: (forall x. m x -> n x)
315+ -> EventWriterT t w m a
316+ -> EventWriterT t w n a
317+mapEventWriterT f (EventWriterT a) = EventWriterT $ mapStateT f a
src/Reflex/EventWriter/Class.hsnew file+26
@@ -0,0 +1,26 @@
1+-- | This module defines the 'EventWriter' class.
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FunctionalDependencies #-}
5+{-# LANGUAGE UndecidableInstances #-}
6+#ifdef USE_REFLEX_OPTIMIZER
7+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
8+#endif
9+module Reflex.EventWriter.Class
10+ ( EventWriter (..)
11+ ) where
12+
13+import Control.Monad.Reader (ReaderT, lift)
14+import Data.Semigroup (Semigroup)
15+
16+import Reflex.Class (Event)
17+
18+
19+-- | 'EventWriter' efficiently collects 'Event' values using 'tellEvent'
20+-- and combines them via 'Semigroup' to provide an 'Event' result.
21+class (Monad m, Semigroup w) => EventWriter t w m | m -> t w where
22+ tellEvent :: Event t w -> m ()
23+
24+
25+instance EventWriter t w m => EventWriter t w (ReaderT r m) where
26+ tellEvent = lift . tellEvent
src/Reflex/FastWeak.hs+73−6
@@ -5,6 +5,19 @@
55{-# LANGUAGE ForeignFunctionInterface #-}
66{-# LANGUAGE JavaScriptFFI #-}
77#endif
8+
9+-- |
10+-- Module:
11+-- Reflex.FastWeak
12+-- Description:
13+-- 'FastWeak' is a weak pointer to some value, and 'FastWeakTicket' ensures the value
14+-- referred to by a 'FastWeak' stays live while the ticket is held (live).
15+--
16+-- On GHC or GHCJS when not built with the @fast-weak@ cabal flag, 'FastWeak' is a wrapper
17+-- around the simple version of 'System.Mem.Weak.Weak' where the key and value are the same.
18+--
19+-- On GHCJS when built with the @fast-weak@ cabal flag, 'FastWeak' is implemented directly
20+-- in JS using @h$FastWeak@ and @h$FastWeakTicket@ which are a nonstandard part of the GHCJS RTS.
821module Reflex.FastWeak
922 ( FastWeakTicket
1023 , FastWeak
@@ -35,29 +48,57 @@ import System.Mem.Weak
3548
3649
3750#ifdef GHCJS_FAST_WEAK
51+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
52+-- can be used to get the referred to value without fear of @Nothing,
53+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
54+--
55+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeakTicket@.
3856newtype FastWeakTicket a = FastWeakTicket JSVal
3957
58+-- | A reference to some value which can be garbage collected if there are only
59+-- weak references to the value left.
60+--
61+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
62+--
63+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using
64+-- 'getFastWeakTicket' if the value hasn't been collected yet.
65+--
66+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeak@.
4067newtype FastWeak a = FastWeak JSVal
4168
4269-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
4370data Val a = Val { unVal :: a }
4471
45−-- | Coerce a JSVal that represents the heap object of a value of type 'a' into a value of type 'a'
72+-- | Coerce a JSVal that represents the heap object of a value of type @a@ into a value of type @a@
4673unsafeFromRawJSVal :: JSVal -> a
4774unsafeFromRawJSVal v = unVal (unsafeCoerce v)
4875
76+-- | Coerce a heap object of type @a@ into a 'JSVal' which represents that object.
4977unsafeToRawJSVal :: a -> JSVal
5078unsafeToRawJSVal v = unsafeCoerce (Val v)
5179#else
80+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
81+-- can be used to get the referred to value without fear of @Nothing@,
82+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
5283data FastWeakTicket a = FastWeakTicket
5384 { _fastWeakTicket_val :: !a
5485 , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
5586 }
5687
88+-- | A reference to some value which can be garbage collected if there are only weak references to the value left.
89+--
90+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
91+--
92+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using 'getFastWeakTicket'
93+-- if the value hasn't been collected yet.
94+--
95+-- Synonymous with 'Weak'.
5796type FastWeak a = Weak a
5897#endif
5998
60−-- This needs to be in IO so we know that we've relinquished the ticket
99+-- | Return the @a@ kept alive by the given 'FastWeakTicket'.
100+--
101+-- This needs to be in IO so we know that we've relinquished the ticket.
61102getFastWeakTicketValue :: FastWeakTicket a -> IO a
62103#ifdef GHCJS_FAST_WEAK
63104getFastWeakTicketValue t = do
@@ -69,6 +110,8 @@ foreign import javascript unsafe "$r = $1.val;" js_ticketVal :: FastWeakTicket a
69110getFastWeakTicketValue = return . _fastWeakTicket_val
70111#endif
71112
113+-- | Get the value referred to by a 'FastWeak' if it hasn't yet been collected,
114+-- or @Nothing@ if it has been collected.
72115getFastWeakValue :: FastWeak a -> IO (Maybe a)
73116#ifdef GHCJS_FAST_WEAK
74117getFastWeakValue w = do
@@ -84,6 +127,9 @@ foreign import javascript unsafe "$r = ($1.ticket === null) ? null : $1.ticket.v
84127getFastWeakValue = deRefWeak
85128#endif
86129
130+-- | Try to create a 'FastWeakTicket' for the given 'FastWeak' which will ensure the value referred
131+-- remains alive. Returns @Just@ if the value hasn't been collected
132+-- and a ticket can therefore be obtained, @Nothing@ if it's been collected.
87133getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
88134#ifdef GHCJS_FAST_WEAK
89135getFastWeakTicket w = do
@@ -103,8 +149,21 @@ getFastWeakTicket w = do
103149 }
104150#endif
105151
106−-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the associated FastWeak to actually be weak
152+-- | Create a 'FastWeakTicket' directly from a value, creating a 'FastWeak' in the process
153+-- which can be obtained with 'getFastWeakTicketValue'.
154+--
155+-- This function is marked NOINLINE so it is opaque to GHC.
156+-- If we do not do this, then GHC will sometimes fuse the constructor away
157+-- so any weak references that are attached to the ticket will have their
158+-- finalizer run. Using the opaque constructor, GHC does not see the
159+-- constructor application, so it behaves like an IORef and cannot be fused away.
160+--
161+-- The result is also evaluated to WHNF, since forcing a thunk invalidates
162+-- the weak pointer to it in some cases.
163+{-# NOINLINE mkFastWeakTicket #-}
107164mkFastWeakTicket :: a -> IO (FastWeakTicket a)
165+-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the
166+-- associated FastWeak to actually be weak
108167#ifdef GHCJS_FAST_WEAK
109168mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
110169
@@ -119,11 +178,16 @@ mkFastWeakTicket v = do
119178 }
120179#endif
121180
181+-- | Demote a 'FastWeakTicket'; which ensures the value is alive, to a 'FastWeak' which doesn't.
182+-- Note that unless the ticket for the same 'FastWeak' is held in some other way
183+-- the value might be collected immediately.
184+getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
122185-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
123186#ifdef GHCJS_FAST_WEAK
124−foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
187+foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak' :: FastWeakTicket a -> IO (FastWeak a)
188+{-# INLINE getFastWeakTicketWeak #-}
189+getFastWeakTicketWeak = getFastWeakTicketWeak'
125190#else
126−getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
127191getFastWeakTicketWeak = return . _fastWeakTicket_weak
128192#endif
129193
@@ -133,7 +197,6 @@ emptyFastWeak = unsafeCoerce w
133197 where w :: FastWeak Any
134198#ifdef GHCJS_FAST_WEAK
135199 w = js_emptyWeak
136−foreign import javascript unsafe "$r = new h$FastWeak(null);" js_emptyWeak :: FastWeak Any
137200#else
138201 w = unsafePerformIO $ do
139202 w' <- mkWeakPtr undefined Nothing
@@ -141,3 +204,7 @@ foreign import javascript unsafe "$r = new h$FastWeak(null);" js_emptyWeak :: Fa
141204 return w'
142205#endif
143206{-# NOINLINE emptyFastWeak #-}
207+
208+#ifdef GHCJS_FAST_WEAK
209+foreign import javascript unsafe "$r = new h$FastWeak(null);" js_emptyWeak :: FastWeak Any
210+#endif
src/Reflex/FunctorMaybe.hs+32−18
@@ -1,33 +1,47 @@
1−-- | This module defines the FunctorMaybe class, which extends Functors with the
2−-- ability to delete values.
1+{-# LANGUAGE CPP #-}
2+#if MIN_VERSION_base(4,9,0)
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE StandaloneDeriving #-}
5+#endif
6+
7+-- |
8+-- Module:
9+-- Reflex.FunctorMaybe
10+-- Description:
11+-- This module defines the FunctorMaybe class, which extends Functors with the
12+-- ability to delete values.
313module Reflex.FunctorMaybe
414 ( FunctorMaybe (..)
515 ) where
616
7−import Data.Maybe
17+import Data.IntMap (IntMap)
18+import Data.Map (Map)
19+#if MIN_VERSION_base(4,9,0)
20+import Data.Semigroup (Option(..))
21+#endif
22+import Data.Witherable
823
924--TODO: See if there's a better class in the standard libraries already
1025
1126-- | A class for values that combines filtering and mapping using 'Maybe'.
12−-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@. Also similar is the
13−-- @Witherable@ typeclass, but it requires @Foldable f@ and @Traverable f@,
14−-- and e.g. 'Event' is instance of neither.
15−--
16−-- A definition of 'fmapMaybe' must satisfy the following laws:
17−--
18−-- [/identity/]
19−-- @'fmapMaybe' 'Just' ≡ 'id'@
20−--
21−-- [/composition/]
22−-- @'fmapMaybe' (f <=< g) ≡ 'fmapMaybe' f . 'fmapMaybe' g@
27+-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@.
28+{-# DEPRECATED FunctorMaybe "Use 'Filterable' from Data.Witherable instead" #-}
2329class FunctorMaybe f where
2430 -- | Combined mapping and filtering function.
2531 fmapMaybe :: (a -> Maybe b) -> f a -> f b
2632
27−-- | @fmapMaybe = (=<<)
2833instance FunctorMaybe Maybe where
29− fmapMaybe = (=<<)
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
3039
31−-- | @fmapMaybe f = catMaybes . fmap f@
3240instance FunctorMaybe [] where
33− fmapMaybe f = catMaybes . fmap f
41+ fmapMaybe = mapMaybe
42+
43+instance FunctorMaybe (Map k) where
44+ fmapMaybe = mapMaybe
45+
46+instance FunctorMaybe IntMap where
47+ fmapMaybe = mapMaybe
src/Reflex/Host/Class.hs+6−26
@@ -4,7 +4,6 @@
44{-# LANGUAGE FlexibleInstances #-}
55{-# LANGUAGE FunctionalDependencies #-}
66{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE RankNTypes #-}
98{-# LANGUAGE RoleAnnotations #-}
109{-# LANGUAGE ScopedTypeVariables #-}
@@ -30,38 +29,19 @@ module Reflex.Host.Class
3029
3130import Reflex.Class
3231
33−import Control.Applicative
34−import Control.Monad
3532import Control.Monad.Fix
3633import Control.Monad.Identity
3734import Control.Monad.Ref
3835import Control.Monad.Trans
39−import Control.Monad.Trans.Cont (ContT ())
40−import Control.Monad.Trans.Except (ExceptT ())
41−import Control.Monad.Trans.Reader (ReaderT ())
42−import Control.Monad.Trans.RWS (RWST ())
43−import Control.Monad.Trans.State (StateT ())
36+import Control.Monad.Trans.Cont (ContT)
37+import Control.Monad.Trans.Except (ExceptT)
38+import Control.Monad.Trans.Reader (ReaderT)
39+import Control.Monad.Trans.RWS (RWST)
40+import Control.Monad.Trans.State (StateT)
4441import qualified Control.Monad.Trans.State.Strict as Strict
45−import Control.Monad.Trans.Writer (WriterT ())
42+import Control.Monad.Trans.Writer (WriterT)
4643import Data.Dependent.Sum (DSum (..))
4744import Data.GADT.Compare
48−import Data.Monoid
49−
50−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
51−import Control.Monad.Primitive (touch)
52−import Data.IORef
53−import Reflex.Spider.Internal (EventM (..), HasSpiderTimeline, RootTrigger, SpiderEventHandle (..),
54− SpiderHost (..), SpiderHostFrame (..), Subscriber (..), newEventWithTriggerIO,
55− newFanEventWithTriggerIO, run, runFrame, scheduleClear, subscribe)
56−import qualified Reflex.Spider.Internal
57−#endif
58−
59−-- Note: this import must come last to silence warnings from AMP
60−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
61−
62−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
63−#include "../Spider/SpiderTimelineHost.include.hs"
64−#endif
6545
6646-- | Framework implementation support class for the reflex implementation
6747-- represented by @t@.
src/Reflex/Host/Headless.hsnew file+128
@@ -0,0 +1,128 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE TypeFamilies #-}
5+{-# LANGUAGE ConstraintKinds #-}
6+
7+module Reflex.Host.Headless where
8+
9+import Control.Concurrent.Chan (newChan, readChan)
10+import Control.Monad (unless)
11+import Control.Monad.Fix (MonadFix, fix)
12+import Control.Monad.IO.Class (MonadIO, liftIO)
13+import Control.Monad.Primitive (PrimMonad)
14+import Control.Monad.Ref (MonadRef, Ref, readRef)
15+import Data.Dependent.Sum (DSum (..), (==>))
16+import Data.Foldable (for_)
17+import Data.Functor.Identity (Identity(..))
18+import Data.IORef (IORef, readIORef)
19+import Data.Maybe (catMaybes, fromMaybe)
20+import Data.Traversable (for)
21+
22+import Reflex
23+import Reflex.Host.Class
24+
25+type MonadHeadlessApp t m =
26+ ( Adjustable t m
27+ , MonadFix m
28+ , MonadHold t m
29+ , MonadIO (HostFrame t)
30+ , MonadIO (Performable m)
31+ , MonadIO m
32+ , MonadRef (HostFrame t)
33+ , NotReady t m
34+ , PerformEvent t m
35+ , PostBuild t m
36+ , PrimMonad (HostFrame t)
37+ , Ref (HostFrame t) ~ IORef
38+ , Ref m ~ IORef
39+ , Reflex t
40+ , ReflexHost t
41+ , TriggerEvent t m
42+ )
43+
44+-- | Run a headless FRP network. Inside the action, you will most probably use
45+-- the capabilities provided by the 'TriggerEvent' and 'PerformEvent' type
46+-- classes to interface the FRP network with the outside world. Useful for
47+-- testing. Each headless network runs on its own spider timeline.
48+runHeadlessApp
49+ :: (forall t m. MonadHeadlessApp t m => m (Event t ()))
50+ -- ^ The action to be run in the headless FRP network. The FRP network is
51+ -- closed at the first occurrence of the resulting 'Event'.
52+ -> IO ()
53+runHeadlessApp guest =
54+ -- We are using the 'Spider' implementation of reflex. Running the host
55+ -- allows us to take actions on the FRP timeline.
56+ withSpiderTimeline $ runSpiderHostForTimeline $ do
57+ -- Create the "post-build" event and associated trigger. This event fires
58+ -- once, when the application starts.
59+ (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
60+ -- Create a queue to which we will write 'Event's that need to be
61+ -- processed.
62+ events <- liftIO newChan
63+ -- Run the "guest" application, providing the appropriate context. We'll
64+ -- pure the result of the action, and a 'FireCommand' that will be used to
65+ -- trigger events.
66+ (result, fc@(FireCommand fire)) <- do
67+ hostPerformEventT $ -- Allows the guest app to run
68+ -- 'performEvent', so that actions
69+ -- (e.g., IO actions) can be run when
70+ -- 'Event's fire.
71+
72+ flip runPostBuildT postBuild $ -- Allows the guest app to access to
73+ -- a "post-build" 'Event'
74+
75+ flip runTriggerEventT events $ -- Allows the guest app to create new
76+ -- events and triggers and write
77+ -- those triggers to a channel from
78+ -- which they will be read and
79+ -- processed.
80+ guest
81+
82+ -- Read the trigger reference for the post-build event. This will be
83+ -- 'Nothing' if the guest application hasn't subscribed to this event.
84+ mPostBuildTrigger <- readRef postBuildTriggerRef
85+
86+ -- Subscribe to an 'Event' of that the guest application can use to
87+ -- request application shutdown. We'll check whether this 'Event' is firing
88+ -- to determine whether to terminate.
89+ shutdown <- subscribeEvent result
90+
91+ -- When there is a subscriber to the post-build event, fire the event.
92+ soa <- for mPostBuildTrigger $ \postBuildTrigger ->
93+ fire [postBuildTrigger :=> Identity ()] $ isFiring shutdown
94+
95+ -- The main application loop. We wait for new events and fire those that
96+ -- have subscribers. If we detect a shutdown request, the application
97+ -- terminates.
98+ unless (or (fromMaybe [] soa)) $ fix $ \loop -> do
99+ -- Read the next event (blocking).
100+ ers <- liftIO $ readChan events
101+ stop <- do
102+ -- Fire events that have subscribers.
103+ fireEventTriggerRefs fc ers $
104+ -- Check if the shutdown 'Event' is firing.
105+ isFiring shutdown
106+ if or stop
107+ then pure ()
108+ else loop
109+ where
110+ isFiring ev = readEvent ev >>= \case
111+ Nothing -> pure False
112+ Just _ -> pure True
113+ -- Use the given 'FireCommand' to fire events that have subscribers
114+ -- and call the callback for the 'TriggerInvocation' of each.
115+ fireEventTriggerRefs
116+ :: MonadIO m
117+ => FireCommand t m
118+ -> [DSum (EventTriggerRef t) TriggerInvocation]
119+ -> ReadPhase m a
120+ -> m [a]
121+ fireEventTriggerRefs (FireCommand fire) ers rcb = do
122+ mes <- liftIO $
123+ for ers $ \(EventTriggerRef er :=> TriggerInvocation a _) -> do
124+ me <- readIORef er
125+ pure $ fmap (==> a) me
126+ a <- fire (catMaybes mes) rcb
127+ liftIO $ for_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
128+ pure a
src/Reflex/Network.hs+14−9
@@ -1,10 +1,13 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DefaultSignatures #-}
32{-# LANGUAGE MultiParamTypeClasses #-}
4−{-# LANGUAGE FunctionalDependencies #-}
53#ifdef USE_REFLEX_OPTIMIZER
64{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
75#endif
6+-- |
7+-- Module:
8+-- Reflex.Network
9+-- Description:
10+-- This module provides combinators for building FRP graphs/networks and modifying them dynamically.
811module Reflex.Network
912 ( networkView
1013 , networkHold
@@ -12,29 +15,31 @@ module Reflex.Network
1215 ) where
1316
1417import Reflex.Class
18+import Reflex.Adjustable.Class
1519import Reflex.NotReady.Class
1620import Reflex.PostBuild.Class
1721
18−-- | Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
19−-- The returned Event of network results occurs when the Dynamic does.
20−-- 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').
21−networkView :: (Reflex t, NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
22+-- | A 'Dynamic' "network": Takes a 'Dynamic' of network-creating actions and replaces the network whenever the 'Dynamic' updates.
23+-- The returned Event of network results fires at post-build time and when the 'Dynamic' updates.
24+-- Note: Often, the type 'a' is an Event, in which case the return value is an Event-of-Events, where the outer 'Event' fires
25+-- when switching networks. Such an 'Event' would typically be flattened (via 'switchPromptly').
26+networkView :: (NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
2227networkView child = do
2328 postBuild <- getPostBuild
2429 let newChild = leftmost [updated child, tagCheap (current child) postBuild]
2530 snd <$> runWithReplace notReady newChild
2631
27−-- | 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.
2833-- The returned Dynamic of network results occurs when the Event does.
2934-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
30−networkHold :: (Reflex t, Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
35+networkHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
3136networkHold child0 newChild = do
3237 (result0, newResult) <- runWithReplace child0 newChild
3338 holdDyn result0 newResult
3439
3540-- | Render a placeholder network to be shown while another network is not yet
3641-- done building
37−untilReady :: (Reflex t, Adjustable t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
42+untilReady :: (Adjustable t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
3843untilReady a b = do
3944 postBuild <- getPostBuild
4045 runWithReplace a $ b <$ postBuild
src/Reflex/NotReady/Class.hs+16−6
@@ -1,9 +1,9 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE DefaultSignatures #-}
3−{-# LANGUAGE MultiParamTypeClasses #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE FunctionalDependencies #-}
56{-# LANGUAGE TypeFamilies #-}
6−{-# LANGUAGE FlexibleInstances #-}
77{-# LANGUAGE UndecidableInstances #-}
88#ifdef USE_REFLEX_OPTIMIZER
99{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -12,17 +12,19 @@ module Reflex.NotReady.Class
1212 ( NotReady(..)
1313 ) where
1414
15−import Control.Monad.Trans
1615import Control.Monad.Reader (ReaderT)
16+import Control.Monad.Trans
17+import Control.Monad.Trans.Writer (WriterT)
1718
19+import Reflex.BehaviorWriter.Base (BehaviorWriterT)
1820import Reflex.Class
21+import Reflex.DynamicWriter.Base (DynamicWriterT)
22+import Reflex.EventWriter.Base (EventWriterT)
1923import Reflex.Host.Class
24+import Reflex.PerformEvent.Base (PerformEventT (..))
2025import Reflex.PostBuild.Base (PostBuildT)
21−import Reflex.EventWriter (EventWriterT)
22−import Reflex.DynamicWriter (DynamicWriterT)
2326import Reflex.Query.Base (QueryT)
2427import Reflex.Requester.Base (RequesterT)
25−import Reflex.PerformEvent.Base (PerformEventT(..))
2628import Reflex.TriggerEvent.Base (TriggerEventT)
2729
2830class Monad m => NotReady t m | m -> t where
@@ -38,6 +40,10 @@ instance NotReady t m => NotReady t (ReaderT r m) where
3840 notReadyUntil = lift . notReadyUntil
3941 notReady = lift notReady
4042
43+instance (NotReady t m, Monoid w) => NotReady t (WriterT w m) where
44+ notReadyUntil = lift . notReadyUntil
45+ notReady = lift notReady
46+
4147instance NotReady t m => NotReady t (PostBuildT t m) where
4248 notReadyUntil = lift . notReadyUntil
4349 notReady = lift notReady
@@ -50,6 +56,10 @@ instance NotReady t m => NotReady t (DynamicWriterT t w m) where
5056 notReadyUntil = lift . notReadyUntil
5157 notReady = lift notReady
5258
59+instance NotReady t m => NotReady t (BehaviorWriterT t w m) where
60+ notReadyUntil = lift . notReadyUntil
61+ notReady = lift notReady
62+
5363instance NotReady t m => NotReady t (QueryT t q m) where
5464 notReadyUntil = lift . notReadyUntil
5565 notReady = lift notReady
src/Reflex/Optimizer.hs+13−4
@@ -1,10 +1,14 @@
1−-- | This module provides a GHC plugin designed to improve code that uses
2−-- Reflex. Currently, it just adds an INLINABLE pragma to any top-level
3−-- definition that doesn't have an explicit inlining pragma. In the future,
4−-- additional optimizations are likely to be added.
51{-# LANGUAGE CPP #-}
62{-# LANGUAGE LambdaCase #-}
73{-# LANGUAGE OverloadedStrings #-}
4+-- |
5+-- Module:
6+-- Reflex.Optimizer
7+-- Description:
8+-- This module provides a GHC plugin designed to improve code that uses
9+-- Reflex. Currently, it just adds an INLINABLE pragma to any top-level
10+-- definition that doesn't have an explicit inlining pragma. In the future,
11+-- additional optimizations are likely to be added.
812module Reflex.Optimizer
913 ( plugin
1014 ) where
@@ -16,6 +20,11 @@ import Control.Arrow
1620import CoreMonad
1721import Data.String
1822import GhcPlugins
23+
24+#if MIN_VERSION_base(4,9,0)
25+import Prelude hiding ((<>))
26+#endif
27+
1928#endif
2029
2130#ifdef ghcjs_HOST_OS
src/Reflex/Patch.hsdeleted−34
@@ -1,34 +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, patchDMapWithMoveToPatchMapWithMoveWith, mapPatchDMapWithMove, weakenPatchDMapWithMoveWith, traversePatchDMapWithMoveWithKey, unsafePatchDMapWithMove, unPatchDMapWithMove)
12−import Reflex.Patch.Map as X
13−import Reflex.Patch.MapWithMove as X (PatchMapWithMove, patchMapWithMoveNewElementsMap, patchMapWithMoveNewElements, unsafePatchMapWithMove, unPatchMapWithMove)
14−import Reflex.Patch.IntMap as X hiding (getDeletions)
15−
16−import Data.Semigroup (Semigroup (..), (<>))
17−
18−---- Patches based on commutative groups
19−
20−-- | A 'Group' is a 'Monoid' where every element has an inverse.
21−class (Semigroup q, Monoid q) => Group q where
22− negateG :: q -> q
23− (~~) :: q -> q -> q
24− r ~~ s = r <> negateG s
25−
26−-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
27−class Semigroup q => Additive q where
28−
29−-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
30−newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
31−
32−instance Additive p => Patch (AdditivePatch p) where
33− type PatchTarget (AdditivePatch p) = p
34− apply (AdditivePatch p) q = Just $ p <> q
src/Reflex/Patch/Class.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−-- | The interface for types which represent changes made to other types
3−module Reflex.Patch.Class where
4−
5−import Control.Monad.Identity
6−import Data.Maybe
7−
8−-- | A 'Patch' type represents a kind of change made to a datastructure.
9−class Patch p where
10− type PatchTarget p :: *
11− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
12− -- 'Nothing'.
13− apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
14−
15−-- | Apply a 'Patch'; if it does nothing, return the original value
16−applyAlways :: Patch p => p -> PatchTarget p -> PatchTarget p
17−applyAlways p t = fromMaybe t $ apply p t
18−
19−-- | 'Identity' can be used as a 'Patch' that always fully replaces the value
20−instance Patch (Identity a) where
21− type PatchTarget (Identity a) = a
22− apply (Identity a) _ = Just a
src/Reflex/Patch/DMap.hsdeleted−68
@@ -1,68 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE PolyKinds #-}
4−{-# LANGUAGE Rank2Types #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE StandaloneDeriving #-}
7−{-# LANGUAGE TypeFamilies #-}
8−module Reflex.Patch.DMap where
9−
10−import Reflex.Patch.Class
11−import Reflex.Patch.IntMap
12−import Reflex.Patch.Map
13−
14−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
15−import qualified Data.Dependent.Map as DMap
16−import Data.Functor.Constant
17−import qualified Data.IntMap as IntMap
18−import Data.Functor.Misc
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−281
@@ -1,281 +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−module Reflex.Patch.DMapWithMove where
14−
15−import Reflex.Patch.Class
16−import Reflex.Patch.MapWithMove (PatchMapWithMove (..))
17−import qualified Reflex.Patch.MapWithMove as MapWithMove
18−
19−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
20−import qualified Data.Dependent.Map as DMap
21−import Data.Dependent.Sum (EqTag (..))
22−import Data.Functor.Constant
23−import Data.Functor.Misc
24−import Data.Functor.Product
25−import Data.GADT.Compare (GEq (..))
26−import qualified Data.Map as Map
27−import Data.Maybe
28−import Data.Semigroup (Semigroup (..), (<>))
29−import Data.Some (Some)
30−import qualified Data.Some as Some
31−import Data.These
32−
33−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
34−import Data.Dependent.Sum (ShowTag (..))
35−import Data.GADT.Show (GShow (..))
36−import Data.Typeable (Proxy (..))
37−#endif
38−
39−-- | Like 'PatchMapWithMove', but for 'DMap'.
40−newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
41−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
42− deriving (Show)
43−#endif
44−
45−data NodeInfo k v a = NodeInfo
46− { _nodeInfo_from :: !(From k v a)
47− , _nodeInfo_to :: !(To k a)
48− }
49− deriving (Show)
50−
51−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
52−instance {-# INCOHERENT #-} (GShow k, ShowTag k v) => ShowTag k (NodeInfo k v) where
53− showTagToShow k _ r = gshowToShow k $ showTagToShow k (Proxy :: Proxy v) r
54−
55−instance {-# INCOHERENT #-} (GEq k, EqTag k v) => EqTag k (From k v) where
56− eqTagToEq k _ r = eqTagToEq k (Proxy :: Proxy v) (geqToEq k r)
57−#endif
58−
59−data From (k :: a -> *) (v :: a -> *) :: a -> * where
60− From_Insert :: v a -> From k v a
61− From_Delete :: From k v a
62− From_Move :: !(k a) -> From k v a
63− deriving (Show, Read, Eq, Ord)
64−
65−type To = ComposeMaybe
66−
67−validPatchDMapWithMove :: forall k v. (GCompare k, EqTag k (ComposeMaybe k)) => PatchDMapWithMove k v -> Bool
68−validPatchDMapWithMove (PatchDMapWithMove m) = src == srcFromDst
69− where
70− src = DMap.map _nodeInfo_to m
71− dst = DMap.map _nodeInfo_from m
72− srcFromDst :: DMap k (ComposeMaybe k)
73− srcFromDst = DMap.fromList $ flip fmap (DMap.toList dst) $ \(to :=> edit) -> case edit of
74− From_Move from -> from :=> ComposeMaybe (Just to)
75− _ -> to :=> ComposeMaybe Nothing
76−
77−instance EqTag k (NodeInfo k v) => Eq (PatchDMapWithMove k v) where
78− PatchDMapWithMove a == PatchDMapWithMove b = a == b
79−
80−data Pair1 f g a = Pair1 (f a) (g a)
81−
82−instance GCompare k => Semigroup (PatchDMapWithMove k v) where
83− (<>) = mappend
84−
85−data Fixup k v a
86− = Fixup_Delete
87− | Fixup_Update (These (From k v a) (To k a))
88−
89−instance GCompare k => Monoid (PatchDMapWithMove k v) where
90− mempty = PatchDMapWithMove mempty
91− PatchDMapWithMove ma `mappend` PatchDMapWithMove mb = PatchDMapWithMove m
92− where
93− connections = DMap.toList $ DMap.intersectionWithKey (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b)) ma mb
94− h :: DSum k (Pair1 (ComposeMaybe k) (From k v)) -> [DSum k (Fixup k v)]
95− h (_ :=> Pair1 (ComposeMaybe mToAfter) editBefore) = case (mToAfter, editBefore) of
96− (Just toAfter, From_Move fromBefore)
97− | isJust $ fromBefore `geq` toAfter
98− -> [toAfter :=> Fixup_Delete]
99− | otherwise
100− -> [ toAfter :=> Fixup_Update (This editBefore)
101− , fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))
102− ]
103− (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
104− (Just toAfter, _) -> [toAfter :=> Fixup_Update (This editBefore)]
105− (Nothing, _) -> []
106− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
107− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
108− | This x <- a, That y <- b
109− = Fixup_Update $ These x y
110− | That y <- a, This x <- b
111− = Fixup_Update $ These x y
112− mergeFixups _ _ _ = error "PatchDMapWithMove: incompatible fixups"
113− fixups = DMap.fromListWithKey mergeFixups $ concatMap h connections
114− combineNodeInfos _ nia nib = NodeInfo
115− { _nodeInfo_from = _nodeInfo_from nia
116− , _nodeInfo_to = _nodeInfo_to nib
117− }
118− applyFixup _ ni = \case
119− Fixup_Delete -> Nothing
120− Fixup_Update u -> Just $ NodeInfo
121− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
122− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
123− }
124− m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
125−
126−getHere :: These a b -> Maybe a
127−getHere = \case
128− This a -> Just a
129− These a _ -> Just a
130− That _ -> Nothing
131−
132−getThere :: These a b -> Maybe b
133−getThere = \case
134− This _ -> Nothing
135− These _ b -> Just b
136− That b -> Just b
137−
138−{-
139−mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
140−PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
141− where
142− 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
143− removeRedundantDst toKey (From_Move fromKey) | isJust (toKey `geq` fromKey) = Nothing
144− removeRedundantDst _ a = Just a
145− f :: forall a. k a -> From k v a -> Maybe (From k v a)
146− f toKey _ = removeRedundantDst toKey $ case getDstAction toKey dstAfter of
147− From_Move fromKey -> getDstAction fromKey dstBefore
148− nonMove -> nonMove
149− dst = DMap.mapMaybeWithKey f $ DMap.union dstAfter dstBefore
150− getSrcAction k m = fromMaybe (ComposeMaybe $ Just k) $ DMap.lookup k m
151− removeRedundantSrc fromKey (ComposeMaybe (Just toKey)) | isJust (fromKey `geq` toKey) = Nothing
152− removeRedundantSrc _ a = Just a
153− g :: forall a. k a -> ComposeMaybe k a -> Maybe (ComposeMaybe k a)
154− g fromKey _ = removeRedundantSrc fromKey $ case getSrcAction fromKey srcBefore of
155− ComposeMaybe Nothing -> ComposeMaybe Nothing
156− ComposeMaybe (Just toKeyBefore) -> getSrcAction toKeyBefore srcAfter
157− src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
158−-}
159−
160−moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
161−moveDMapKey src dst = case src `geq` dst of
162− Nothing -> PatchDMapWithMove $ DMap.fromList
163− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
164− , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
165− ]
166− Just _ -> mempty
167−
168−deleteDMapKey :: k a -> PatchDMapWithMove k v
169−deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
170−
171−{-
172−k1, k2 :: Const2 Int () ()
173−k1 = Const2 1
174−k2 = Const2 2
175−p1, p2 :: PatchDMapWithMove (Const2 Int ()) Identity
176−p1 = moveDMapKey k1 k2
177−p2 = moveDMapKey k2 k1
178−p12 = p1 <> p2
179−p21 = p2 <> p1
180−p12Slow = p1 `mappendPatchDMapWithMoveSlow` p2
181−p21Slow = p2 `mappendPatchDMapWithMoveSlow` p1
182−
183−testPatchDMapWithMove = do
184− print p1
185− print p2
186− print $ p12 == deleteDMapKey k1
187− print $ p21 == deleteDMapKey k2
188− print $ p12Slow == deleteDMapKey k1
189− print $ p21Slow == deleteDMapKey k2
190−
191−dst (PatchDMapWithMove x _) = x
192−src (PatchDMapWithMove _ x) = x
193−-}
194−
195−unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
196−unPatchDMapWithMove (PatchDMapWithMove p) = p
197−
198−-- | Warning: when using this function, you must ensure that the invariants of
199−-- 'PatchDMapWithMove' are preserved; they will not be checked.
200−unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
201−unsafePatchDMapWithMove = PatchDMapWithMove
202−
203−mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
204−mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $
205− DMap.map (\ni -> ni { _nodeInfo_from = g $ _nodeInfo_from ni }) p
206− where g :: forall a. From k v a -> From k v' a
207− g = \case
208− From_Insert v -> From_Insert $ f v
209− From_Delete -> From_Delete
210− From_Move k -> From_Move k
211−
212−traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
213−traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
214−
215−traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
216−traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
217− where g :: forall a. k a -> From k v a -> m (From k v' a)
218− g k = \case
219− From_Insert v -> From_Insert <$> f k v
220− From_Delete -> pure From_Delete
221− From_Move fromKey -> pure $ From_Move fromKey
222−
223−nodeInfoMapFrom :: (From k v a -> From k v' a) -> NodeInfo k v a -> NodeInfo k v' a
224−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
225−
226−nodeInfoMapFromM :: Functor f => (From k v a -> f (From k v' a)) -> NodeInfo k v a -> f (NodeInfo k v' a)
227−nodeInfoMapFromM f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
228−
229−weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) v'
230−weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
231− where g :: forall a. NodeInfo k v a -> MapWithMove.NodeInfo (Some k) v'
232− g ni = MapWithMove.NodeInfo
233− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
234− From_Insert v -> MapWithMove.From_Insert $ f v
235− From_Delete -> MapWithMove.From_Delete
236− From_Move k -> MapWithMove.From_Move $ Some.This k
237− , MapWithMove._nodeInfo_to = Some.This <$> getComposeMaybe (_nodeInfo_to ni)
238− }
239−
240−patchDMapWithMoveToPatchMapWithMoveWith :: forall k f v v'. (f v -> v') -> PatchDMapWithMove (Const2 k v) f -> PatchMapWithMove k v'
241−patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
242− where g :: NodeInfo (Const2 k v) f v -> MapWithMove.NodeInfo k v'
243− g ni = MapWithMove.NodeInfo
244− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
245− From_Insert v -> MapWithMove.From_Insert $ f v
246− From_Delete -> MapWithMove.From_Delete
247− From_Move (Const2 k) -> MapWithMove.From_Move k
248− , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
249− }
250−
251−const2PatchDMapWithMoveWith :: forall k v f a. (v -> f a) -> PatchMapWithMove k v -> PatchDMapWithMove (Const2 k a) f
252−const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
253− where g :: (k, MapWithMove.NodeInfo k v) -> DSum (Const2 k a) (NodeInfo (Const2 k a) f)
254− g (k, ni) = Const2 k :=> NodeInfo
255− { _nodeInfo_from = case MapWithMove._nodeInfo_from ni of
256− MapWithMove.From_Insert v -> From_Insert $ f v
257− MapWithMove.From_Delete -> From_Delete
258− MapWithMove.From_Move fromKey -> From_Move $ Const2 fromKey
259− , _nodeInfo_to = ComposeMaybe $ Const2 <$> MapWithMove._nodeInfo_to ni
260− }
261−
262−instance GCompare k => Patch (PatchDMapWithMove k v) where
263− type PatchTarget (PatchDMapWithMove k v) = DMap k v
264− 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?
265− where insertions = DMap.mapMaybeWithKey insertFunc p
266− insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
267− insertFunc _ ni = case _nodeInfo_from ni of
268− From_Insert v -> Just v
269− From_Move k -> DMap.lookup k old
270− From_Delete -> Nothing
271− deletions = DMap.mapMaybeWithKey deleteFunc p
272− deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
273− deleteFunc _ ni = case _nodeInfo_from ni of
274− From_Delete -> Just $ Constant ()
275− _ -> Nothing
276−
277−-- | Get the values that will be deleted or moved if the given patch is applied
278−-- to the given 'DMap'.
279−getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
280−getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
281− where f _ v ni = Pair v $ _nodeInfo_to ni
src/Reflex/Patch/IntMap.hsdeleted−50
@@ -1,50 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveFoldable #-}
4−{-# LANGUAGE DeriveTraversable #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE TypeFamilies #-}
7−module Reflex.Patch.IntMap where
8−
9−import Prelude hiding (lookup)
10−import Data.IntMap.Strict (IntMap)
11−import qualified Data.IntMap.Strict as IntMap
12−import Data.Maybe
13−import Data.Semigroup
14−import Reflex.Patch.Class
15−
16−newtype PatchIntMap a = PatchIntMap (IntMap (Maybe a)) deriving (Functor, Foldable, Traversable, Monoid)
17−
18−instance Patch (PatchIntMap a) where
19− type PatchTarget (PatchIntMap a) = IntMap a
20− apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
21− let removes = IntMap.filter isNothing p
22− adds = IntMap.mapMaybe id p
23− in IntMap.union adds $ v `IntMap.difference` removes
24−
25−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
26−-- If the same key is modified by both patches, the one on the left will take
27−-- precedence.
28−instance Semigroup (PatchIntMap v) where
29− PatchIntMap a <> PatchIntMap b = PatchIntMap $ a `mappend` b --TODO: Add a semigroup instance for Map
30− -- PatchMap is idempotent, so stimes n is id for every n
31−#if MIN_VERSION_semigroups(0,17,0)
32− stimes = stimesIdempotentMonoid
33−#else
34− times1p n x = case compare n 0 of
35− LT -> error "stimesIdempotentMonoid: negative multiplier"
36− EQ -> mempty
37− GT -> x
38−#endif
39−
40−traverseIntMapPatchWithKey :: Applicative t => (Int -> a -> t b) -> PatchIntMap a -> t (PatchIntMap b)
41−traverseIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap <$> IntMap.traverseWithKey (\k mv -> traverse (f k) mv) m
42−
43−patchIntMapNewElements :: PatchIntMap a -> [a]
44−patchIntMapNewElements (PatchIntMap m) = catMaybes $ IntMap.elems m
45−
46−patchIntMapNewElementsMap :: PatchIntMap a -> IntMap a
47−patchIntMapNewElementsMap (PatchIntMap m) = IntMap.mapMaybe id m
48−
49−getDeletions :: PatchIntMap v -> IntMap v' -> IntMap v'
50−getDeletions (PatchIntMap m) v = IntMap.intersection v m
src/Reflex/Patch/Map.hsdeleted−64
@@ -1,64 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE TypeFamilies #-}
4−-- | 'Patch'es on 'Map' that consist only of insertions (including overwrites)
5−-- and deletions
6−module Reflex.Patch.Map where
7−
8−import Reflex.Patch.Class
9−
10−import Data.Semigroup
11−import Data.Map (Map)
12−import qualified Data.Map as Map
13−import Data.Maybe
14−
15−-- | A set of changes to a 'Map'. Any element may be inserted/updated or
16−-- deleted. Insertions are represented as values wrapped in 'Just', while
17−-- deletions are represented as 'Nothing's
18−newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
19− deriving (Show, Read, Eq, Ord)
20−
21−-- | Applying a 'PatchMap' will update the 'Map' by performing the insertions
22−-- and deletions specified
23−instance Ord k => Patch (PatchMap k v) where
24− type PatchTarget (PatchMap k v) = Map k v
25− {-# INLINABLE apply #-}
26− apply (PatchMap p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
27− where insertions = Map.mapMaybeWithKey (const id) p
28− deletions = Map.mapMaybeWithKey (const nothingToJust) p
29− nothingToJust = \case
30− Nothing -> Just ()
31− Just _ -> Nothing
32−
33−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
34−-- If the same key is modified by both patches, the one on the left will take
35−-- precedence.
36−instance Ord k => Semigroup (PatchMap k v) where
37− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
38− -- PatchMap is idempotent, so stimes n is id for every n
39−#if MIN_VERSION_semigroups(0,17,0)
40− stimes = stimesIdempotentMonoid
41−#else
42− times1p n x = case compare n 0 of
43− LT -> error "stimesIdempotentMonoid: negative multiplier"
44− EQ -> mempty
45− GT -> x
46−#endif
47−
48−-- | The empty 'PatchMap' contains no insertions or deletions
49−instance Ord k => Monoid (PatchMap k v) where
50− mempty = PatchMap mempty
51− mappend = (<>)
52−
53−-- | 'fmap'ping a 'PatchMap' will alter all of the values it will insert.
54−-- Deletions are unaffected.
55−instance Functor (PatchMap k) where
56− fmap f = PatchMap . fmap (fmap f) . unPatchMap
57−
58−-- | Returns all the new elements that will be added to the 'Map'
59−patchMapNewElements :: PatchMap k v -> [v]
60−patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
61−
62−-- | Returns all the new elements that will be added to the 'Map'
63−patchMapNewElementsMap :: PatchMap k v -> Map k v
64−patchMapNewElementsMap (PatchMap p) = Map.mapMaybe id p
src/Reflex/Patch/MapWithMove.hsdeleted−156
@@ -1,156 +0,0 @@
1−{-# LANGUAGE DeriveFoldable #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveTraversable #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TypeFamilies #-}
8−-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
9−-- another
10−module Reflex.Patch.MapWithMove where
11−
12−import Reflex.Patch.Class
13−
14−import Control.Arrow
15−import Control.Monad.State
16−import Data.Foldable
17−import Data.Function
18−import Data.List
19−import Data.Map (Map)
20−import qualified Data.Map as Map
21−import Data.Maybe
22−import qualified Data.Set as Set
23−import Data.Tuple
24−
25−-- | Patch a DMap with additions, deletions, and moves. Invariant: If key @k1@
26−-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
27−-- and vice versa. There should never be any unpaired From/To keys.
28−newtype PatchMapWithMove k v = PatchMapWithMove (Map k (NodeInfo k v)) deriving (Show, Eq, Ord, Functor, Foldable, Traversable)
29−
30−-- | Holds the information about each key: where its new value should come from,
31−-- and where its old value should go to
32−data NodeInfo k v = NodeInfo
33− { _nodeInfo_from :: !(From k v)
34− -- ^ Where do we get the new value for this key?
35− , _nodeInfo_to :: !(To k)
36− -- ^ If the old value is being kept (i.e. moved rather than deleted or
37− -- replaced), where is it going?
38− }
39− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
40−
41−-- | Create a 'PatchMapWithMove', validating it
42−patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
43−patchMapWithMove m = if valid then Just $ PatchMapWithMove m else Nothing
44− where valid = forwardLinks == backwardLinks
45− forwardLinks = Map.mapMaybe _nodeInfo_to m
46− backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, v) ->
47− case _nodeInfo_from v of
48− From_Move from -> Just (from, to)
49− _ -> Nothing
50−
51−-- | Extract the internal representation of the 'PatchMapWithMove'
52−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
53−unPatchMapWithMove (PatchMapWithMove p) = p
54−
55−-- | Warning: when using this function, you must ensure that the invariants of
56−-- 'PatchMapWithMove' are preserved; they will not be checked.
57−unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
58−unsafePatchMapWithMove = PatchMapWithMove
59−
60−-- | Describe how a key's new value should be produced
61−data From k v
62− = From_Insert v -- ^ Insert the given value here
63− | From_Delete -- ^ Delete the existing value, if any, from here
64− | From_Move !k -- ^ Move the value here from the given key
65− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
66−
67−-- | Describe where a key's old value will go. If this is 'Just', that means
68−-- the key's old value will be moved to the given other key; if it is 'Nothing',
69−-- that means it will be deleted.
70−type To = Maybe
71−
72−-- | Apply the insertions, deletions, and moves to a given 'Map'
73−instance Ord k => Patch (PatchMapWithMove k v) where
74− type PatchTarget (PatchMapWithMove k v) = Map k v
75− apply (PatchMapWithMove p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
76− where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
77− From_Insert v -> Just v
78− From_Move k -> Map.lookup k old
79− From_Delete -> Nothing
80− deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
81− From_Delete -> Just ()
82− _ -> Nothing
83−
84−-- | Returns all the new elements that will be added to the 'Map'
85−patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
86−patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
87−
88−patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
89−patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
90− where f ni = case _nodeInfo_from ni of
91− From_Insert v -> Just v
92− From_Move _ -> Nothing
93− From_Delete -> Nothing
94−
95−-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
96−-- its values using the given ordering function. The set keys of the 'Map' is
97−-- not changed.
98−patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
99−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
100− where unsorted = Map.toList m
101− sorted = sortBy (cmp `on` snd) unsorted
102− f (to, _) (from, _) = if to == from then Nothing else
103− Just (from, to)
104− reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
105− g (to, _) (from, _) = if to == from then Nothing else
106− let Just movingTo = Map.lookup from reverseMapping
107− in Just (to, NodeInfo (From_Move from) $ Just movingTo)
108−
109−-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
110−-- will produce a 'Map' with the same values as the second 'Map' but with the
111−-- values sorted with the given ordering function.
112−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
113−patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patch
114− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
115− newList = Map.toList newByIndexUnsorted
116− newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
117− insertsAndMoves :: Map k (NodeInfo k v)
118− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
119− let f k v = do
120− remainingValues <- get
121− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
122− then Map.delete v remainingValues
123− else Map.insert v remainingKeys remainingValues
124− case Map.lookup v remainingValues of
125− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
126− Just fromKs ->
127− if k `Set.member` fromKs
128− then do
129− putRemainingKeys $ Set.delete k fromKs
130− return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
131− else do
132− Just (fromK, remainingKeys) <- return $ Set.minView fromKs -- There's an existing value, but it's not here; move it here
133− putRemainingKeys remainingKeys
134− return $ NodeInfo (From_Move fromK) $ Just undefined
135− Map.traverseWithKey f newByIndex
136− unusedOldKeys = fold unusedValuesByValue
137− pointlessMove k = \case
138− From_Move k' | k == k' -> True
139− _ -> False
140− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
141− then Just undefined
142− else Nothing
143− patch = unsafePatchMapWithMove $ Map.filterWithKey (\k -> not . pointlessMove k . _nodeInfo_from) $ Map.mergeWithKey (\k a _ -> Just $ nodeInfoSetTo (keyWasMoved k) a) (Map.mapWithKey $ \k -> nodeInfoSetTo $ keyWasMoved k) (Map.mapWithKey $ \k _ -> NodeInfo From_Delete $ keyWasMoved k) insertsAndMoves oldByIndex
144−
145−-- | Change the 'From' value of a 'NodeInfo'
146−nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
147−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
148−
149−-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
150−-- 'Applicative', 'Monad', etc.) action to get the new value
151−nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
152−nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
153−
154−-- | Set the 'To' field of a 'NodeInfo'
155−nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
156−nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
src/Reflex/PerformEvent/Base.hs+7−4
@@ -25,6 +25,7 @@ module Reflex.PerformEvent.Base
2525 ) where
2626
2727import Reflex.Class
28+import Reflex.Adjustable.Class
2829import Reflex.Host.Class
2930import Reflex.PerformEvent.Class
3031import Reflex.Requester.Base
@@ -60,14 +61,14 @@ deriving instance ReflexHost t => Monad (PerformEventT t m)
6061deriving instance ReflexHost t => MonadFix (PerformEventT t m)
6162deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
6263deriving instance (ReflexHost t, MonadException (HostFrame t)) => MonadException (PerformEventT t m)
63−deriving instance (ReflexHost t, Applicative m, Monoid a) => Monoid (PerformEventT t m a)
64−deriving instance (ReflexHost t, Applicative m, S.Semigroup a) => S.Semigroup (PerformEventT t m a)
64+deriving instance (ReflexHost t, Monoid a) => Monoid (PerformEventT t m a)
65+deriving instance (ReflexHost t, S.Semigroup a) => S.Semigroup (PerformEventT t m a)
6566
6667instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
6768 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
6869 primitive = PerformEventT . lift . primitive
6970
70−instance (ReflexHost t, Ref m ~ Ref IO, PrimMonad (HostFrame t)) => PerformEvent t (PerformEventT t m) where
71+instance (ReflexHost t, Ref m ~ Ref IO) => PerformEvent t (PerformEventT t m) where
7172 type Performable (PerformEventT t m) = HostFrame t
7273 {-# INLINABLE performEvent_ #-}
7374 performEvent_ = PerformEventT . requesting_
@@ -140,7 +141,7 @@ hostPerformEventT a = do
140141 case mToPerform of
141142 Nothing -> return [result']
142143 Just toPerform -> do
143− responses <- runHostFrame $ traverseRequesterData (\v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
144145 mrt <- readRef responseTrigger
145146 let followupEventTriggers = case mrt of
146147 Just rt -> [rt :=> Identity responses]
@@ -163,6 +164,8 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
163164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
164165 {-# INLINABLE headE #-}
165166 headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
166169
167170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
168171 type Ref (PerformEventT t m) = Ref (HostFrame t)
src/Reflex/PerformEvent/Class.hs+6−2
@@ -5,11 +5,9 @@
55{-# LANGUAGE FlexibleContexts #-}
66{-# LANGUAGE FlexibleInstances #-}
77{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
98{-# LANGUAGE RankNTypes #-}
109{-# LANGUAGE ScopedTypeVariables #-}
1110{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
1311{-# LANGUAGE UndecidableInstances #-}
1412#ifdef USE_REFLEX_OPTIMIZER
1513{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +21,7 @@ import Reflex.Class
2321import Reflex.TriggerEvent.Class
2422
2523import Control.Monad.Reader
24+import Control.Monad.Trans.Maybe (MaybeT (..))
2625
2726-- | 'PerformEvent' represents actions that can trigger other actions based on
2827-- 'Event's.
@@ -62,3 +61,8 @@ instance PerformEvent t m => PerformEvent t (ReaderT r m) where
6261 performEvent e = do
6362 r <- ask
6463 lift $ performEvent $ flip runReaderT r <$> e
64+
65+instance PerformEvent t m => PerformEvent t (MaybeT m) where
66+ type Performable (MaybeT m) = MaybeT (Performable m)
67+ performEvent_ = lift . performEvent_ . fmapCheap (void . runMaybeT)
68+ performEvent = lift . fmap (fmapMaybe id) . performEvent . fmapCheap runMaybeT
src/Reflex/PostBuild/Base.hs+4−2
@@ -9,7 +9,6 @@
99{-# LANGUAGE RecursiveDo #-}
1010{-# LANGUAGE ScopedTypeVariables #-}
1111{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
1312{-# LANGUAGE UndecidableInstances #-}
1413#ifdef USE_REFLEX_OPTIMIZER
1514{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +22,7 @@ module Reflex.PostBuild.Base
2322 ) where
2423
2524import Reflex.Class
25+import Reflex.Adjustable.Class
2626import Reflex.Host.Class
2727import Reflex.PerformEvent.Class
2828import Reflex.PostBuild.Class
@@ -83,6 +83,8 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
8383 buildDynamic a0 = lift . buildDynamic a0
8484 {-# INLINABLE headE #-}
8585 headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
8688
8789instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
8890 type Performable (PostBuildT t m) = Performable m
@@ -151,7 +153,7 @@ mapIntMapWithAdjustImpl base f dm0 dm' = do
151153 rec (result0, result') <- base f' loweredDm0 loweredDm'
152154 cohortDone <- numberOccurrencesFrom_ 1 result'
153155 numberedDm' <- numberOccurrencesFrom 1 dm'
154− let postBuild' = fanInt $ fmapCheap (\n -> IntMap.singleton n ()) cohortDone
156+ let postBuild' = fanInt $ fmapCheap (`IntMap.singleton` ()) cohortDone
155157 loweredDm' = flip pushAlways numberedDm' $ \(n, p) -> do
156158 return $ fmap ((,) (selectInt postBuild' n)) p
157159 return (result0, result')
src/Reflex/PostBuild/Class.hs−2
@@ -4,10 +4,8 @@
44{-# LANGUAGE DataKinds #-}
55{-# LANGUAGE FlexibleInstances #-}
66{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE ScopedTypeVariables #-}
98{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
119{-# LANGUAGE UndecidableInstances #-}
1210#ifdef USE_REFLEX_OPTIMIZER
1311{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
src/Reflex/Profiled.hs+99−23
@@ -1,4 +1,5 @@
11{-# LANGUAGE EmptyDataDecls #-}
2+{-# LANGUAGE FlexibleContexts #-}
23{-# LANGUAGE FlexibleInstances #-}
34{-# LANGUAGE GeneralizedNewtypeDeriving #-}
45{-# LANGUAGE InstanceSigs #-}
@@ -7,35 +8,56 @@
78{-# LANGUAGE StandaloneDeriving #-}
89{-# LANGUAGE TypeFamilies #-}
910{-# 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.
1020module Reflex.Profiled where
1121
12−import Control.Lens hiding (children)
1322import Control.Monad
23+import Control.Monad.Exception
1424import Control.Monad.Fix
1525import Control.Monad.Primitive
1626import Control.Monad.Reader
1727import Control.Monad.Ref
1828import Control.Monad.State.Strict (StateT, execStateT, modify)
29+import Data.Bifunctor
1930import Data.Coerce
20−import Data.Dependent.Map (DMap, GCompare)
21−import Data.List
31+import Data.Dependent.Map (DMap)
32+import Data.GADT.Compare (GCompare)
2233import Data.FastMutableIntMap
2334import Data.IORef
35+import Data.List
2436import Data.Map (Map)
2537import qualified Data.Map.Strict as Map
26−import Data.Monoid
38+import Data.Monoid ((<>))
2739import Data.Ord
40+import Data.Profunctor.Unsafe ((#.))
41+import qualified Data.Semigroup as S
2842import Data.Type.Coercion
2943import Foreign.Ptr
3044import GHC.Foreign
3145import GHC.IO.Encoding
3246import GHC.Stack
47+import Reflex.Adjustable.Class
48+import Reflex.BehaviorWriter.Class
3349import Reflex.Class
34−import Reflex.PerformEvent.Class
50+import Reflex.DynamicWriter.Class
51+import Reflex.EventWriter.Class
3552import Reflex.Host.Class
53+import Reflex.NotReady.Class
54+import Reflex.PerformEvent.Class
55+import Reflex.PostBuild.Class
56+import Reflex.Query.Class
57+import Reflex.Requester.Class
58+import Reflex.TriggerEvent.Class
3659
3760import System.IO.Unsafe
38−import Unsafe.Coerce
3961
4062data ProfiledTimeline t
4163
@@ -50,9 +72,13 @@ data CostCentreTree = CostCentreTree
5072 }
5173 deriving (Show, Eq, Ord)
5274
75+instance S.Semigroup CostCentreTree where
76+ (CostCentreTree oa ea ca) <> (CostCentreTree ob eb cb) =
77+ CostCentreTree (oa + ob) (ea + eb) $ Map.unionWith (S.<>) ca cb
78+
5379instance Monoid CostCentreTree where
5480 mempty = CostCentreTree 0 0 mempty
55− CostCentreTree oa ea ca `mappend` CostCentreTree ob eb cb = CostCentreTree (oa + ob) (ea + eb) $ Map.unionWith (<>) ca cb
81+ mappend = (S.<>)
5682
5783getCostCentreStack :: Ptr CostCentreStack -> IO [Ptr CostCentre]
5884getCostCentreStack = go []
@@ -64,9 +90,9 @@ getCostCentreStack = go []
6490 go (cc : l) parent
6591
6692toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
67−toCostCentreTree ccs n = do
68− ccList <- getCostCentreStack ccs
69− return $ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty) ccList
93+toCostCentreTree ccs n =
94+ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty)
95+ <$> getCostCentreStack ccs
7096
7197getCostCentreTree :: IO CostCentreTree
7298getCostCentreTree = do
@@ -95,7 +121,8 @@ writeProfilingData :: FilePath -> IO ()
95121writeProfilingData p = do
96122 writeFile p =<< formatCostCentreTree =<< getCostCentreTree
97123
98−newtype ProfiledM m a = ProfiledM { runProfiledM :: m a } deriving (Functor, Applicative, Monad, MonadFix)
124+newtype ProfiledM m a = ProfiledM { runProfiledM :: m a }
125+ deriving (Functor, Applicative, Monad, MonadFix, MonadException, MonadAsyncException)
99126
100127profileEvent :: Reflex t => Event t a -> Event t a
101128profileEvent e = unsafePerformIO $ do
@@ -119,27 +146,32 @@ instance Reflex t => Reflex (ProfiledTimeline t) where
119146 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
120147 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
121148 pull = Behavior_Profiled . pull . coerce
122− merge :: forall k. GCompare k => DMap k (Event (ProfiledTimeline t)) -> Event (ProfiledTimeline t) (DMap k Identity)
123− merge = Event_Profiled . merge . (unsafeCoerce :: DMap k (Event (ProfiledTimeline t)) -> DMap k (Event t))
124− fan (Event_Profiled e) = EventSelector $ coerce $ select (fan $ profileEvent e)
149+ fanG (Event_Profiled e) = EventSelectorG $ coerce $ selectG (fanG $ profileEvent e)
150+ mergeG :: forall z (k :: z -> *) q v. GCompare k
151+ => (forall a. q a -> Event (ProfiledTimeline t) (v a))
152+ -> DMap k q -> Event (ProfiledTimeline t) (DMap k v)
153+ mergeG nt = Event_Profiled #. mergeG (coerce nt)
125154 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
126155 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
127156 current (Dynamic_Profiled d) = coerce $ current d
128157 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
129158 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
130159 unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
131− mergeIncremental = Event_Profiled . mergeIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMap k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMap k (Event t)))
132− mergeIncrementalWithMove = Event_Profiled . mergeIncrementalWithMove . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMapWithMove k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMapWithMove k (Event t)))
160+ mergeIncrementalG nt res = Event_Profiled $ mergeIncrementalG (coerce nt) (coerce res)
161+ mergeIncrementalWithMoveG nt res = Event_Profiled $ mergeIncrementalWithMoveG (coerce nt) (coerce res)
133162 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
134163 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
135164 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
136− behaviorCoercion (c :: Coercion a b) = case behaviorCoercion c :: Coercion (Behavior t a) (Behavior t b) of
137− Coercion -> unsafeCoerce (Coercion :: Coercion (Behavior (ProfiledTimeline t) a) (Behavior (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
138− eventCoercion (c :: Coercion a b) = case eventCoercion c :: Coercion (Event t a) (Event t b) of
139− Coercion -> unsafeCoerce (Coercion :: Coercion (Event (ProfiledTimeline t) a) (Event (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
140− dynamicCoercion (c :: Coercion a b) = case dynamicCoercion c :: Coercion (Dynamic t a) (Dynamic t b) of
141− Coercion -> unsafeCoerce (Coercion :: Coercion (Dynamic (ProfiledTimeline t) a) (Dynamic (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
142− mergeIntIncremental = Event_Profiled . mergeIntIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchIntMap (Event (ProfiledTimeline t) a)) -> Incremental t (PatchIntMap (Event t a)))
165+ behaviorCoercion c =
166+ Coercion `trans` behaviorCoercion @t c `trans` Coercion
167+ eventCoercion c =
168+ Coercion `trans` eventCoercion @t c `trans` Coercion
169+ dynamicCoercion c =
170+ Coercion `trans` dynamicCoercion @t c `trans` Coercion
171+ incrementalCoercion c d =
172+ Coercion `trans` incrementalCoercion @t c d `trans` Coercion
173+ mergeIntIncremental = Event_Profiled . mergeIntIncremental .
174+ coerceWith (Coercion `trans` incrementalCoercion Coercion Coercion `trans` Coercion)
143175 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
144176
145177deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
@@ -152,10 +184,21 @@ instance MonadHold t m => MonadHold (ProfiledTimeline t) (ProfiledM m) where
152184 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
153185 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
154186 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
187+ now = ProfiledM $ Event_Profiled <$> now
155188
156189instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
157190 sample (Behavior_Profiled b) = ProfiledM $ sample b
158191
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+
159202instance MonadTrans ProfiledM where
160203 lift = ProfiledM
161204
@@ -167,6 +210,39 @@ instance PerformEvent t m => PerformEvent (ProfiledTimeline t) (ProfiledM m) whe
167210 performEvent_ = lift . performEvent_ . coerce
168211 performEvent = lift . fmap coerce . performEvent . coerce
169212
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+
170246instance MonadRef m => MonadRef (ProfiledM m) where
171247 type Ref (ProfiledM m) = Ref m
172248 newRef = lift . newRef
src/Reflex/Pure.hs+38−27
@@ -5,6 +5,9 @@
55{-# LANGUAGE MultiParamTypeClasses #-}
66{-# LANGUAGE ScopedTypeVariables #-}
77{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE PolyKinds #-}
10+
811#ifdef USE_REFLEX_OPTIMIZER
912{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1013#endif
@@ -13,11 +16,13 @@
1316-- * MonadSample (Pure t) ((->) t)
1417-- * MonadHold (Pure t) ((->) t)
1518{-# OPTIONS_GHC -fno-warn-orphans #-}
16−
17−-- | This module provides a pure implementation of Reflex, which is intended to
18−-- serve as a reference for the semantics of the Reflex class. All
19−-- implementations of Reflex should produce the same results as this
20−-- implementation, although performance and laziness/strictness may differ.
19+-- |
20+-- Module: Reflex.Pure
21+-- Description:
22+-- This module provides a pure implementation of Reflex, which is intended to
23+-- serve as a reference for the semantics of the Reflex class. All
24+-- implementations of Reflex should produce the same results as this
25+-- implementation, although performance and laziness/strictness may differ.
2126module Reflex.Pure
2227 ( Pure
2328 , Behavior (..)
@@ -26,14 +31,10 @@ module Reflex.Pure
2631 , Incremental (..)
2732 ) where
2833
29−#if !MIN_VERSION_base(4,8,0)
30−import Control.Applicative
31−#endif
32−
3334import Control.Monad
34−import Data.Dependent.Map (DMap, GCompare)
35+import Data.Dependent.Map (DMap)
36+import Data.GADT.Compare (GCompare)
3537import qualified Data.Dependent.Map as DMap
36−import Data.Functor.Identity
3738import Data.IntMap (IntMap)
3839import qualified Data.IntMap as IntMap
3940import Data.Maybe
@@ -41,14 +42,15 @@ import Data.MemoTrie
4142import Data.Monoid
4243import Data.Type.Coercion
4344import Reflex.Class
45+import Data.Kind (Type)
4446
4547-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
46−-- with the type @t@.
47−data Pure t
48+-- with the type @/t/@.
49+data Pure (t :: Type)
4850
49−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
50−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
51−-- exclusively to memoize functions of t, not for any of its other capabilities.
51+-- | The 'Enum' instance of @/t/@ must be dense: for all @/x :: t/@, there must not exist
52+-- any @/y :: t/@ such that @/'pred' x < y < x/@. The 'HasTrie' instance will be used
53+-- exclusively to memoize functions of @/t/@, not for any of its other capabilities.
5254instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
5355
5456 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
@@ -77,17 +79,19 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
7779 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
7880 -- warning because the GCompare instance is not used; however, removing the
7981 -- GCompare instance produces a different warning, due to that constraint
80− -- being present in the original class definition
82+ -- being present in the original class definition.
8183
82− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
83− merge events = Event $ memo $ \t ->
84− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
84+ --mergeG :: GCompare k => (forall a. q a -> Event (Pure t) (v a))
85+ -- -> DMap k q -> Event (Pure t) (DMap k v)
86+ mergeG nt events = Event $ memo $ \t ->
87+ let currentOccurrences = DMap.mapMaybeWithKey (\_ q -> case nt q of Event a -> a t) events
8588 in if DMap.null currentOccurrences
8689 then Nothing
8790 else Just currentOccurrences
8891
89− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
90− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
92+-- The instance signature doeesn't compile, leave commented for documentation
93+-- fanG :: GCompare k => Event (Pure t) (DMap k v) -> EventSelectorG (Pure t) k v
94+ fanG e = EventSelectorG $ \k -> Event $ \t -> unEvent e t >>= DMap.lookup k
9195
9296 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
9397 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
@@ -110,8 +114,8 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
110114 --a) -> Incremental (Pure t) p a
111115 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
112116
113− mergeIncremental = mergeIncrementalImpl
114− mergeIncrementalWithMove = mergeIncrementalImpl
117+ mergeIncrementalG = mergeIncrementalImpl
118+ mergeIncrementalWithMoveG = mergeIncrementalImpl
115119
116120 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
117121
@@ -126,14 +130,17 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
126130 behaviorCoercion Coercion = Coercion
127131 eventCoercion Coercion = Coercion
128132 dynamicCoercion Coercion = Coercion
133+ incrementalCoercion Coercion Coercion = Coercion
129134
130135 fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
131136
132137 mergeIntIncremental = mergeIntIncrementalImpl
133138
134−mergeIncrementalImpl :: (PatchTarget p ~ DMap k (Event (Pure t)), GCompare k) => Incremental (Pure t) p -> Event (Pure t) (DMap k Identity)
135−mergeIncrementalImpl i = Event $ \t ->
136− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ unIncremental i t
139+mergeIncrementalImpl :: (PatchTarget p ~ DMap k q, GCompare k)
140+ => (forall a. q a -> Event (Pure t) (v a))
141+ -> Incremental (Pure t) p -> Event (Pure t) (DMap k v)
142+mergeIncrementalImpl nt i = Event $ \t ->
143+ let results = DMap.mapMaybeWithKey (\_ q -> case nt q of Event e -> e t) $ fst $ unIncremental i t
137144 in if DMap.null results
138145 then Nothing
139146 else Just results
@@ -204,3 +211,7 @@ instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
204211 Just x -> fromMaybe lastValue $ apply x lastValue
205212
206213 headE = slowHeadE
214+ now t = Event $ guard . (t ==)
215+
216+
217+
src/Reflex/Query/Base.hs+115−55
@@ -1,12 +1,14 @@
11{-# LANGUAGE FlexibleInstances #-}
22{-# LANGUAGE GeneralizedNewtypeDeriving #-}
33{-# LANGUAGE InstanceSigs #-}
4−{-# LANGUAGE KindSignatures #-}
4+{-# LANGUAGE LambdaCase #-}
55{-# LANGUAGE MultiParamTypeClasses #-}
66{-# LANGUAGE RankNTypes #-}
77{-# LANGUAGE ScopedTypeVariables #-}
88{-# LANGUAGE TypeFamilies #-}
99{-# LANGUAGE UndecidableInstances #-}
10+{-# LANGUAGE StandaloneDeriving #-}
11+
1012module Reflex.Query.Base
1113 ( QueryT (..)
1214 , runQueryT
@@ -14,40 +16,52 @@ module Reflex.Query.Base
1416 , mapQueryResult
1517 , dynWithQueryT
1618 , withQueryT
19+ , mapQueryT
1720 ) where
1821
1922import Control.Applicative (liftA2)
2023import Control.Monad.Exception
2124import Control.Monad.Fix
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
2227import Control.Monad.Reader
2328import Control.Monad.Ref
2429import Control.Monad.State.Strict
2530import Data.Align
26−import Data.Dependent.Map (DMap, DSum (..))
31+import Data.Dependent.Map (DMap)
2732import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
2834import Data.Foldable
2935import Data.Functor.Compose
3036import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
38+import Data.IntMap (IntMap)
39+import qualified Data.IntMap as IntMap
3140import Data.Map (Map)
3241import qualified Data.Map as Map
33−import Data.Monoid
42+import Data.Monoid ((<>))
3443import qualified Data.Semigroup as S
35−import Data.Some (Some)
36−import qualified Data.Some as Some
44+import Data.Some (Some(Some))
3745import Data.These
3846
3947import Reflex.Class
40−import Reflex.EventWriter
48+import Reflex.Adjustable.Class
49+import Reflex.DynamicWriter.Class
50+import Reflex.EventWriter.Base
51+import Reflex.EventWriter.Class
4152import Reflex.Host.Class
53+import qualified Data.Patch.MapWithMove as MapWithMove
4254import Reflex.PerformEvent.Class
4355import Reflex.PostBuild.Class
4456import Reflex.Query.Class
4557import Reflex.Requester.Class
4658import Reflex.TriggerEvent.Class
47−import qualified Reflex.Patch.MapWithMove as MapWithMove
4859
4960newtype QueryT t q m a = QueryT { unQueryT :: StateT [Behavior t q] (EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m)) a }
50− deriving (Functor, Applicative, Monad, MonadException, MonadFix, MonadIO, MonadHold t, MonadSample t, MonadAtomicRef)
61+ deriving (Functor, Applicative, Monad, MonadException, MonadFix, MonadIO, MonadAtomicRef)
62+
63+deriving instance MonadHold t m => MonadHold t (QueryT t q m)
64+deriving instance MonadSample t m => MonadSample t (QueryT t q m)
5165
5266runQueryT :: (MonadFix m, Additive q, Group q, Reflex t) => QueryT t q m a -> Dynamic t (QueryResult q) -> m (a, Incremental t (AdditivePatch q))
5367runQueryT (QueryT a) qr = do
@@ -62,30 +76,69 @@ getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
6276getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
6377getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
6478
65−{-
66−let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
67− sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
68− bs' = fmapCheap snd $ r'
69− patches = unsafeBuildIncremental (sampleBs bs0) $
70− flip pushCheap bs' $ \bs -> do
71− p <- (~~) <$> sampleBs bs <*> sample (currentIncremental patches)
72− return (Just (AdditivePatch p))
73−-}
74−
75−instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adjustable t m) => Adjustable t (QueryT t q m) where
79+maskMempty :: (Eq a, Monoid a) => a -> Maybe a
80+maskMempty x = if x == mempty then Nothing else Just x
81+
82+instance (Reflex t, MonadFix m, Group q, Additive q, Query q, Eq q, MonadHold t m, Adjustable t m) => Adjustable t (QueryT t q m) where
7683 runWithReplace (QueryT a0) a' = do
7784 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
7885 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
7986 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
8087 bs' = fmapCheap snd $ r'
8188 bbs <- hold bs0 bs'
82− let patches = flip pushAlwaysCheap bs' $ \newBs -> do
89+ let patches = flip pushCheap bs' $ \newBs -> do
8390 oldBs <- sample bbs
84− (~~) <$> sampleBs newBs <*> sampleBs oldBs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
8592 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
8693 QueryT $ lift $ tellEvent patches
8794 return (r0, fmapCheap fst r')
88− traverseDMapWithKeyWithAdjust :: forall (k :: * -> *) v v'. (DMap.GCompare k) => (forall a. k a -> v a -> QueryT t q m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> QueryT t q m (DMap k v', Event t (PatchDMap k v'))
95+
96+ traverseIntMapWithKeyWithAdjust :: forall v v'. (IntMap.Key -> v -> QueryT t q m v') -> IntMap v -> Event t (PatchIntMap v) -> QueryT t q m (IntMap v', Event t (PatchIntMap v'))
97+ traverseIntMapWithKeyWithAdjust f im0 im' = do
98+ let f' :: IntMap.Key -> v -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (QueryTLoweredResult t q v')
99+ f' k v = fmap QueryTLoweredResult $ flip runStateT [] $ unQueryT $ f k v
100+ (result0, result') <- QueryT $ lift $ traverseIntMapWithKeyWithAdjust f' im0 im'
101+ let liftedResult0 = IntMap.map getQueryTLoweredResultValue result0
102+ liftedResult' = fforCheap result' $ \(PatchIntMap p) -> PatchIntMap $
103+ IntMap.map (fmap getQueryTLoweredResultValue) p
104+ liftedBs0 :: IntMap [Behavior t q]
105+ liftedBs0 = IntMap.map getQueryTLoweredResultWritten result0
106+ liftedBs' :: Event t (PatchIntMap [Behavior t q])
107+ liftedBs' = fforCheap result' $ \(PatchIntMap p) -> PatchIntMap $
108+ IntMap.map (fmap getQueryTLoweredResultWritten) p
109+ sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
110+ sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
111+ accumBehaviors :: forall m'. MonadHold t m'
112+ => IntMap [Behavior t q]
113+ -> PatchIntMap [Behavior t q]
114+ -> m' ( Maybe (IntMap [Behavior t q])
115+ , Maybe (AdditivePatch q))
116+ -- f accumulates the child behavior state we receive from running traverseIntMapWithKeyWithAdjust for the underlying monad.
117+ -- When an update occurs, it also computes a patch to communicate to the parent QueryT state.
118+ -- bs0 is a Map denoting the behaviors of the current children.
119+ -- pbs is a PatchMap denoting an update to the behaviors of the current children
120+ accumBehaviors bs0 pbs@(PatchIntMap bs') = do
121+ let p k bs = case IntMap.lookup k bs0 of
122+ Nothing -> case bs of
123+ -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
124+ Nothing -> return mempty
125+ -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
126+ Just newBs -> sampleBs newBs
127+ Just oldBs -> case bs of
128+ -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
129+ Nothing -> negateG <$> sampleBs oldBs
130+ -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
131+ -- composed with the sampling the child's new state.
132+ Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
133+ -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
134+ -- child patches and wrap them in AdditivePatch.
135+ patch <- AdditivePatch . fold <$> IntMap.traverseWithKey p bs'
136+ return (apply pbs bs0, Just patch)
137+ (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
138+ tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
139+ return (liftedResult0, liftedResult')
140+
141+ traverseDMapWithKeyWithAdjust :: forall (k :: * -> *) v v'. (GCompare k) => (forall a. k a -> v a -> QueryT t q m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> QueryT t q m (DMap k v', Event t (PatchDMap k v'))
89142 traverseDMapWithKeyWithAdjust f dm0 dm' = do
90143 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
91144 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -94,10 +147,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
94147 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
95148 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
96149 liftedBs0 :: Map (Some k) [Behavior t q]
97− 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
98151 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
99152 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
100− 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
101154 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
102155 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
103156 accumBehaviors :: forall m'. MonadHold t m'
@@ -113,23 +166,24 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
113166 let p k bs = case Map.lookup k bs0 of
114167 Nothing -> case bs of
115168 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
116− Nothing -> return mempty
169+ Nothing -> return Nothing
117170 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
118− Just newBs -> sampleBs newBs
171+ Just newBs -> maskMempty <$> sampleBs newBs
119172 Just oldBs -> case bs of
120173 -- 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
121− Nothing -> negateG <$> sampleBs oldBs
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
122175 -- 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
123176 -- composed with the sampling the child's new state.
124− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
125178 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
126179 -- child patches and wrap them in AdditivePatch.
127− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
128− return (apply pbs bs0, Just patch)
180+ patch <- fold <$> Map.traverseWithKey p bs'
181+ return (apply pbs bs0, AdditivePatch <$> patch)
129182 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
130183 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
131184 return (liftedResult0, liftedResult')
132− traverseDMapWithKeyWithAdjustWithMove :: forall (k :: * -> *) v v'. (DMap.GCompare k) => (forall a. k a -> v a -> QueryT t q m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> QueryT t q m (DMap k v', Event t (PatchDMapWithMove k v'))
185+
186+ traverseDMapWithKeyWithAdjustWithMove :: forall (k :: * -> *) v v'. (GCompare k) => (forall a. k a -> v a -> QueryT t q m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> QueryT t q m (DMap k v', Event t (PatchDMapWithMove k v'))
133187 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
134188 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
135189 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -137,10 +191,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
137191 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
138192 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
139193 liftedBs0 :: Map (Some k) [Behavior t q]
140− 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
141195 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
142196 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
143− 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 -}
144198 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
145199 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
146200 accumBehaviors' :: forall m'. MonadHold t m'
@@ -157,28 +211,28 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
157211 p k bs = case Map.lookup k bs0 of
158212 Nothing -> case MapWithMove._nodeInfo_from bs of
159213 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
160− MapWithMove.From_Delete -> return mempty
214+ MapWithMove.From_Delete -> return Nothing
161215 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
162− MapWithMove.From_Insert newBs -> sampleBs newBs
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
163217 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
164− Nothing -> return mempty
165− Just newBs -> sampleBs newBs
218+ Nothing -> return Nothing
219+ Just newBs -> maskMempty <$> sampleBs newBs
166220 Just oldBs -> case MapWithMove._nodeInfo_from bs of
167221 -- 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
168− MapWithMove.From_Delete -> negateG <$> sampleBs oldBs
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
169223 -- 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
170224 -- composed with the sampling the child's new state.
171− MapWithMove.From_Insert newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
225+ MapWithMove.From_Insert newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
172226 MapWithMove.From_Move k'
173− | k' == k -> return mempty
227+ | k' == k -> return Nothing
174228 | otherwise -> case Map.lookup k' bs0 of
175229 -- If we are moving from a non-existent key, that is a delete
176− Nothing -> negateG <$> sampleBs oldBs
177− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
178232 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
179233 -- child patches and wrap them in AdditivePatch.
180− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
181− return (apply pbs bs0, Just patch)
234+ patch <- fold <$> Map.traverseWithKey p bs'
235+ return (apply pbs bs0, AdditivePatch <$> patch)
182236 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
183237 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
184238 return (liftedResult0, liftedResult')
@@ -186,6 +240,13 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
186240instance MonadTrans (QueryT t q) where
187241 lift = QueryT . lift . lift . lift
188242
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+
189250instance PostBuild t m => PostBuild t (QueryT t q m) where
190251 getPostBuild = lift getPostBuild
191252
@@ -215,18 +276,11 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (QueryT t q
215276-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
216277instance (Monoid a, Monad m) => Monoid (QueryT t q m a) where
217278 mempty = pure mempty
218− mappend = liftA2 mappend
279+ mappend = (<>)
219280
220281instance (S.Semigroup a, Monad m) => S.Semigroup (QueryT t q m a) where
221282 (<>) = liftA2 (S.<>)
222283
223−
224−mapQuery :: QueryMorphism q q' -> q -> q'
225−mapQuery = _queryMorphism_mapQuery
226−
227−mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
228−mapQueryResult = _queryMorphism_mapQueryResult
229−
230284-- | withQueryT's QueryMorphism argument needs to be a group homomorphism in order to behave correctly
231285withQueryT :: (MonadFix m, PostBuild t m, Group q, Group q', Additive q, Additive q', Query q')
232286 => QueryMorphism q q'
@@ -240,6 +294,10 @@ withQueryT f a = do
240294 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
241295 return result
242296
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+
243301-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
244302dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
245303 => Dynamic t (QueryMorphism q q')
@@ -252,7 +310,7 @@ dynWithQueryT f q = do
252310 return result
253311 where zipDynIncrementalWith g da ib =
254312 let eab = align (updated da) (updatedIncremental ib)
255− ec = flip push eab $ \o -> case o of
313+ ec = flip push eab $ \case
256314 This a -> do
257315 aOld <- sample $ current da
258316 b <- sample $ currentIncremental ib
@@ -273,8 +331,7 @@ instance (Monad m, Group q, Additive q, Query q, Reflex t) => MonadQuery t q (Qu
273331 askQueryResult = QueryT ask
274332 queryIncremental q = do
275333 tellQueryIncremental q
276− r <- askQueryResult
277− return $ zipDynWith crop (incrementalToDynamic q) r
334+ zipDynWith crop (incrementalToDynamic q) <$> askQueryResult
278335
279336instance Requester t m => Requester t (QueryT t q m) where
280337 type Request (QueryT t q m) = Request m
@@ -284,3 +341,6 @@ instance Requester t m => Requester t (QueryT t q m) where
284341
285342instance EventWriter t w m => EventWriter t w (QueryT t q m) where
286343 tellEvent = lift . tellEvent
344+
345+instance DynamicWriter t w m => DynamicWriter t w (QueryT t q m) where
346+ tellDyn = lift . tellDyn
src/Reflex/Query/Class.hs+92−11
@@ -1,11 +1,18 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveDataTypeable #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE FunctionalDependencies #-}
56{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
77{-# LANGUAGE TypeFamilies #-}
88{-# LANGUAGE UndecidableInstances #-}
9+-- |
10+-- Module:
11+-- Reflex.Query.Class
12+-- Description:
13+-- A class that ties together queries to some data source and their results,
14+-- providing methods for requesting data from the source and accumulating
15+-- streamed results.
916module Reflex.Query.Class
1017 ( Query (..)
1118 , QueryMorphism (..)
@@ -15,29 +22,94 @@ module Reflex.Query.Class
1522 , MonadQuery (..)
1623 , tellQueryDyn
1724 , queryDyn
25+ , subQuery
26+ , mapQuery
27+ , mapQueryResult
1828 ) where
1929
30+import Control.Category (Category)
31+import qualified Control.Category as Cat
2032import Control.Monad.Reader
2133import Data.Bits
2234import Data.Data
2335import Data.Ix
24−import Data.Semigroup
36+import Data.Map.Monoidal (MonoidalMap)
37+import qualified Data.Map.Monoidal as MonoidalMap
38+import Data.Semigroup (Semigroup(..))
2539import Foreign.Storable
40+import Data.Void
41+import Data.Monoid hiding ((<>))
42+import Control.Applicative
2643
2744import Reflex.Class
2845
46+-- | A 'Query' can be thought of as a declaration of interest in some set of data.
47+-- A 'QueryResult' is the set of data associated with that interest set.
48+-- The @crop@ function provides a way to determine what part of a given 'QueryResult'
49+-- is relevant to a given 'Query'.
2950class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
3051 type QueryResult a :: *
3152 crop :: a -> QueryResult a -> QueryResult a
3253
33−-- | NB: QueryMorphism's must be group homomorphisms when acting on the query type
34−-- and compatible with the query relationship when acting on the query result
54+instance (Ord k, Query v) => Query (MonoidalMap k v) where
55+ type QueryResult (MonoidalMap k v) = MonoidalMap k (QueryResult v)
56+ crop q r = MonoidalMap.intersectionWith (flip crop) r q
57+
58+-- | the result of two queries is both results.
59+instance (Query a, Query b) => Query (a, b) where
60+ type QueryResult (a, b) = (QueryResult a, QueryResult b)
61+ crop (x, x') (y, y') = (crop x y, crop x' y')
62+
63+-- | Trivial queries have trivial results.
64+instance Query () where
65+ type QueryResult () = ()
66+ crop _ _ = ()
67+
68+-- | The result of an absurd query is trivial; If you can ask the question, the
69+-- answer cannot tell you anything you didn't already know.
70+--
71+-- 'QueryResult Void = @Void@' seems like it would also work, but that has
72+-- problems of robustness. In some applications, an unasked question can still
73+-- be answered, so it is important that the result is inhabited even when the
74+-- question isn't. Applications that wish to prevent this can mandate that the
75+-- query result be paired with the query: then the whole response will be
76+-- uninhabited as desired.
77+instance Query Void where
78+ type QueryResult Void = ()
79+ crop = absurd
80+
81+#if MIN_VERSION_base(4,12,0)
82+-- | We can lift queries into monoidal containers.
83+-- But beware of Applicatives whose monoid is different from (pure mempty, liftA2 mappend)
84+instance (Query q, Applicative f) => Query (Ap f q) where
85+ type QueryResult (Ap f q) = Ap f (QueryResult q)
86+ crop = liftA2 crop
87+#endif
88+
89+-- | QueryMorphism's must be group homomorphisms when acting on the query type
90+-- and compatible with the query relationship when acting on the query result.
3591data QueryMorphism q q' = QueryMorphism
3692 { _queryMorphism_mapQuery :: q -> q'
3793 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
3894 }
3995
40−-- | This type keeps track of the multiplicity of elements of the view selector that are being used by the app
96+instance Category QueryMorphism where
97+ id = QueryMorphism id id
98+ qm . qm' = QueryMorphism
99+ { _queryMorphism_mapQuery = mapQuery qm . mapQuery qm'
100+ , _queryMorphism_mapQueryResult = mapQueryResult qm' . mapQueryResult qm
101+ }
102+
103+-- | Apply a 'QueryMorphism' to a 'Query'
104+mapQuery :: QueryMorphism q q' -> q -> q'
105+mapQuery = _queryMorphism_mapQuery
106+
107+-- | Map a 'QueryMorphism' to a 'QueryResult'
108+mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
109+mapQueryResult = _queryMorphism_mapQueryResult
110+
111+-- | This type can be used to track of the frequency of interest in a given 'Query'. See note on
112+-- 'combineSelectedCounts'
41113newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
42114 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
43115
@@ -53,25 +125,34 @@ instance Group SelectedCount where
53125
54126instance Additive SelectedCount
55127
56−-- | The Semigroup/Monoid/Group instances for a ViewSelector should use this function which returns Nothing if the result is 0. This allows the pruning of leaves that are no longer wanted.
128+-- | The Semigroup\/Monoid\/Group instances for a Query containing 'SelectedCount's should use
129+-- this function which returns Nothing if the result is 0. This allows the pruning of leaves
130+-- of the 'Query' that are no longer wanted.
57131combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
58132combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
59133
60−class (Group q, Additive q, Query q) => MonadQuery t q m | m -> q t where
134+-- | A class that allows sending of 'Query's and retrieval of 'QueryResult's. See 'queryDyn' for a commonly
135+-- used interface.
136+class (Group q, Additive q, Query q, Monad m) => MonadQuery t q m | m -> q t where
61137 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
62138 askQueryResult :: m (Dynamic t (QueryResult q))
63139 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
64140
65−instance (Monad m, MonadQuery t q m) => MonadQuery t q (ReaderT r m) where
141+instance MonadQuery t q m => MonadQuery t q (ReaderT r m) where
66142 tellQueryIncremental = lift . tellQueryIncremental
67143 askQueryResult = lift askQueryResult
68144 queryIncremental = lift . queryIncremental
69145
146+-- | Produce and send an 'Incremental' 'Query' from a 'Dynamic' 'Query'.
70147tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
71148tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
72149
73−queryDyn :: (Reflex t, Monad m, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
150+-- | Retrieve 'Dynamic'ally updating 'QueryResult's for a 'Dynamic'ally updating 'Query'.
151+queryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
74152queryDyn q = do
75153 tellQueryDyn q
76− r <- askQueryResult
77− return $ zipDynWith crop q r
154+ zipDynWith crop q <$> askQueryResult
155+
156+-- | Use a query morphism to operate on a smaller version of a query.
157+subQuery :: (Reflex t, MonadQuery t q2 m) => QueryMorphism q1 q2 -> Dynamic t q1 -> m (Dynamic t (QueryResult q1))
158+subQuery (QueryMorphism f g) x = fmap g <$> queryDyn (fmap f x)
src/Reflex/Requester/Base.hs+202−24
@@ -1,7 +1,7 @@
11-- | This module provides 'RequesterT', the standard implementation of
22-- 'Requester'.
33{-# LANGUAGE AllowAmbiguousTypes #-}
4−{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE ApplicativeDo #-}
55{-# LANGUAGE CPP #-}
66{-# LANGUAGE EmptyDataDecls #-}
77{-# LANGUAGE ExistentialQuantification #-}
@@ -22,17 +22,25 @@
2222module Reflex.Requester.Base
2323 ( RequesterT (..)
2424 , runRequesterT
25+ , withRequesterT
2526 , runWithReplaceRequesterTWith
2627 , traverseIntMapWithKeyWithAdjustRequesterTWith
2728 , traverseDMapWithKeyWithAdjustRequesterTWith
2829 , RequesterData
2930 , RequesterDataKey
3031 , traverseRequesterData
32+ , forRequesterData
3133 , requesterDataToList
3234 , singletonRequesterData
35+ , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
37+ , multiEntry
38+ , unMultiEntry
39+ , requesting'
3340 ) where
3441
3542import Reflex.Class
43+import Reflex.Adjustable.Class
3644import Reflex.Dynamic
3745import Reflex.Host.Class
3846import Reflex.PerformEvent.Class
@@ -43,14 +51,17 @@ import Reflex.TriggerEvent.Class
4351import Control.Applicative (liftA2)
4452import Control.Monad.Exception
4553import Control.Monad.Identity
54+import Control.Monad.Morph
55+import Control.Monad.Primitive
4656import Control.Monad.Reader
4757import Control.Monad.Ref
4858import Control.Monad.State.Strict
4959import Data.Bits
5060import Data.Coerce
51−import Data.Dependent.Map (DMap, DSum (..))
61+import Data.Constraint
62+import Data.Dependent.Map (DMap)
5263import qualified Data.Dependent.Map as DMap
53−import qualified Data.Some as Some
64+import Data.Dependent.Sum (DSum (..))
5465import Data.Functor.Compose
5566import Data.Functor.Misc
5667import Data.IntMap.Strict (IntMap)
@@ -58,11 +69,11 @@ import qualified Data.IntMap.Strict as IntMap
5869import Data.Map (Map)
5970import qualified Data.Map as Map
6071import Data.Monoid ((<>))
61−import Data.Unique.Tag
72+import Data.Proxy
6273import qualified Data.Semigroup as S
63−import Data.Some (Some)
74+import Data.Some (Some(Some))
6475import Data.Type.Equality
65−import Data.Proxy
76+import Data.Unique.Tag
6677
6778import GHC.Exts (Any)
6879import Unsafe.Coerce
@@ -73,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
7384
7485newtype RequesterData f = RequesterData (TagMap (Entry f))
7586
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
7690data RequesterDataKey a where
7791 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
7892 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
8094 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
8195
8296singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
8397singletonRequesterData rdk v = case rdk of
8498 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
8599 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+ }
87104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
88105
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+
89132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
90133requesterDataToList (RequesterData m) = do
91134 k :=> Entry e <- tagMapToList m
@@ -95,11 +138,12 @@ requesterDataToList (RequesterData m) = do
95138 (k', e') <- IntMap.toList e
96139 k'' :=> e'' <- requesterDataToList e'
97140 return $ RequesterDataKey_Multi k k' k'' :=> e''
98− MyTagType_Multi2 -> do
99− (k', e') <- Map.toList e
100− (k'', e'') <- IntMap.toList e'
101− k''' :=> e''' <- requesterDataToList e''
102− return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
141+ MyTagType_Multi2 -> case _multi2Contents_dict e of
142+ Dict -> do
143+ (k', e') <- Map.toList $ _multi2Contents_values e
144+ (k'', e'') <- IntMap.toList e'
145+ k''' :=> e''' <- requesterDataToList e''
146+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
103147 MyTagType_Multi3 -> do
104148 (k', e') <- IntMap.toList e
105149 (k'', e'') <- IntMap.toList e'
@@ -110,9 +154,9 @@ singletonTagMap :: forall f a. MyTag a -> f a -> TagMap f
110154singletonTagMap (MyTag k) v = TagMap $ IntMap.singleton k $ (unsafeCoerce :: f a -> Any) v
111155
112156tagMapToList :: forall f. TagMap f -> [DSum MyTag f]
113−tagMapToList (TagMap m) = fmap f $ IntMap.toList m
157+tagMapToList (TagMap m) = f <$> IntMap.toList m
114158 where f :: (Int, Any) -> DSum MyTag f
115− f (k, v) = MyTag k :=> ((unsafeCoerce :: Any -> f a) v)
159+ f (k, v) = MyTag k :=> (unsafeCoerce :: Any -> f a) v
116160
117161traverseTagMapWithKey :: forall t f g. Applicative t => (forall a. MyTag a -> f a -> t (g a)) -> TagMap f -> t (TagMap g)
118162traverseTagMapWithKey f (TagMap m) = TagMap <$> IntMap.traverseWithKey g m
@@ -127,9 +171,19 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
127171 go k (Entry request) = Entry <$> case myKeyType k of
128172 MyTagType_Single -> f request
129173 MyTagType_Multi -> traverse (traverseRequesterData f) request
130− MyTagType_Multi2 -> traverse (traverse (traverseRequesterData f)) request
174+ MyTagType_Multi2 -> case request of
175+ Multi2Contents { _multi2Contents_values = request', _multi2Contents_dict = Dict } -> do
176+ v <- traverse (traverse (traverseRequesterData f)) request'
177+ pure $ Multi2Contents
178+ { _multi2Contents_values = v
179+ , _multi2Contents_dict = Dict
180+ }
131181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
132182
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+
133187data MyTagType :: * -> * where
134188 MyTagType_Single :: MyTagType (Single a)
135189 MyTagType_Multi :: MyTagType Multi
@@ -167,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
167221type family EntryContents request a where
168222 EntryContents request (Single a) = request a
169223 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
171225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
172226
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+
173232newtype Entry request x = Entry { unEntry :: EntryContents request x }
174233
175234{-# INLINE singleEntry #-}
@@ -239,6 +298,10 @@ deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
239298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
240299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
241300
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+
242305-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
243306instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
244307 mempty = pure mempty
@@ -252,7 +315,6 @@ instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response
252315-- requests are made, and responses should be provided in the input 'Event'.
253316-- The 'Tag' keys will be used to return the responses to the same place the
254317-- requests were issued.
255−
256318runRequesterT :: (Reflex t, Monad m)
257319 => RequesterT t request response m a
258320 -> 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
262324 coerceEvent responses
263325 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
264326
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+
265341instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
266342 type Request (RequesterT t request response m) = request
267343 type Response (RequesterT t request response m) = response
@@ -281,7 +357,7 @@ tagRequest req = do
281357 return t
282358
283359{-# INLINE responseFromTag #-}
284−responseFromTag :: (Monad m, Reflex t) => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
360+responseFromTag :: forall m t request response x. Monad m => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
285361responseFromTag (MyTagWrap t) = do
286362 responses :: EventSelectorInt t Any <- RequesterT ask
287363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -289,6 +365,9 @@ responseFromTag (MyTagWrap t) = do
289365instance MonadTrans (RequesterT t request response) where
290366 lift = RequesterT . lift . lift
291367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
292371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
293372 type Performable (RequesterT t request response m) = Performable m
294373 performEvent_ = lift . performEvent_
@@ -316,7 +395,7 @@ instance (Reflex t, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (
316395 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
317396 traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
318397
319−requesting' :: (MyTagTypeOffset x, Monad m, Reflex t) => Event t (Entry request x) -> RequesterT t request response m (Event t (Entry response x))
398+requesting' :: (MyTagTypeOffset x, Monad m) => Event t (Entry request x) -> RequesterT t request response m (Event t (Entry response x))
320399requesting' = responseFromTag . castMyTagWrap <=< tagRequest
321400
322401{-# INLINABLE runWithReplaceRequesterTWith #-}
@@ -365,7 +444,7 @@ traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIn
365444 pack = Entry
366445 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
367446 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?
369448 return (fmapCheap (IntMap.singleton n) myRequests, result)
370449 ndm' <- numberOccurrencesFrom 1 dm'
371450 (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
408487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
409488 responses = fanMap $ fmapCheap unpack response
410489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
411− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
412491 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 }
414493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
415494 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))
417496 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
418497 ndm' <- numberOccurrencesFrom 1 dm'
419498 (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
427506 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
428507 requests <- holdIncremental requests0 requests'
429508 return (result0, result')
509+
510+data Decoder rawResponse response =
511+ forall a. Decoder (RequesterDataKey a) (rawResponse -> response a)
512+
513+matchResponsesWithRequests
514+ :: forall t rawRequest rawResponse request response m.
515+ ( MonadFix m
516+ , MonadHold t m
517+ , Reflex t
518+ )
519+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
520+ -- ^ Given a request (from 'Requester'), produces the wire format of the
521+ -- request and a function used to process the associated response
522+ -> Event t (RequesterData request)
523+ -- ^ The outgoing requests
524+ -> Event t (Int, rawResponse)
525+ -- ^ The incoming responses, tagged by an identifying key
526+ -> m ( Event t (Map Int rawRequest)
527+ , Event t (RequesterData response)
528+ )
529+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
530+ -- by the 'RequesterData' key of the associated outgoing request
531+matchResponsesWithRequests f send recv = matchResponseMapWithRequests f send $ uncurry Map.singleton <$> recv
532+
533+-- | Matches incoming responses with previously-sent requests
534+-- and uses the provided request "decoder" function to process
535+-- incoming responses.
536+matchResponseMapWithRequests
537+ :: forall t rawRequest rawResponse request response m.
538+ ( MonadFix m
539+ , MonadHold t m
540+ , Reflex t
541+ )
542+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
543+ -- ^ Given a request (from 'Requester'), produces the wire format of the
544+ -- request and a function used to process the associated response
545+ -> Event t (RequesterData request)
546+ -- ^ The outgoing requests
547+ -> Event t (Map Int rawResponse)
548+ -- ^ A map of incoming responses, tagged by an identifying key
549+ -> m ( Event t (Map Int rawRequest)
550+ , Event t (RequesterData response)
551+ )
552+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
553+ -- by the 'RequesterData' key of the associated outgoing request
554+matchResponseMapWithRequests f send recv = do
555+ rec nextId <- hold 1 $ fmap (\(next, _, _) -> next) outgoing
556+ waitingFor :: Incremental t (PatchMap Int (Decoder rawResponse response)) <-
557+ holdIncremental mempty $ leftmost
558+ [ fmap (\(_, outstanding, _) -> outstanding) outgoing
559+ , snd <$> incoming
560+ ]
561+ let outgoing = processOutgoing nextId send
562+ incoming = processIncoming waitingFor recv
563+ return (fmap (\(_, _, rawReqs) -> rawReqs) outgoing, fst <$> incoming)
564+ where
565+ -- Tags each outgoing request with an identifying integer key
566+ -- and returns the next available key, a map of response decoders
567+ -- for requests for which there are outstanding responses, and the
568+ -- raw requests to be sent out.
569+ processOutgoing
570+ :: Behavior t Int
571+ -- The next available key
572+ -> Event t (RequesterData request)
573+ -- The outgoing request
574+ -> Event t ( Int
575+ , PatchMap Int (Decoder rawResponse response)
576+ , Map Int rawRequest )
577+ -- The new next-available-key, a map of requests expecting responses, and the tagged raw requests
578+ processOutgoing nextId out = flip pushAlways out $ \dm -> do
579+ oldNextId <- sample nextId
580+ let (result, newNextId) = flip runState oldNextId $ forM (requesterDataToList dm) $ \(k :=> v) -> do
581+ n <- get
582+ put $ succ n
583+ let (rawReq, rspF) = f v
584+ return (n, rawReq, Decoder k rspF)
585+ patchWaitingFor = PatchMap $ Map.fromList $
586+ (\(n, _, dec) -> (n, Just dec)) <$> result
587+ toSend = Map.fromList $ (\(n, rawReq, _) -> (n, rawReq)) <$> result
588+ return (newNextId, patchWaitingFor, toSend)
589+ -- Looks up the each incoming raw response in a map of response
590+ -- decoders and returns the decoded response and a patch that can
591+ -- be used to clear the ID of the consumed response out of the queue
592+ -- of expected responses.
593+ processIncoming
594+ :: Incremental t (PatchMap Int (Decoder rawResponse response))
595+ -- A map of outstanding expected responses
596+ -> Event t (Map Int rawResponse)
597+ -- A incoming response paired with its identifying key
598+ -> Event t (RequesterData response, PatchMap Int v)
599+ -- The decoded response and a patch that clears the outstanding responses queue
600+ processIncoming waitingFor inc = flip push inc $ \rspMap -> do
601+ wf <- sample $ currentIncremental waitingFor
602+ let match rawRsp (Decoder k rspF) =
603+ let rsp = rspF rawRsp
604+ in singletonRequesterData k rsp
605+ matches = Map.intersectionWith match rspMap wf
606+ pure $ if Map.null matches then Nothing else Just
607+ (Map.foldl' mergeRequesterData emptyRequesterData matches, PatchMap $ Nothing <$ matches)
src/Reflex/Requester/Class.hs−1
@@ -6,7 +6,6 @@
66{-# LANGUAGE CPP #-}
77{-# LANGUAGE FlexibleInstances #-}
88{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
109{-# LANGUAGE RecursiveDo #-}
1110{-# LANGUAGE TypeFamilies #-}
1211{-# LANGUAGE UndecidableInstances #-}
src/Reflex/Spider.hs+5−7
@@ -1,22 +1,20 @@
11{-# LANGUAGE CPP #-}
2−-- | This module exports all of the user-facing functionality of the 'Spider'
3−-- 'Reflex' engine
2+-- |
3+-- Module:
4+-- Reflex.Spider
5+-- Description:
6+-- This module exports all of the user-facing functionality of the 'Spider' 'Reflex' engine
47module Reflex.Spider
58 ( Spider
69 , SpiderTimeline
710 , Global
811 , SpiderHost
912 , runSpiderHost
10−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
1113 , runSpiderHostForTimeline
1214 , newSpiderTimeline
1315 , withSpiderTimeline
14−#endif
1516 -- * Deprecated
1617 , SpiderEnv
1718 ) where
1819
19−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
20−import Reflex.Class
21−#endif
2220import Reflex.Spider.Internal
src/Reflex/Spider/Internal.hs+972−507
@@ -9,40 +9,49 @@
99{-# LANGUAGE GADTs #-}
1010{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1111{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
1512{-# LANGUAGE RankNTypes #-}
1613{-# LANGUAGE RoleAnnotations #-}
1714{-# LANGUAGE ScopedTypeVariables #-}
1815{-# LANGUAGE TypeFamilies #-}
1916{-# LANGUAGE TypeOperators #-}
2017{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
2124#ifdef USE_REFLEX_OPTIMIZER
2225{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
2326#endif
24−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
25−{-# OPTIONS_GHC -fno-warn-orphans #-}
26−#endif
27+{-# OPTIONS_GHC -Wunused-binds #-}
2728-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
2829-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
2930module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
3031
31−import Control.Applicative
32+#if MIN_VERSION_base(4,10,0)
33+import Control.Applicative (liftA2)
34+#endif
3235import Control.Concurrent
3336import Control.Exception
34−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
37+import Control.Monad hiding (forM, forM_, mapM, mapM_)
3538import Control.Monad.Exception
36−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
39+import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
3740import Control.Monad.Primitive
38−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
41+import Control.Monad.Reader.Class
42+import Control.Monad.IO.Class
43+import Control.Monad.ReaderIO
3944import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
4047import Data.Align
4148import Data.Coerce
42−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
4350import qualified Data.Dependent.Map as DMap
51+import Data.Dependent.Sum (DSum (..))
52+import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
53+import qualified Data.FastMutableIntMap as FastMutableIntMap
4454import Data.Foldable hiding (concat, elem, sequence_)
45−import Data.Function
4655import Data.Functor.Constant
4756import Data.Functor.Misc
4857import Data.Functor.Product
@@ -50,63 +59,73 @@ import Data.GADT.Compare
5059import Data.IntMap.Strict (IntMap)
5160import qualified Data.IntMap.Strict as IntMap
5261import Data.IORef
53−import Data.List hiding (foldl')
54−import Data.Maybe
55−import Data.Monoid ((<>))
62+import Data.Kind (Type)
63+import Data.Maybe hiding (mapMaybe)
64+import Data.Monoid (mempty, (<>))
5665import Data.Proxy
5766import Data.These
5867import Data.Traversable
59−import Data.Word
60−import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
61−import qualified Data.FastMutableIntMap as FastMutableIntMap
62−import GHC.Exts
68+import Data.Type.Equality ((:~:)(Refl))
69+import Data.Witherable (Filterable, mapMaybe)
70+import GHC.Exts hiding (toList)
6371import GHC.IORef (IORef (..))
6472import GHC.Stack
6573import Reflex.FastWeak
66−import Reflex.FunctorMaybe
6774import System.IO.Unsafe
6875import System.Mem.Weak
6976import Unsafe.Coerce
7077
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+
7187#ifdef DEBUG_CYCLES
7288import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
7391import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
7492import qualified Data.List.NonEmpty as NonEmpty
75−import Data.Monoid (mempty)
7693import Data.Tree (Forest, Tree (..), drawForest)
77−#endif
94+import Data.List (isPrefixOf)
7895
79−import Data.FastWeakBag (FastWeakBag)
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
8097import qualified Data.FastWeakBag as FastWeakBag
81−import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
82−import qualified Data.WeakBag as WeakBag
83−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
98+
8499import Data.Reflection
85−import Data.Some (Some)
86−import qualified Data.Some as Some
100+import Data.Some (Some(Some))
87101import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
103+import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
104+import qualified Data.WeakBag as WeakBag
88105import qualified Reflex.Class
89106import qualified Reflex.Class as R
90107import qualified Reflex.Host.Class
91−#endif
92108import Reflex.NotReady.Class
93−import Reflex.Patch
94−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
95−
96−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
97−import Prelude hiding (any, concat, mapM, mapM_, sequence)
109+import Data.Patch
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111+import Reflex.PerformEvent.Base (PerformEventT)
98112
99113#ifdef DEBUG_TRACE_EVENTS
100−import System.IO (stderr)
101114import qualified Data.ByteString.Char8 as BS8
115+import System.IO (stderr)
116+import Data.List (isPrefixOf)
102117#endif
103118
104−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
105122
123+#ifdef DEBUG_TRACE_EVENTS
106124withStackOneLine :: (BS8.ByteString -> a) -> a
107125withStackOneLine expr = unsafePerformIO $ do
108126 stack <- currentCallStack
109− return (expr (BS8.pack (unwords (reverse stack))))
127+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128+ where dropInternal = filterStack "Reflex.Spider.Internal"
110129
111130#endif
112131
@@ -117,28 +136,42 @@ debugInvalidateHeight :: Bool
117136debugInvalidate :: Bool
118137
119138#ifdef DEBUG
120−
121139#define DEBUG_NODEIDS
122140
141+#ifdef DEBUG_TRACE_PROPAGATION
123142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
124146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
125150debugInvalidateHeight = False
151+#endif
126152
153+#ifdef DEBUG_TRACE_INVALIDATION
127154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
128158
129159class HasNodeId a where
130160 getNodeId :: a -> Int
131161
132−instance HasNodeId (Hold x p a) where
133− getNodeId = holdNodeId
162+instance HasNodeId (CacheSubscribed x a) where
163+ getNodeId = _cacheSubscribed_nodeId
134164
135−instance HasNodeId (PushSubscribed x a b) where
136− getNodeId = pushSubscribedNodeId
165+instance HasNodeId (FanInt x a) where
166+ getNodeId = _fanInt_nodeId
167+
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
137170
138171instance HasNodeId (SwitchSubscribed x a) where
139172 getNodeId = switchSubscribedNodeId
140173
141−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
142175 getNodeId = fanSubscribedNodeId
143176
144177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -152,41 +185,16 @@ instance HasNodeId (Pull x a) where
152185
153186{-# INLINE showNodeId #-}
154187showNodeId :: HasNodeId a => a -> String
155−showNodeId = ("#"<>) . show . getNodeId
156−
157−showSubscriberType :: Subscriber x a -> String
158−showSubscriberType = \case
159− SubscriberPush _ _ -> "SubscriberPush"
160− SubscriberMerge _ _ -> "SubscriberMerge"
161− SubscriberFan _ -> "SubscriberFan"
162− SubscriberMergeChange _ -> "SubscriberMergeChange"
163− SubscriberHold _ -> "SubscriberHold"
164− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
165− SubscriberSwitch _ -> "SubscriberSwitch"
166− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
167− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
168− SubscriberHandle -> "SubscriberHandle"
169−
170−showEventType :: Event x a -> String
171−showEventType = \case
172− EventRoot _ _ -> "EventRoot"
173− EventNever -> "EventNever"
174− EventPush _ -> "EventPush"
175− EventMerge _ -> "EventMerge"
176− EventFan _ _ -> "EventFan"
177− EventSwitch _ -> "EventSwitch"
178− EventCoincidence _ -> "EventCoincidence"
179− EventHold _ -> "EventHold"
180− EventDyn _ -> "EventDyn"
181− EventHoldIdentity _ -> "EventHoldIdentity"
182− EventDynIdentity _ -> "EventDynIdentity"
188+showNodeId = showNodeId' . getNodeId
189+
190+showNodeId' :: Int -> String
191+showNodeId' = ("#"<>) . show
192+
183193
184194#else
185195
186196debugPropagate = False
187−
188197debugInvalidateHeight = False
189−
190198debugInvalidate = False
191199
192200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -194,6 +202,10 @@ debugInvalidate = False
194202showNodeId :: a -> String
195203showNodeId _ = ""
196204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
197209#endif
198210
199211#ifdef DEBUG_NODEIDS
@@ -203,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
203215
204216newNodeId :: IO Int
205217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
206−
207−{-# NOINLINE unsafeNodeId #-}
208−unsafeNodeId :: a -> Int
209−unsafeNodeId a = unsafePerformIO $ do
210− touch a
211− newNodeId
212218#endif
213219
214220--------------------------------------------------------------------------------
@@ -247,7 +253,7 @@ subscribeAndRead = unEvent
247253{-# INLINE [1] pushCheap #-}
248254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
249255pushCheap !f e = Event $ \sub -> do
250− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
251257 { subscriberPropagate = \a -> do
252258 mb <- f a
253259 mapM_ (subscriberPropagate sub) mb
@@ -266,10 +272,10 @@ terminalSubscriber p = Subscriber
266272
267273-- | Subscribe to an Event only for the duration of one occurrence
268274{-# INLINE subscribeAndReadHead #-}
269−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)
270276subscribeAndReadHead e sub = do
271277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
272− (subscription, occ) <- subscribeAndRead e $ sub
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
273279 { subscriberPropagate = \a -> do
274280 liftIO $ unsubscribe =<< readIORef subscriptionRef
275281 subscriberPropagate sub a
@@ -280,24 +286,42 @@ subscribeAndReadHead e sub = do
280286 return (subscription, occ)
281287
282288--TODO: Make this lazy in its input event
283−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)
284290headE originalE = do
285291 parent <- liftIO $ newIORef $ Just originalE
286292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
287293 let clearParent = liftIO $ writeIORef parent Nothing
288− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
289295 when (isJust occ) clearParent
290− return $ Event $ \sub -> do
296+ return $ Event $ \sub ->
291297 liftIO (readIORef parent) >>= \case
292− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
298+ Nothing -> subscribeAndReadNever
293299 Just e -> subscribeAndReadHead e sub
294300
295301data CacheSubscribed x a
296302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
297303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
298304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
299308 }
300309
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+
301325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
302326-- repeatedly
303327--
@@ -312,27 +336,33 @@ cacheEvent e =
312336#else
313337 Event $
314338#endif
315− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
316− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
317− in \sub -> {-# SCC "cacheEvent" #-} do
339+ unsafePerformIO $ do
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341+ <- newIORef emptyFastWeak
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
318343#ifdef DEBUG_TRACE_EVENTS
319344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
320345#endif
321346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
322347 Just subscribedTicket -> return subscribedTicket
323348 Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
324352 subscribers <- liftIO FastWeakBag.empty
325353 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
326357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
327− { subscriberPropagate = \a -> do
328− liftIO $ writeIORef occRef $ Just a
329− scheduleClear occRef
330− propagateFast a subscribers
331− , subscriberInvalidateHeight = \old -> do
332− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
333− , subscriberRecalculateHeight = \new -> do
334− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
335− }
358+#endif
359+ { subscriberPropagate = \a -> do
360+ liftIO $ writeIORef occRef (Just a)
361+ scheduleClear occRef
362+ propagateFast a subscribers
363+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
364+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
365+ }
336366 when (isJust occ) $ do
337367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
338368 scheduleClear occRef
@@ -340,29 +370,45 @@ cacheEvent e =
340370 { _cacheSubscribed_subscribers = subscribers
341371 , _cacheSubscribed_parent = parentSub
342372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
343376 }
344377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
345378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
346379 return subscribedTicket
347− liftIO $ do
348− subscribed <- getFastWeakTicketValue subscribedTicket
349− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
350− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
351− let es = EventSubscription
352− { _eventSubscription_unsubscribe = do
353− FastWeakBag.remove ticket
354− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
355− when isEmpty $ do
356− writeIORef mSubscribedRef emptyFastWeak
357− unsubscribe $ _cacheSubscribed_parent subscribed
358− touch ticket
359− touch subscribedTicket
360− , _eventSubscription_subscribed = EventSubscribed
361− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
362− , eventSubscribedRetained = toAny subscribedTicket
363− }
364− }
365− return (es, occ)
380+ liftIO $ cacheSubscription sub mSubscribedRef subscribedTicket
381+
382+cacheSubscription :: Subscriber x a -> IORef (FastWeak (CacheSubscribed x a))
383+ -> FastWeakTicket (CacheSubscribed x a) -> IO (EventSubscription x, Maybe a)
384+cacheSubscription sub mSubscribedRef subscribedTicket = do
385+ subscribed <- getFastWeakTicketValue subscribedTicket
386+ ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
387+ occ <- readIORef $ _cacheSubscribed_occurrence subscribed
388+
389+ let parentSub = _cacheSubscribed_parent subscribed
390+ es = EventSubscription
391+ { _eventSubscription_unsubscribe = do
392+ FastWeakBag.remove ticket
393+
394+ isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
395+ when isEmpty $ do
396+ writeIORef mSubscribedRef emptyFastWeak
397+ unsubscribe parentSub
398+ touch ticket
399+ touch subscribedTicket
400+ , _eventSubscription_subscribed = EventSubscribed
401+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
402+ , eventSubscribedRetained = toAny subscribedTicket
403+#ifdef DEBUG_CYCLES
404+ , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
405+ , eventSubscribedHasOwnHeightRef = False
406+ , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
407+#endif
408+ }
409+ }
410+ return (es, occ)
411+
366412
367413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
368414subscribe e s = fst <$> subscribeAndRead e s
@@ -374,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
374420 let es = tag subd
375421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
376422
377−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
378424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
379425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
380429eventNever :: Event x a
381−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
382431
383−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)
384433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
385434
386435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -389,7 +438,7 @@ eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
389438eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
390439eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
391440
392−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
441+eventHold :: Hold x p -> Event x p
393442eventHold !h = Event $ subscribeHoldEvent h
394443
395444eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
@@ -415,16 +464,6 @@ data Subscriber x a = Subscriber
415464 , subscriberRecalculateHeight :: !(Height -> IO ())
416465 }
417466
418−--TODO: Move this comment to WeakBag
419−-- These function are constructor functions that are marked NOINLINE so they are
420−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
421−-- so any weak references that are attached to the constructors will have their
422−-- finalizer run. Using the opaque constructor, does not see the
423−-- constructor application, so it behaves like an IORef and cannot be fused away.
424−--
425−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
426−-- the weak pointer to it in some cases.
427−
428467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
429468newSubscriberHold h = return $ Subscriber
430469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -432,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
432471 , subscriberRecalculateHeight = \_ -> return ()
433472 }
434473
435−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
436−newSubscriberFan subscribed = return $ Subscriber
474+newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
475+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
437476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
438477 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
439− 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"
440479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
441480 scheduleClear $ fanSubscribedOccurrence subscribed
442− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
443482 propagate v $ _fanSubscribedChildren_list subsubs
444483 return $ Constant ()
445484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
446485 return ()
447486 , subscriberInvalidateHeight = \old -> do
448− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
449487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
450− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
451− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
452489 , subscriberRecalculateHeight = \new -> do
453− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
454490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
455− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
456− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
457492 }
458493
459494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
460−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
461496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
462− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
463497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
464498 scheduleClear $ switchSubscribedOccurrence subscribed
465499 propagate a $ switchSubscribedSubscribers subscribed
466500 , subscriberInvalidateHeight = \_ -> do
467− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
468501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
469502 when (oldHeight /= invalidHeight) $ do
470503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
471− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
472− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
473− , subscriberRecalculateHeight = \new -> do
474− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
475− updateSwitchHeight new subscribed
476− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
477− }
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
506+ }
478507
479508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
480−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
481510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
482− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
483511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
484512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
485513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
486514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
487515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
488517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
489518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
490519 case occ of
491− Nothing -> do
520+ Nothing ->
492521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
493522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
494− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
495− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
496525 Just o -> do -- Since it's already firing, no need to adjust height
497526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
498527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
499528 propagate o $ coincidenceSubscribedSubscribers subscribed
500− , subscriberInvalidateHeight = \_ -> do
501− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
502− invalidateCoincidenceHeight subscribed
503− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
504− , subscriberRecalculateHeight = \_ -> do
505− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
506− recalculateCoincidenceHeight subscribed
507− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
529+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
508531 }
509532
510533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
511−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
512535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
513− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
514536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
515537 case occ of
516538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -518,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
518540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
519541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
520542 propagate a $ coincidenceSubscribedSubscribers subscribed
521− , subscriberInvalidateHeight = \_ -> do
522− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
523− invalidateCoincidenceHeight subscribed
524− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
525− , subscriberRecalculateHeight = \_ -> do
526− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
527− recalculateCoincidenceHeight subscribed
528− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
543+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
529545 }
530546
531547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -535,18 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
535551recalculateSubscriberHeight = flip subscriberRecalculateHeight
536552
537553-- | Propagate everything at the current height
538−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
539−propagate a subscribers = withIncreasedDepth $ do
554+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
555+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
540556 -- 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
541557 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
542− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
543559
544560-- | Propagate everything at the current height
545−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
546−propagateFast a subscribers = withIncreasedDepth $ do
561+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
562+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
547563 -- 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
548564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
549− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
550566
551567--------------------------------------------------------------------------------
552568-- EventSubscribed
@@ -555,11 +571,16 @@ propagateFast a subscribers = withIncreasedDepth $ do
555571toAny :: a -> Any
556572toAny = unsafeCoerce
557573
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.
558579data EventSubscribed x = EventSubscribed
559580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
560581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
561582#ifdef DEBUG_CYCLES
562− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
563584 , eventSubscribedHasOwnHeightRef :: !Bool
564585 , eventSubscribedWhoCreated :: !(IO [String])
565586#endif
@@ -586,13 +607,23 @@ eventSubscribedNever = EventSubscribed
586607 , eventSubscribedWhoCreated = return ["never"]
587608#endif
588609 }
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+ }
589620
590−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
591622eventSubscribedFan !subscribed = EventSubscribed
592623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
593624 , eventSubscribedRetained = toAny subscribed
594625#ifdef DEBUG_CYCLES
595− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
596627 , eventSubscribedHasOwnHeightRef = False
597628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
598629#endif
@@ -605,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
605636#ifdef DEBUG_CYCLES
606637 , eventSubscribedGetParents = do
607638 s <- readIORef $ switchSubscribedCurrentParent subscribed
608− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
609640 , eventSubscribedHasOwnHeightRef = True
610641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
611642#endif
@@ -618,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
618649#ifdef DEBUG_CYCLES
619650 , eventSubscribedGetParents = do
620651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
621− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
622− innerParents = maybeToList $ fmap Some.This innerSubscription
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
653+ innerParents = maybeToList $ innerSubscription
623654 return $ outerParent : innerParents
624655 , eventSubscribedHasOwnHeightRef = True
625656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -633,20 +664,20 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
633664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
634665whoCreatedEventSubscribed = eventSubscribedWhoCreated
635666
636−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
637668walkInvalidHeightParents s0 = do
638− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
669+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
639670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
640671 when (h == invalidHeight) $ do
641672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
642− modify (Some.This s :)
673+ modify (s :)
643674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
644− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
645676 return subscribers
646677#endif
647678
648679{-# INLINE subscribeHoldEvent #-}
649−subscribeHoldEvent :: HasSpiderTimeline x => Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
680+subscribeHoldEvent :: Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
650681subscribeHoldEvent = subscribeAndRead . holdEvent
651682
652683--------------------------------------------------------------------------------
@@ -669,7 +700,7 @@ behaviorPull !p = Behavior $ do
669700 val <- liftIO $ readIORef $ pullValue p
670701 case val of
671702 Just subscribed -> do
672− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
673704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
674705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
675706 return $ pullSubscribedValue subscribed
@@ -678,7 +709,7 @@ behaviorPull !p = Behavior $ do
678709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
679710 parentsRef <- liftIO $ newIORef []
680711 holdInits <- askBehaviorHoldInits
681− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
682713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
683714 parents <- liftIO $ readIORef parentsRef
684715 let subscribed = PullSubscribed
@@ -688,7 +719,7 @@ behaviorPull !p = Behavior $ do
688719 , pullSubscribedParents = parents
689720 }
690721 liftIO $ writeIORef (pullValue p) $ Just subscribed
691− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
722+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
692723 return a
693724
694725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -699,7 +730,7 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
699730readHoldTracked h = do
700731 result <- liftIO $ readIORef $ holdValue h
701732 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
702− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
733+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
703734 liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
704735 return result
705736
@@ -713,42 +744,46 @@ readBehaviorUntracked b = do
713744-- Dynamic
714745--------------------------------------------------------------------------------
715746
716−data Dynamic x p = Dynamic
717− { dynamicCurrent :: !(Behavior x (PatchTarget p))
718− , dynamicUpdated :: !(Event x p)
747+type DynamicS x p = Dynamic x (PatchTarget p) p
748+
749+data Dynamic x target p = Dynamic
750+ { dynamicCurrent :: !(Behavior x target)
751+ , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
719752 }
720753
721−dynamicHold :: HasSpiderTimeline x => Hold x p -> Dynamic x p
754+deriving instance (HasSpiderTimeline x) => Functor (Dynamic x target)
755+
756+
757+
758+
759+dynamicHold :: Hold x p -> DynamicS x p
722760dynamicHold !h = Dynamic
723761 { dynamicCurrent = behaviorHold h
724762 , dynamicUpdated = eventHold h
725763 }
726764
727−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
728766dynamicHoldIdentity = dynamicHold
729767
730−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
731769dynamicConst !a = Dynamic
732770 { dynamicCurrent = behaviorConst a
733771 , dynamicUpdated = eventNever
734772 }
735773
736−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
737775dynamicDyn !d = Dynamic
738776 { dynamicCurrent = behaviorDyn d
739777 , dynamicUpdated = eventDyn d
740778 }
741779
742−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
743781dynamicDynIdentity = dynamicDyn
744782
745783--------------------------------------------------------------------------------
746784-- Combinators
747785--------------------------------------------------------------------------------
748786
749−--TODO: Figure out why certain things are not 'representational', then make them
750−--representational so we can use coerce
751−
752787--type role Hold representational
753788data Hold x p
754789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -760,9 +795,7 @@ data Hold x p
760795#endif
761796 }
762797
763−-- | A statically allocated 'SpiderTimeline'; this is the only instance of
764−-- 'SpiderTimeline' that can used when using
765−-- -fspecialize-to-spidertimeline-global.
798+-- | A statically allocated 'SpiderTimeline'
766799data Global
767800
768801{-# NOINLINE globalSpiderTimelineEnv #-}
@@ -771,30 +804,27 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
771804
772805-- | Stores all global data relevant to a particular Spider timeline; only one
773806-- value should exist for each type @x@
774−data SpiderTimelineEnv x = SpiderTimelineEnv
807+newtype SpiderTimelineEnv x = STE {unSTE :: SpiderTimelineEnv' x}
808+-- We implement SpiderTimelineEnv with a newtype wrapper so
809+-- we can get the coercions we want safely.
810+type role SpiderTimelineEnv nominal
811+
812+data SpiderTimelineEnv' x = SpiderTimelineEnv
775813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
776814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
777815#ifdef DEBUG
778816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
779817#endif
780818 }
781−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
782820
783821instance Eq (SpiderTimelineEnv x) where
784822 _ == _ = True -- Since only one exists of each type
785823
786824instance GEq SpiderTimelineEnv where
787−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
788− geqToEq _ = id
789− geqUnify (a :: SpiderTimelineEnv a) (b :: SpiderTimelineEnv b) different same = if _spiderTimeline_lock a == _spiderTimeline_lock b
790− then case unsafeCoerce Refl :: a :~: b of
791− Refl -> same -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
792− else different
793−#else
794− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
825+ a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
795826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
796827 else Nothing
797−#endif
798828
799829data EventEnv x
800830 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
@@ -802,9 +832,9 @@ data EventEnv x
802832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
803833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
804834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
805− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
806− , eventEnvIntClears :: !(IORef [SomeIntClear])
807− , eventEnvRootClears :: !(IORef [SomeRootClear])
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
808838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
809839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
810840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -815,7 +845,7 @@ runEventM :: EventM x a -> IO a
815845runEventM = unEventM
816846
817847asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
818−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
848+asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
819849
820850class MonadIO m => Defer a m where
821851 getDeferralQueue :: m (IORef [a])
@@ -864,11 +894,7 @@ instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
864894 delayedRef <- asksEventEnv eventEnvDelayedMerges
865895 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
866896
867−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
868−class x ~ Global => HasSpiderTimeline x where
869−#else
870897class HasSpiderTimeline x where
871−#endif
872898 -- | Retrieve the current SpiderTimelineEnv
873899 spiderTimeline :: SpiderTimelineEnv x
874900
@@ -880,29 +906,29 @@ putCurrentHeight h = do
880906 heightRef <- asksEventEnv eventEnvCurrentHeight
881907 liftIO $ writeIORef heightRef $! h
882908
883−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
884910 {-# INLINE getDeferralQueue #-}
885911 getDeferralQueue = asksEventEnv eventEnvClears
886912
887913{-# INLINE scheduleClear #-}
888−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
889−scheduleClear r = defer $ SomeClear r
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
915+scheduleClear r = defer $ Some $ Clear r
890916
891−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
892918 {-# INLINE getDeferralQueue #-}
893919 getDeferralQueue = asksEventEnv eventEnvIntClears
894920
895921{-# INLINE scheduleIntClear #-}
896−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
897−scheduleIntClear r = defer $ SomeIntClear r
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923+scheduleIntClear r = defer $ Some $ IntClear r
898924
899−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
900926 {-# INLINE getDeferralQueue #-}
901927 getDeferralQueue = asksEventEnv eventEnvRootClears
902928
903929{-# INLINE scheduleRootClear #-}
904−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
905−scheduleRootClear r = defer $ SomeRootClear r
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
931+scheduleRootClear r = defer $ Some $ RootClear r
906932
907933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
908934 {-# INLINE getDeferralQueue #-}
@@ -957,9 +983,9 @@ getHoldEventSubscription h = do
957983
958984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
959985
960−--type role BehaviorM representational
961986-- BehaviorM can sample behaviors
962−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))
963989
964990instance Monad (BehaviorM x) where
965991 {-# INLINE (>>=) #-}
@@ -968,14 +994,16 @@ instance Monad (BehaviorM x) where
968994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
969995 {-# INLINE return #-}
970996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
971998 {-# INLINE fail #-}
972999 fail s = BehaviorM $ fail s
1000+#endif
9731001
9741002data BehaviorSubscribed x a
9751003 = forall p. BehaviorSubscribedHold (Hold x p)
9761004 | BehaviorSubscribedPull (PullSubscribed x a)
9771005
978−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
9791007
9801008--type role PullSubscribed representational
9811009data PullSubscribed x a
@@ -1010,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
10101038#endif
10111039 }
10121040
1013−data Root x (k :: * -> *)
1041+data Root x k
10141042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
10151043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
10161044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -1029,7 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
10291057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
10301058
10311059-- EventM can do everything BehaviorM can, plus create holds
1032−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)
10331061
10341062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
10351063
@@ -1054,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
10541082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
10551083
10561084heightBagAdd :: Height -> HeightBag -> HeightBag
1057−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
10581087
10591088heightBagRemove :: Height -> HeightBag -> HeightBag
10601089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1063,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
10631092 0 -> IntMap.delete h c
10641093 _ -> IntMap.insert h (pred old) c
10651094
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+
10661102heightBagMax :: HeightBag -> Height
10671103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
10681104 Just ((h, _), _) -> Height h
@@ -1080,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
10801116heightBagVerify = id
10811117#endif
10821118
1083−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1084− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1085− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1086− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
1119+data FanSubscribedChildren x k v a = FanSubscribedChildren
1120+ { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1121+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1122+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
10871123 }
10881124
1089−data FanSubscribed (x :: *) k
1090− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1091− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1092− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
1125+data FanSubscribed x k v
1126+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1127+ , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1128+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
10931129 , fanSubscribedParent :: !(EventSubscription x)
10941130#ifdef DEBUG_NODEIDS
10951131 , fanSubscribedNodeId :: Int
10961132#endif
10971133 }
10981134
1099−data Fan x k
1100− = Fan { fanParent :: !(Event x (DMap k Identity))
1101− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1135+data Fan x k v
1136+ = Fan { fanParent :: !(Event x (DMap k v))
1137+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
11021138 }
11031139
11041140data SwitchSubscribed x a
@@ -1152,20 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
11521188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
11531189newInvalidatorPull p = return $! InvalidatorPull p
11541190
1155−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1156− fmapMaybe f = push $ return . f
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1192+ mapMaybe f = push $ return . f
11571193
11581194instance HasSpiderTimeline x => Align (Event x) where
11591195 nil = eventNever
1160− align ea eb = fmapMaybe dmapToThese $ merge $ dynamicConst $ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1196+#if MIN_VERSION_these(0, 8, 0)
1197+instance HasSpiderTimeline x => Semialign (Event x) where
1198+#endif
1199+ align ea eb = mapMaybe dmapToThese $ mergeG coerce $ dynamicConst $
1200+ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1201+
1202+#ifdef MIN_VERSION_semialign
1203+#if MIN_VERSION_semialign(1,1,0)
1204+instance HasSpiderTimeline x => Zip (Event x) where
1205+#endif
1206+ zip x y = mapMaybe justThese $ align x y
1207+#endif
1208+
1209+data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
1210+ | BuildDyn !(EventM x (PatchTarget p), Event x p)
1211+ | HoldDyn !(Hold x p)
11611212
1162−newtype Dyn x p = Dyn { unDyn :: IORef (Either (BehaviorM x (PatchTarget p), Event x p) (Hold x p)) }
1213+newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
11631214
1164−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)
11651216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
11661217
11671218--TODO: Avoid the duplication between this and R.zipDynWith
1168−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)
11691220zipDynWith f da db =
11701221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
11711222 ec = flip push eab $ \o -> do
@@ -1180,26 +1231,20 @@ zipDynWith f da db =
11801231 return $ Just $ Identity $ f a b
11811232 in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
11821233
1183−buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => BehaviorM x (PatchTarget p) -> Event x p -> m (Dyn x p)
1234+buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => EventM x (PatchTarget p) -> Event x p -> m (Dyn x p)
11841235buildDynamic readV0 v' = do
1185− result <- liftIO $ newIORef $ Left (readV0, v')
1236+ result <- liftIO $ newIORef $ BuildDyn (readV0, v')
11861237 let !d = Dyn result
11871238 defer $ SomeDynInit d
11881239 return d
11891240
11901241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1191−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1192− where x = (readV0, v')
1242+unsafeBuildDynamic readV0 v' =
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
11931244
11941245-- ResultM can read behaviors and events
11951246type ResultM = EventM
11961247
1197−{-# NOINLINE unsafeNewIORef #-}
1198−unsafeNewIORef :: a -> b -> IORef b
1199−unsafeNewIORef a b = unsafePerformIO $ do
1200− touch a
1201− newIORef b
1202−
12031248instance HasSpiderTimeline x => Functor (Event x) where
12041249 fmap f = push $ return . Just . f
12051250
@@ -1212,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
12121257
12131258{-# INLINABLE pull #-}
12141259pull :: BehaviorM x a -> Behavior x a
1215−pull a = behaviorPull $ Pull
1216− { pullCompute = a
1217− , pullValue = unsafeNewIORef a Nothing
1260+pull a = unsafePerformIO $ do
1261+ ref <- newIORef Nothing
12181262#ifdef DEBUG_NODEIDS
1219− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
12201264#endif
1221− }
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1271+ }
12221272
12231273{-# INLINABLE switch #-}
12241274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1225−switch a = eventSwitch $ Switch
1226− { switchParent = a
1227− , switchSubscribed = unsafeNewIORef a Nothing
1228− }
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1277+ pure $ eventSwitch $ Switch
1278+ { switchParent = a
1279+ , switchSubscribed = ref
1280+ }
12291281
12301282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1231−coincidence a = eventCoincidence $ Coincidence
1232− { coincidenceParent = a
1233− , coincidenceSubscribed = unsafeNewIORef a Nothing
1234− }
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1285+ pure $ eventCoincidence $ Coincidence
1286+ { coincidenceParent = a
1287+ , coincidenceSubscribed = ref
1288+ }
12351289
12361290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
12371291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
12381292run roots after = do
12391293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1240− t <- SpiderHost ask
1241− result <- SpiderHost $ lift $ withMVar (_spiderTimeline_lock t) $ \_ -> flip runReaderT t $ unSpiderHost $ runFrame $ do
1294+ let t = spiderTimeline :: SpiderTimelineEnv x
1295+ result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
12421296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
12431297 occBefore <- liftIO $ do
12441298 occBefore <- readIORef occRef
@@ -1276,11 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
12761330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
12771331 EQ -> a
12781332
1279−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
12801334
1281−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
12821336
1283−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
12841338
12851339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
12861340
@@ -1292,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
12921346 x' <- evaluate x
12931347 mkWeakPtr x' $
12941348 if debugFinalize
1295− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
12961350 else Nothing
12971351
12981352type WeakList a = [Weak a]
12991353
1300−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
13011359#ifdef DEBUG
1302−withIncreasedDepth :: CanTrace x m => m a -> m a
1303−withIncreasedDepth a = do
1304− spiderTimeline <- askSpiderTimelineEnv
1305− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
1360+
1361+debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1362+debugSubscriber description = return . debugSubscriber' description
1363+
1364+debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1365+debugSubscriber' description subscribed = Subscriber
1366+ {
1367+ subscriberPropagate = \m -> do
1368+ tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1369+ subscriberPropagate subscribed m
1370+ , subscriberInvalidateHeight = \old -> do
1371+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1372+ subscriberInvalidateHeight subscribed old
1373+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1374+ , subscriberRecalculateHeight = \new -> do
1375+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1376+ subscriberRecalculateHeight subscribed new
1377+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1378+ }
1379+
1380+
1381+{-# INLINE withIncreasedDepth #-}
1382+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1383+withIncreasedDepth _ a = do
1384+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
13061385 result <- a
1307− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
13081387 return result
1309−#else
1310−withIncreasedDepth :: m a -> m a
1311−withIncreasedDepth = id
1312−#endif
1313−
1314−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
13151388
13161389{-# INLINE tracePropagate #-}
13171390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1318−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
13191392
13201393{-# INLINE traceInvalidate #-}
13211394traceInvalidate :: String -> IO ()
1322−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1395+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
13231396
1324−{-# INLINE traceWhen #-}
1325−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1326−traceWhen p b message = traceMWhen p b $ return message
1397+{-# INLINE traceInvalidateHeight #-}
1398+traceInvalidateHeight :: String -> IO ()
1399+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
13271400
1328−{-# INLINE traceMWhen #-}
1329−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1330−traceMWhen _ b getMessage = when b $ do
1401+{-# INLINE trace #-}
1402+trace :: (CanTrace x m) => proxy x -> String -> m ()
1403+trace p message = traceM p $ return message
1404+
1405+{-# INLINE traceM #-}
1406+traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1407+traceM _ getMessage = do
13311408 message <- getMessage
1332−#ifdef DEBUG
1333− spiderTimeline <- askSpiderTimelineEnv
1334− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1409+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
1411+
13351412#else
1336− 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+
13371448#endif
1338− liftIO $ putStrLn $ replicate d ' ' <> message
13391449
13401450whoCreatedIORef :: IORef a -> IO [String]
13411451whoCreatedIORef (IORef a) = whoCreated $! a
13421452
1343−#ifdef DEBUG_CYCLES
13441453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
13451454groupByHead = \case
13461455 [] -> []
@@ -1351,20 +1460,54 @@ groupByHead = \case
13511460 | otherwise -> (x, xs :| []) : l
13521461
13531462listsToForest :: Eq a => [[a]] -> Forest a
1354−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+
13551495#endif
13561496
1497+
13571498{-# INLINE propagateSubscriberHold #-}
13581499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
13591500propagateSubscriberHold h a = do
1360− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
13611502 invalidators <- liftIO $ readIORef $ holdInvalidators h
13621503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
13631505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
13641506 case {-# SCC "apply" #-} apply a v of
13651507 Nothing -> return ()
13661508 Just v' -> do
1367− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1509+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1510+ tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
13681511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
13691512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
13701513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1372,25 +1515,25 @@ propagateSubscriberHold h a = do
13721515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
13731516
13741517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1375−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
13761519
13771520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
13781521askInvalidator = do
1379− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
13801523 case m of
13811524 Nothing -> return Nothing
13821525 Just (!wi, _) -> return $ Just wi
13831526
13841527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
13851528askParentsRef = do
1386− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
13871530 case m of
13881531 Nothing -> return Nothing
13891532 Just (_, !p) -> return $ Just p
13901533
13911534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
13921535askBehaviorHoldInits = do
1393− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
13941537 return his
13951538
13961539{-# INLINE getDynHold #-}
@@ -1398,20 +1541,27 @@ getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
13981541getDynHold d = do
13991542 mh <- liftIO $ readIORef $ unDyn d
14001543 case mh of
1401− Right h -> return h
1402− Left (readV0, v') -> do
1544+ HoldDyn h -> return h
1545+ UnsafeDyn (readV0, v') -> do
14031546 holdInits <- getDeferralQueue
14041547 v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1548+ hold' v0 v'
1549+ BuildDyn (readV0, v') -> do
1550+ v0 <- liftIO $ runEventM readV0
1551+ hold' v0 v'
1552+ where
1553+ hold' v0 v' = do
14051554 h <- hold v0 v'
1406− liftIO $ writeIORef (unDyn d) $ Right h
1555+ liftIO $ writeIORef (unDyn d) $ HoldDyn h
14071556 return h
14081557
1558+
14091559-- Always refers to 0
14101560{-# NOINLINE zeroRef #-}
14111561zeroRef :: IORef Height
14121562zeroRef = unsafePerformIO $ newIORef zeroHeight
14131563
1414−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)
14151565getRootSubscribed k r sub = do
14161566 mSubscribed <- readIORef $ rootSubscribed r
14171567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1425,9 +1575,14 @@ getRootSubscribed k r sub = do
14251575 let !cached = rootSubscribed r
14261576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
14271577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1428− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1578+
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
14291581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
14301582 writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
14311586 let !subscribed = RootSubscribed
14321587 { rootSubscribedKey = k
14331588 , rootSubscribedCachedSubscribed = cached
@@ -1436,7 +1591,7 @@ getRootSubscribed k r sub = do
14361591 , rootSubscribedUninit = uninit
14371592 , rootSubscribedWeakSelf = weakSelf
14381593#ifdef DEBUG_NODEIDS
1439− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
14401595#endif
14411596 }
14421597 -- If we die at the same moment that all our children die, they will
@@ -1472,6 +1627,9 @@ data FanInt x a = FanInt
14721627 { _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
14731628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
14741629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
14751633 }
14761634
14771635newFanInt :: IO (FanInt x a)
@@ -1479,38 +1637,39 @@ newFanInt = do
14791637 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
14801638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
14811639 occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
14821643 return $ FanInt
14831644 { _fanInt_subscribers = subscribers
14841645 , _fanInt_subscriptionRef = subscriptionRef
14851646 , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
14861650 }
14871651
1488−{-# NOINLINE unsafeNewFanInt #-}
1489−unsafeNewFanInt :: b -> FanInt x a
1490−unsafeNewFanInt b = unsafePerformIO $ do
1491− touch b
1492− newFanInt
1493−
14941652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1495−fanInt p =
1496− let self = unsafeNewFanInt p
1497− in EventSelectorInt $ \k -> Event $ \sub -> do
1653+fanInt p = unsafePerformIO $ do
1654+ self <- newFanInt
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
14981656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
14991657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1500− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
15011660 { subscriberPropagate = \m -> do
15021661 liftIO $ writeIORef (_fanInt_occRef self) m
15031662 scheduleIntClear $ _fanInt_occRef self
1504− FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> do --TODO: Do we need to know that no subscribers are being added as we traverse?
1505− FastWeakBag.traverse b $ \s -> do
1663+ FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1664+ FastWeakBag.traverse_ b $ \s ->
15061665 subscriberPropagate s v
1507− , subscriberInvalidateHeight = \old -> do
1508− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1509− FastWeakBag.traverse b $ \s -> do
1666+ , subscriberInvalidateHeight = \old ->
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668+ FastWeakBag.traverse_ b $ \s ->
15101669 subscriberInvalidateHeight s old
1511− , subscriberRecalculateHeight = \new -> do
1512− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1513− FastWeakBag.traverse b $ \s -> do
1670+ , subscriberRecalculateHeight = \new ->
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672+ FastWeakBag.traverse_ b $ \s ->
15141673 subscriberRecalculateHeight s new
15151674 }
15161675 liftIO $ do
@@ -1524,13 +1683,28 @@ fanInt p =
15241683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
15251684 return b
15261685 Just b -> return b
1527− t <- liftIO $ FastWeakBag.insert sub b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
15281687 currentOcc <- readIORef (_fanInt_occRef self)
1529− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1530− return (EventSubscription (FastWeakBag.remove t) $! EventSubscribed heightRef $! toAny (_fanInt_subscriptionRef self, t), IntMap.lookup k currentOcc)
1688+
1689+ subscribed <- fanIntSubscribed ticket self
1690+ return (EventSubscription (FastWeakBag.remove ticket) subscribed, IntMap.lookup k currentOcc)
1691+
1692+fanIntSubscribed :: FastWeakBagTicket k -> FanInt x a -> IO (EventSubscribed x)
1693+fanIntSubscribed ticket self = do
1694+ subscribedParent <- _eventSubscription_subscribed <$> readIORef (_fanInt_subscriptionRef self)
1695+ return $ EventSubscribed
1696+ { eventSubscribedHeightRef = eventSubscribedHeightRef subscribedParent
1697+ , eventSubscribedRetained = toAny (_fanInt_subscriptionRef self, ticket)
1698+#ifdef DEBUG_CYCLES
1699+ , eventSubscribedGetParents = return [subscribedParent]
1700+ , eventSubscribedHasOwnHeightRef = False
1701+ , eventSubscribedWhoCreated = whoCreatedIORef $ _fanInt_subscriptionRef self
1702+#endif
1703+ }
1704+
15311705
15321706{-# INLINABLE getFanSubscribed #-}
1533−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))
15341708getFanSubscribed k f sub = do
15351709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
15361710 case mSubscribed of
@@ -1548,13 +1722,16 @@ getFanSubscribed k f sub = do
15481722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
15491723 occRef <- liftIO $ newIORef parentOcc
15501724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
15511728 let subscribed = FanSubscribed
15521729 { fanSubscribedCachedSubscribed = fanSubscribed f
15531730 , fanSubscribedOccurrence = occRef
15541731 , fanSubscribedParent = subscription
15551732 , fanSubscribedSubscribers = subscribersRef
15561733#ifdef DEBUG_NODEIDS
1557− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
15581735#endif
15591736 }
15601737 let !self = (k, subscribed)
@@ -1564,7 +1741,7 @@ getFanSubscribed k f sub = do
15641741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
15651742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
15661743
1567−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
15681745cleanupFanSubscribed (k, subscribed) = do
15691746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15701747 let reducedSubscribers = DMap.delete k subscribers
@@ -1576,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
15761753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
15771754
15781755{-# INLINE subscribeFanSubscribed #-}
1579−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
15801757subscribeFanSubscribed k subscribed sub = do
15811758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15821759 case DMap.lookup k subscribers of
@@ -1614,6 +1791,9 @@ getSwitchSubscribed s sub = do
16141791 when (isJust parentOcc) $ scheduleClear occRef
16151792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
16161793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
16171797 let !subscribed = SwitchSubscribed
16181798 { switchSubscribedCachedSubscribed = switchSubscribed s
16191799 , switchSubscribedOccurrence = occRef
@@ -1626,7 +1806,7 @@ getSwitchSubscribed s sub = do
16261806 , switchSubscribedCurrentParent = subscriptionRef
16271807 , switchSubscribedWeakSelf = weakSelf
16281808#ifdef DEBUG_NODEIDS
1629− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
16301810#endif
16311811 }
16321812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1671,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
16711851 scheduleClear innerSubdRef
16721852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
16731853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
16741857 let subscribed = CoincidenceSubscribed
16751858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
16761859 , coincidenceSubscribedOccurrence = occRef
@@ -1681,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
16811864 , coincidenceSubscribedInnerParent = innerSubdRef
16821865 , coincidenceSubscribedWeakSelf = weakSelf
16831866#ifdef DEBUG_NODEIDS
1684− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
16851868#endif
16861869 }
16871870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1698,57 +1881,72 @@ cleanupCoincidenceSubscribed subscribed = do
16981881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
16991882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
17001883
1701−{-# INLINE merge #-}
1702−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1703−merge d = cacheEvent (mergeCheap d)
1884+{-# INLINE mergeG #-}
1885+mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
1886+ => (forall a. q a -> Event x (v a))
1887+ -> DynamicS x (PatchDMap k q) -> Event x (DMap k v)
1888+mergeG nt d = cacheEvent (mergeCheap nt d)
17041889
17051890{-# INLINE mergeWithMove #-}
1706−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1707−mergeWithMove d = cacheEvent (mergeCheapWithMove d)
1891+mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
1892+ => (forall a. q a -> Event x (v a))
1893+ -> DynamicS x (PatchDMapWithMove k q) -> Event x (DMap k v)
1894+mergeWithMove nt d = cacheEvent (mergeCheapWithMove nt d)
17081895
17091896{-# INLINE [1] mergeCheap #-}
1710−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1711−mergeCheap = mergeCheap' getInitialSubscribers updateMe destroy
1897+mergeCheap
1898+ :: forall k x q v. (HasSpiderTimeline x, GCompare k)
1899+ => (forall a. q a -> Event x (v a))
1900+ -> DynamicS x (PatchDMap k q)
1901+ -> Event x (DMap k v)
1902+mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
17121903 where
1713− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
17141905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
17151906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
17161907 (mOldSubd, newPs) <- case me of
17171908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
17181909 Just e -> do
17191910 let s = subscriber $ return k
1720− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
17211912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
17221913 let newParent = MergeSubscribedParent subscription
17231914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17241915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
17251916 forM_ mOldSubd $ \oldSubd -> do
1726− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
17271920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17281921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
17291922 foldM f ([], oldParents) $ DMap.toList p
1730− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1923+
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
17311925 getInitialSubscribers initialParents subscriber = do
17321926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17331927 let s = subscriber $ return k
1734− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17351929 height <- liftIO $ getEventSubscribedHeight parentSubd
1736− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1930+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
17371931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17381932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17391933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17401934 )
1935+
17411936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
17421937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
17431938
17441939{-# INLINE [1] mergeCheapWithMove #-}
1745−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1746−mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1940+mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
1941+ => (forall a. q a -> Event x (v a))
1942+ -> DynamicS x (PatchDMapWithMove k q)
1943+ -> Event x (DMap k v)
1944+mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
17471945 where
1748− updateMe :: MergeUpdateFunc k x (PatchDMapWithMove k (Event x)) (MergeSubscribedParentWithMove x k)
1946+ updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
17491947 updateMe subscriber heightBagRef oldParents p = do
17501948 -- Prepare new parents for insertion
1751− 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)
17521950 subscribeParent k e = do
17531951 keyRef <- liftIO $ newIORef k
17541952 let s = subscriber $ liftIO $ readIORef keyRef
@@ -1757,73 +1955,82 @@ mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
17571955 newParentHeight <- getEventSubscribedHeight subd
17581956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17591957 return $ MergeSubscribedParentWithMove subscription keyRef
1760− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
17611959 -- Collect old parents for deletion and update the keys of moved parents
1762− 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
17631961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
17641962 Nothing -> do
1765− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
17661966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17671967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
17681968 Just toKey -> do
17691969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
17701970 return Nothing
1771− toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1971+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1972+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1973+
17721974 return (toDelete, applyAlways p' oldParents)
1773− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
17741976 getInitialSubscribers initialParents subscriber = do
17751977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17761978 keyRef <- liftIO $ newIORef k
17771979 let s = subscriber $ liftIO $ readIORef keyRef
1778− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17791981 height <- liftIO $ getEventSubscribedHeight parentSubd
1780− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1982+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
17811983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17821984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17831985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17841986 )
1987+
17851988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
17861989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
17871990
1788−type MergeUpdateFunc k x p s
1789− = (forall a. EventM x (k a) -> Subscriber x a)
1991+type MergeUpdateFunc k v x p s
1992+ = (forall a. EventM x (k a) -> Subscriber x (v a))
17901993 -> IORef HeightBag
17911994 -> DMap k s
17921995 -> p
17931996 -> EventM x ([EventSubscription x], DMap k s)
17941997
1795−type MergeInitFunc k x s
1796− = DMap k (Event x)
1797− -> (forall a. EventM x (k a) -> Subscriber x a)
1798− -> EventM x (DMap k Identity, [Height], DMap k s)
1998+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1999+
2000+type MergeInitFunc k v q x s
2001+ = DMap k q
2002+ -> (forall a. EventM x (k a) -> Subscriber x (v a))
2003+ -> EventM x (DMap k v, [Height], DMap k s)
17992004
18002005type MergeDestroyFunc k s
18012006 = DMap k s
18022007 -> IO ()
18032008
1804−data Merge x k s = Merge
2009+data Merge x k v s = Merge
18052010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
18062011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
18072012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1808− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
1809− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
18102015 }
18112016
1812−invalidateMergeHeight :: Merge x k s -> IO ()
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
18132018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
18142019
18152020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
18162021invalidateMergeHeight' heightRef sub = do
18172022 oldHeight <- readIORef heightRef
1818− 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
18192025 writeIORef heightRef $! invalidHeight
18202026 subscriberInvalidateHeight sub oldHeight
18212027
1822−
1823−revalidateMergeHeight :: Merge x k s -> IO ()
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
18242029revalidateMergeHeight m = do
18252030 currentHeight <- readIORef $ _merge_heightRef m
1826− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2031+
2032+ -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2033+ when (currentHeight == invalidHeight) $ do
18272034 heights <- readIORef $ _merge_heightBagRef m
18282035 parents <- readIORef $ _merge_parentsRef m
18292036 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
@@ -1831,44 +2038,53 @@ revalidateMergeHeight m = do
18312038 LT -> return ()
18322039 EQ -> do
18332040 let height = succHeight $ heightBagMax heights
1834− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
18352042 writeIORef (_merge_heightRef m) $! height
18362043 subscriberRecalculateHeight (_merge_sub m) height
18372044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
18382045
1839−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
18402047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
18412048 vals <- liftIO $ readIORef $ _merge_accumRef m
1842− 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
18432052 --TODO: Assert that m is not empty
18442053 subscriberPropagate (_merge_sub m) vals
18452054
1846−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
1847−mergeSubscriber m getKey = Subscriber
2055+checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2056+checkCycle subscribed = liftIO $ do
2057+ height <- readIORef (eventSubscribedHeightRef subscribed)
2058+
2059+ -- currentHeight <- getCurrentHeight
2060+ -- when (height <= currentHeight) $ if height /= invalidHeight
2061+ -- then do
2062+ -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2063+ -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2064+ -- else liftIO $
2065+ when (height == invalidHeight) $
2066+#ifdef DEBUG_CYCLES
2067+ do
2068+ nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2069+ stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2070+ throwIO (EventLoopException stacks)
2071+#else
2072+ throwIO EventLoopException
2073+#endif
2074+
2075+
2076+mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
2077+mergeSubscriber subscribed m getKey = Subscriber
18482078 { subscriberPropagate = \a -> do
18492079 oldM <- liftIO $ readIORef $ _merge_accumRef m
18502080 k <- getKey
1851− 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
18522082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
18532083 liftIO $ writeIORef (_merge_accumRef m) $! newM
18542084 when (DMap.null oldM) $ do -- Only schedule the firing once
18552085 height <- liftIO $ readIORef $ _merge_heightRef m
1856− --TODO: assertions about height
1857− currentHeight <- getCurrentHeight
1858− when (height <= currentHeight) $ do
1859− if height /= invalidHeight
1860− then do
1861− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1862− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1863− else liftIO $ do
1864−#ifdef DEBUG_CYCLES
1865− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1866− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
1867− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1868−#else
1869− let cycleInfo = ""
1870−#endif
1871− error $ "Causality loop found" <> cycleInfo
2086+ checkCycle subscribed
2087+
18722088 scheduleMergeSelf m height
18732089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
18742090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1879,30 +2095,45 @@ mergeSubscriber m getKey = Subscriber
18792095 }
18802096
18812097--TODO: Be able to run as much of this as possible promptly
1882−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k s -> MergeUpdateFunc k x p s -> p -> SomeMergeUpdate x
1883−updateMerge m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2098+updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
2099+updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
18842100 where updateMe = do
18852101 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
1886− (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber m) (_merge_heightBagRef m) oldParents p
2102+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
18872103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
18882104 return subscriptionsToKill
18892105
1890−{-# INLINE mergeCheap' #-}
1891−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)
1892−mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
2106+{-# INLINE mergeGCheap' #-}
2107+mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
2108+ => MergeGetSubscription x s -> MergeInitFunc k v q x s -> MergeUpdateFunc k v x p s -> MergeDestroyFunc k s -> DynamicS x p -> Event x (DMap k v)
2109+mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
18932110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
18942111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
18952112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
18962113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
18972114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1898− let m = Merge
2115+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2116+
2117+ let subscribed = EventSubscribed
2118+ { eventSubscribedHeightRef = heightRef
2119+ , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
2120+#ifdef DEBUG_CYCLES
2121+ , eventSubscribedGetParents = do
2122+ let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
2123+ fmap getParent' . DMap.toList <$> readIORef parentsRef
2124+ , eventSubscribedHasOwnHeightRef = False
2125+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2126+#endif
2127+ }
2128+
2129+ m = Merge
18992130 { _merge_parentsRef = parentsRef
19002131 , _merge_heightBagRef = heightBagRef
19012132 , _merge_heightRef = heightRef
19022133 , _merge_sub = sub
19032134 , _merge_accumRef = accumRef
19042135 }
1905− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
19062137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
19072138 myHeight = if invalidHeight `elem` heights
19082139 then invalidHeight
@@ -1911,50 +2142,57 @@ mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
19112142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
19122143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
19132144 else (Nothing, dm)
1914− unless (DMap.null accum) $ do
1915− scheduleMergeSelf m myHeight
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
19162146 liftIO $ writeIORef accumRef $! accum
19172147 liftIO $ writeIORef heightRef $! myHeight
19182148 liftIO $ writeIORef heightBagRef $! myHeightBag
1919− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19202149 liftIO $ writeIORef parentsRef $! initialParentState
19212150 defer $ SomeMergeInit $ do
1922− let s = Subscriber
2151+ let changeSubscriber = Subscriber
19232152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1924− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1925− defer $ updateMerge m updateFunc a
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2154+ defer $ updateMerge subscribed m updateFunc a
19262155 , subscriberInvalidateHeight = \_ -> return ()
19272156 , subscriberRecalculateHeight = \_ -> return ()
19282157 }
1929− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
1930− forM_ change $ \c -> defer $ updateMerge m updateFunc c
2158+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2159+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
19312160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
19322161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
19332162 -- its subscription.
1934− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
19352164 let unsubscribeAll = destroy =<< readIORef parentsRef
1936− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1937− , occ
1938− )
19392165
1940−mergeInt :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2166+ return (EventSubscription unsubscribeAll subscribed, occ)
2167+
2168+
2169+mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
19412170mergeInt = cacheEvent . mergeIntCheap
19422171
19432172{-# INLINABLE mergeIntCheap #-}
1944−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)
19452174mergeIntCheap d = Event $ \sub -> do
19462175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
19472176 accum <- liftIO $ FastMutableIntMap.newEmpty
19482177 heightRef <- liftIO $ newIORef zeroHeight
19492178 heightBagRef <- liftIO $ newIORef heightBagEmpty
19502179 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+ }
19512190 let scheduleSelf = do
19522191 height <- liftIO $ readIORef $ heightRef
19532192 scheduleMerge' height heightRef $ do
19542193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
19552194 subscriberPropagate sub vals
1956− invalidateMyHeight = do
1957− invalidateMergeHeight' heightRef sub
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
19582196 recalculateMyHeight = do
19592197 currentHeight <- readIORef heightRef
19602198 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?
@@ -1964,12 +2202,14 @@ mergeIntCheap d = Event $ \sub -> do
19642202 LT -> return ()
19652203 EQ -> do
19662204 let height = succHeight $ heightBagMax heights
1967− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
19682206 writeIORef heightRef $! height
19692207 subscriberRecalculateHeight sub height
19702208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
19712209 mySubscriber k = Subscriber
19722210 { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
19732213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
19742214 liftIO $ FastMutableIntMap.insert accum k a
19752215 when wasEmpty scheduleSelf
@@ -2003,7 +2243,6 @@ mergeIntCheap d = Event $ \sub -> do
20032243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
20042244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
20052245 return Nothing
2006− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
20072246 defer $ SomeMergeInit $ do
20082247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
20092248 where
@@ -2017,35 +2256,39 @@ mergeIntCheap d = Event $ \sub -> do
20172256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
20182257 liftIO $ for_ oldParents $ \oldParent -> do
20192258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
20202261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
20212262 return $ IntMap.elems oldParents
2022− let s = Subscriber
2263+ let changeSubscriber = Subscriber
20232264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
20242265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
20252266 defer $ updateMe a
20262267 , subscriberInvalidateHeight = \_ -> return ()
20272268 , subscriberRecalculateHeight = \_ -> return ()
20282269 }
2029− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
20302271 forM_ change $ \c -> defer $ updateMe c
20312272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
20322273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
20332274 -- its subscription.
2034− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
20352276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2036− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2037− , occ
2038− )
2277+
2278+
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
20392280
20402281newtype 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) }
20412283
2042−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2043−fan e =
2284+fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
2285+fanG e = unsafePerformIO $ do
2286+ ref <- newIORef Nothing
20442287 let f = Fan
20452288 { fanParent = e
2046− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
20472290 }
2048− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
20492292
20502293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
20512294runHoldInits holdInitRef dynInitRef mergeInitRef = do
@@ -2098,37 +2341,37 @@ clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeI
20982341
20992342-- | Run an event action outside of a frame
21002343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2101−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2102− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2344+runFrame a = SpiderHost $ do
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
21032346 let go = do
21042347 result <- a
21052348 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
21062349 return result
21072350 result <- runEventM go
21082351 toClear <- readIORef $ eventEnvClears env
2109− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
2352+ forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
21102353 toClearInt <- readIORef $ eventEnvIntClears env
2111− forM_ toClearInt $ \(SomeIntClear ref) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2354+ forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
21122355 toClearRoot <- readIORef $ eventEnvRootClears env
2113− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2356+ forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
21142357 toAssign <- readIORef $ eventEnvAssignments env
21152358 toReconnectRef <- newIORef []
21162359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
21172360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
21182361 writeIORef vRef v
2119− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
21202363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
21212364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
21222365 writeIORef (eventEnvMergeUpdates env) []
2123− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
21242367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2125− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
21262369 toReconnect <- readIORef toReconnectRef
21272370 clearEventEnv env
21282371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
21292372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
21302373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2131− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
21322375 finalize wi
21332376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
21342377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2139,10 +2382,10 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
21392382 runEventM $ runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) --TODO: Is this actually OK? It seems like it should be, since we know that no events are firing at this point, but it still seems inelegant
21402383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
21412384 sub <- newSubscriberSwitch subscribed
2142− subscription <- runReaderT (unSpiderHost (runFrame ({-# SCC "subscribeSwitch" #-} subscribe e sub))) spiderTimeline --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
2385+ subscription <- unSpiderHost $ runFrame $ {-# SCC "subscribeSwitch" #-} subscribe e sub --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
21432386 {-
21442387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2145− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
21462389 EventRoot _ -> "EventRoot"
21472390 EventNever -> "EventNever"
21482391 _ -> "something else"
@@ -2157,7 +2400,7 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
21572400 myHeight <- readIORef $ switchSubscribedHeight subscribed
21582401 when (parentHeight /= myHeight) $ do
21592402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2160− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
21612404 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
21622405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
21632406 unsubscribe subscription
@@ -2198,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
21982441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
21992442 when (oldHeight /= invalidHeight) $ do
22002443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2201− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
22022445
22032446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
22042447updateSwitchHeight new subscribed = do
@@ -2206,7 +2449,7 @@ updateSwitchHeight new subscribed = do
22062449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
22072450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
22082451 writeIORef (switchSubscribedHeight subscribed) $! new
2209− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
22102453
22112454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
22122455recalculateCoincidenceHeight subscribed = do
@@ -2215,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
22152458 height <- calculateCoincidenceHeight subscribed
22162459 when (height /= invalidHeight) $ do
22172460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2218− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
22192462
22202463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
22212464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -2254,13 +2497,218 @@ invalidate toReconnectRef wis = do
22542497-- Reflex integration
22552498--------------------------------------------------------------------------------
22562499
2257−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2258−-- When we're specializing, we include this from Reflex.Class instead, because
2259−-- it needs access to these types; when we're not, we want them here, so our
2260−-- instance isn't an orphan instance.
2261−#include "SpiderTimeline.include.hs"
2262−#include "SpiderTimelineHost.include.hs"
2500+-- | Designates the default, global Spider timeline
2501+data SpiderTimeline x
2502+type role SpiderTimeline nominal
2503+
2504+-- | The default, global Spider environment
2505+type Spider = SpiderTimeline Global
2506+
2507+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (EventM x) where
2508+ {-# INLINABLE sample #-}
2509+ sample (SpiderBehavior b) = readBehaviorUntracked b
2510+
2511+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (EventM x) where
2512+ {-# INLINABLE hold #-}
2513+ hold = holdSpiderEventM
2514+ {-# INLINABLE holdDyn #-}
2515+ holdDyn = holdDynSpiderEventM
2516+ {-# INLINABLE holdIncremental #-}
2517+ holdIncremental = holdIncrementalSpiderEventM
2518+ {-# INLINABLE buildDynamic #-}
2519+ buildDynamic = buildDynamicSpiderEventM
2520+ {-# INLINABLE headE #-}
2521+ headE = R.slowHeadE
2522+-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
2525+
2526+instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
2527+ {-# INLINABLE sample #-}
2528+ sample = coerce . readBehaviorTracked . unSpiderBehavior
2529+
2530+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
2531+ {-# INLINABLE sample #-}
2532+ sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2533+
2534+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
2535+ {-# INLINABLE hold #-}
2536+ hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
2537+ {-# INLINABLE holdDyn #-}
2538+ holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
2539+ {-# INLINABLE holdIncremental #-}
2540+ holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
2541+ {-# INLINABLE buildDynamic #-}
2542+ buildDynamic getV0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce e
2543+ {-# INLINABLE headE #-}
2544+ headE = R.slowHeadE
2545+-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
2549+
2550+instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
2551+ {-# INLINE return #-}
2552+ return = pure
2553+ {-# INLINE (>>=) #-}
2554+ x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
2555+ {-# INLINE (>>) #-}
2556+ (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
2558+ {-# INLINE fail #-}
2559+ fail _ = error "Dynamic does not support 'fail'"
2560+#endif
2561+
2562+{-# INLINABLE newJoinDyn #-}
2563+newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
2564+newJoinDyn d =
2565+ let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2566+ eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
2567+ eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
2568+ eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
2569+ v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
2570+ in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
2571+
2572+instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
2573+ fmap = mapDynamicSpider
2574+ x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
2575+
2576+mapDynamicSpider :: HasSpiderTimeline x => (a -> b) -> Reflex.Class.Dynamic (SpiderTimeline x) a -> Reflex.Class.Dynamic (SpiderTimeline x) b
2577+mapDynamicSpider f = SpiderDynamic . newMapDyn f . unSpiderDynamic
2578+{-# INLINE [1] mapDynamicSpider #-}
2579+
2580+instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
2581+ pure = SpiderDynamic . dynamicConst
2582+#if MIN_VERSION_base(4,10,0)
2583+ liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
22632584#endif
2585+ SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
2586+ a *> b = R.unsafeBuildDynamic (R.sample $ R.current b) $ R.leftmost [R.updated b, R.tag (R.current b) $ R.updated a]
2587+ (<*) = flip (*>) -- There are no effects, so order doesn't matter
2588+
2589+holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
2590+holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2591+
2592+holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2593+holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2594+
2595+holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
2596+holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2597+
2598+buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPushM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2599+buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2600+
2601+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
2602+ {-# INLINABLE hold #-}
2603+ hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
2604+ {-# INLINABLE holdDyn #-}
2605+ holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
2606+ {-# INLINABLE holdIncremental #-}
2607+ holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
2608+ {-# INLINABLE buildDynamic #-}
2609+ buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2610+ {-# INLINABLE headE #-}
2611+ headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
2615+
2616+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2617+ sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2618+
2619+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
2620+ {-# INLINABLE hold #-}
2621+ hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2622+ {-# INLINABLE holdDyn #-}
2623+ holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2624+ {-# INLINABLE holdIncremental #-}
2625+ holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2626+ {-# INLINABLE buildDynamic #-}
2627+ buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2628+ {-# INLINABLE headE #-}
2629+ headE = R.slowHeadE
2630+-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
2633+
2634+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2635+ {-# INLINABLE sample #-}
2636+ sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2637+
2638+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2639+ {-# INLINABLE sample #-}
2640+ sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
2641+
2642+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2643+ {-# INLINABLE hold #-}
2644+ hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
2645+ {-# INLINABLE holdDyn #-}
2646+ holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
2647+ {-# INLINABLE holdIncremental #-}
2648+ holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
2649+ {-# INLINABLE buildDynamic #-}
2650+ buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2651+ {-# INLINABLE headE #-}
2652+ headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
2655+
2656+--------------------------------------------------------------------------------
2657+-- Deprecated items
2658+--------------------------------------------------------------------------------
2659+
2660+-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
2661+{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
2662+type SpiderEnv = SpiderTimeline
2663+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2664+ {-# INLINABLE subscribeEvent #-}
2665+ subscribeEvent e = SpiderHostFrame $ do
2666+ --TODO: Unsubscribe eventually (manually and/or with weak ref)
2667+ val <- liftIO $ newIORef Nothing
2668+ subscription <- subscribe (unSpiderEvent e) $ Subscriber
2669+ { subscriberPropagate = \a -> do
2670+ liftIO $ writeIORef val $ Just a
2671+ scheduleClear val
2672+ , subscriberInvalidateHeight = \_ -> return ()
2673+ , subscriberRecalculateHeight = \_ -> return ()
2674+ }
2675+ return $ SpiderEventHandle
2676+ { spiderEventHandleSubscription = subscription
2677+ , spiderEventHandleValue = val
2678+ }
2679+
2680+instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
2681+ type EventTrigger (SpiderTimeline x) = RootTrigger x
2682+ type EventHandle (SpiderTimeline x) = SpiderEventHandle x
2683+ type HostFrame (SpiderTimeline x) = SpiderHostFrame x
2684+
2685+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2686+ {-# NOINLINE readEvent #-}
2687+ readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
2688+ result <- readIORef $ spiderEventHandleValue h
2689+ touch h
2690+ return result
2691+
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2693+ newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2694+ newFanEventWithTrigger f = SpiderHost $ do
2695+ es <- newFanEventWithTriggerIO f
2696+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2697+
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2699+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2700+ newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2701+ es <- newFanEventWithTriggerIO f
2702+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2703+
2704+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
2705+ {-# INLINABLE subscribeEvent #-}
2706+ subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
2707+
2708+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
2709+ type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
2710+ fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
2711+ runHostFrame = runFrame . runSpiderHostFrame
22642712
22652713unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
22662714unsafeNewSpiderTimelineEnv = do
@@ -2269,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
22692717#ifdef DEBUG
22702718 depthRef <- newIORef 0
22712719#endif
2272− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
22732721 { _spiderTimeline_lock = lock
22742722 , _spiderTimeline_eventEnv = env
22752723#ifdef DEBUG
@@ -2277,43 +2725,40 @@ unsafeNewSpiderTimelineEnv = do
22772725#endif
22782726 }
22792727
2280−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
22812728-- | Create a new SpiderTimelineEnv
22822729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2283−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
22842731
2285−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
22862733
22872734instance Reifies s (SpiderTimelineEnv x) =>
22882735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2289− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
22902737
22912738localSpiderTimeline
2292− :: Proxy s
2739+ :: proxy s
22932740 -> SpiderTimelineEnv x
22942741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2295−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
22962743
22972744-- | Pass a new timeline to the given function.
22982745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
22992746withSpiderTimeline k = do
23002747 env <- unsafeNewSpiderTimelineEnv
23012748 reify env $ \s -> k $ localSpiderTimeline s env
2302−#endif
23032749
2304−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)
23052751
23062752type ComputeM = EventM
23072753
2308−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)
23092755
2310−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
23112756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23122757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
23132758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
23142759 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2315− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
2316− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
2760+ newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2761+ newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
23172762 type PullM (SpiderTimeline x) = SpiderPullM x
23182763 type PushM (SpiderTimeline x) = SpiderPushM x
23192764 {-# INLINABLE never #-}
@@ -2326,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23262771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
23272772 {-# INLINABLE pull #-}
23282773 pull = SpiderBehavior . pull . coerce
2329− {-# INLINABLE merge #-}
2330− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
2331− {-# INLINABLE fan #-}
2332− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2774+ {-# INLINABLE fanG #-}
2775+ fanG e = R.EventSelectorG $ SpiderEvent . selectG (fanG (unSpiderEvent e))
2776+ {-# INLINABLE mergeG #-}
2777+ mergeG
2778+ :: forall k2 (k :: k2 -> *) q (v :: k2 -> *). GCompare k
2779+ => (forall a. q a -> R.Event (SpiderTimeline x) (v a))
2780+ -> DMap k q
2781+ -> R.Event (SpiderTimeline x) (DMap k v)
2782+ mergeG nt = SpiderEvent . mergeG (unSpiderEvent #. nt) . dynamicConst
23332783 {-# INLINABLE switch #-}
23342784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
23352785 {-# INLINABLE coincidence #-}
@@ -2337,15 +2787,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23372787 {-# INLINABLE current #-}
23382788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
23392789 {-# INLINABLE updated #-}
2340− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
23412791 {-# INLINABLE unsafeBuildDynamic #-}
23422792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
23432793 {-# INLINABLE unsafeBuildIncremental #-}
23442794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2345− {-# INLINABLE mergeIncremental #-}
2346− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2347− {-# INLINABLE mergeIncrementalWithMove #-}
2348− mergeIncrementalWithMove = SpiderEvent . mergeWithMove . (unsafeCoerce :: Dynamic x (PatchDMapWithMove k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMapWithMove k (Event x))) . unSpiderIncremental
2795+ {-# INLINABLE mergeIncrementalG #-}
2796+ mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2797+ {-# INLINABLE mergeIncrementalWithMoveG #-}
2798+ mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
23492799 {-# INLINABLE currentIncremental #-}
23502800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
23512801 {-# INLINABLE updatedIncremental #-}
@@ -2356,12 +2806,12 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23562806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
23572807 eventCoercion Coercion = Coercion
23582808 behaviorCoercion Coercion = Coercion
2359− 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
23602811 {-# INLINABLE mergeIntIncremental #-}
2361− mergeIntIncremental = SpiderEvent . mergeInt . (unsafeCoerce :: Dynamic x (PatchIntMap (R.Event (SpiderTimeline x) a)) -> Dynamic x (PatchIntMap (Event x a))) . unSpiderIncremental
2812+ mergeIntIncremental = SpiderEvent . mergeInt . coerce
23622813 {-# INLINABLE fanInt #-}
23632814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2364−#endif
23652815
23662816data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
23672817
@@ -2384,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
23842834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
23852835
23862836-- | The monad for actions that manipulate a Spider timeline identified by @x@
2387−newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderTimelineEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2837+newtype SpiderHost (x :: Type) a = SpiderHost { unSpiderHost :: IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
23882838
23892839instance Monad (SpiderHost x) where
23902840 {-# INLINABLE (>>=) #-}
@@ -2393,22 +2843,27 @@ instance Monad (SpiderHost x) where
23932843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
23942844 {-# INLINABLE return #-}
23952845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
23962847 {-# INLINABLE fail #-}
2397− fail s = SpiderHost $ fail s
2848+ fail = MonadFail.fail
2849+#endif
2850+
2851+instance MonadFail (SpiderHost x) where
2852+ {-# INLINABLE fail #-}
2853+ fail s = SpiderHost $ MonadFail.fail s
23982854
23992855-- | Run an action affecting the global Spider timeline; this will be guarded by
24002856-- a mutex for that timeline
24012857runSpiderHost :: SpiderHost Global a -> IO a
2402−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimelineEnv
2858+runSpiderHost (SpiderHost a) = a
24032859
2404−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
24052860-- | Run an action affecting a given Spider timeline; this will be guarded by a
24062861-- mutex for that timeline
24072862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2408−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2409−#endif
2863+runSpiderHostForTimeline (SpiderHost a) _ = a
24102864
2411−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2865+newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2866+ deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
24122867
24132868instance Monad (SpiderHostFrame x) where
24142869 {-# INLINABLE (>>=) #-}
@@ -2417,19 +2872,21 @@ instance Monad (SpiderHostFrame x) where
24172872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
24182873 {-# INLINABLE return #-}
24192874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
24202876 {-# INLINABLE fail #-}
24212877 fail s = SpiderHostFrame $ fail s
2878+#endif
24222879
2423−instance NotReady x (SpiderHostFrame x) where
2880+instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
24242881 notReadyUntil _ = pure ()
24252882 notReady = pure ()
24262883
2427−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)
24282885newEventWithTriggerIO f = do
24292886 es <- newFanEventWithTriggerIO $ \Refl -> f
24302887 return $ select es Refl
24312888
2432−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)
24332890newFanEventWithTriggerIO f = do
24342891 occRef <- newIORef DMap.empty
24352892 subscribedRef <- newIORef DMap.empty
@@ -2463,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
24632920instance PrimMonad (SpiderHostFrame x) where
24642921 type PrimState (SpiderHostFrame x) = PrimState IO
24652922 primitive = SpiderHostFrame . EventM . primitive
2923+
2924+instance NotReady (SpiderTimeline x) (SpiderHost x) where
2925+ notReadyUntil _ = return ()
2926+ notReady = return ()
2927+
2928+instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
2929+ notReadyUntil _ = return ()
2930+ notReady = return ()
src/Reflex/Spider/SpiderTimeline.include.hsdeleted−155
@@ -1,155 +0,0 @@
1−-- | Designates the default, global Spider timeline
2−data SpiderTimeline x
3−type role SpiderTimeline nominal
4−
5−-- | The default, global Spider environment
6−type Spider = SpiderTimeline Global
7−
8−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (EventM x) where
9− {-# INLINABLE sample #-}
10− sample (SpiderBehavior b) = readBehaviorUntracked b
11−
12−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (EventM x) where
13− {-# INLINABLE hold #-}
14− hold = holdSpiderEventM
15− {-# INLINABLE holdDyn #-}
16− holdDyn = holdDynSpiderEventM
17− {-# INLINABLE holdIncremental #-}
18− holdIncremental = holdIncrementalSpiderEventM
19− {-# INLINABLE buildDynamic #-}
20− buildDynamic = buildDynamicSpiderEventM
21− {-# INLINABLE headE #-}
22− headE = R.slowHeadE
23−-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
24−
25−instance (
26−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
27− x ~ Global
28−#endif
29− ) => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
30− {-# INLINABLE sample #-}
31− sample = coerce . readBehaviorTracked . unSpiderBehavior
32−
33−instance (
34−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
35− x ~ Global
36−#else
37− HasSpiderTimeline x
38−#endif
39− ) => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
40− {-# INLINABLE sample #-}
41− sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
42−
43−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
44− {-# INLINABLE hold #-}
45− hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
46− {-# INLINABLE holdDyn #-}
47− holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
48− {-# INLINABLE holdIncremental #-}
49− holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
50− {-# INLINABLE buildDynamic #-}
51− buildDynamic getV0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce e
52− {-# INLINABLE headE #-}
53− headE = R.slowHeadE
54−-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
55−
56−instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
57− {-# INLINE return #-}
58− return = pure
59− {-# INLINE (>>=) #-}
60− x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
61− {-# INLINE (>>) #-}
62− (>>) = (*>)
63− {-# INLINE fail #-}
64− fail _ = error "Dynamic does not support 'fail'"
65−
66−{-# INLINABLE newJoinDyn #-}
67−newJoinDyn :: HasSpiderTimeline x => Reflex.Spider.Internal.Dynamic x (Identity (Reflex.Spider.Internal.Dynamic x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
68−newJoinDyn d =
69− let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
70− eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
71− eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
72− eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
73− v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
74− in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
75−
76−instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
77− fmap f = SpiderDynamic . newMapDyn f . unSpiderDynamic
78− x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
79−
80−instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
81− pure = SpiderDynamic . dynamicConst
82−#if MIN_VERSION_base(4,10,0)
83− liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
84−#endif
85− SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
86− a *> b = R.unsafeBuildDynamic (R.sample $ R.current b) $ R.leftmost [R.updated b, R.tag (R.current b) $ R.updated a]
87− (<*) = flip (*>) -- There are no effects, so order doesn't matter
88−
89−holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
90−holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
91−
92−holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
93−holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
94−
95−holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
96−holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
97−
98−buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPullM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
99−buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
100−
101−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
102− {-# INLINABLE hold #-}
103− hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
104− {-# INLINABLE holdDyn #-}
105− holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
106− {-# INLINABLE holdIncremental #-}
107− holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
108− {-# INLINABLE buildDynamic #-}
109− buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
110− {-# INLINABLE headE #-}
111− headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
112−
113−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
114− sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
115−
116−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
117− {-# INLINABLE hold #-}
118− hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
119− {-# INLINABLE holdDyn #-}
120− holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
121− {-# INLINABLE holdIncremental #-}
122− holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
123− {-# INLINABLE buildDynamic #-}
124− buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
125− {-# INLINABLE headE #-}
126− headE = R.slowHeadE
127−-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
128−
129−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
130− {-# INLINABLE sample #-}
131− sample = runFrame . readBehaviorUntracked . unSpiderBehavior
132−
133−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
134− {-# INLINABLE sample #-}
135− sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
136−
137−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
138− {-# INLINABLE hold #-}
139− hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
140− {-# INLINABLE holdDyn #-}
141− holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
142− {-# INLINABLE holdIncremental #-}
143− holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
144− {-# INLINABLE buildDynamic #-}
145− buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
146− {-# INLINABLE headE #-}
147− headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
148−
149−--------------------------------------------------------------------------------
150−-- Deprecated items
151−--------------------------------------------------------------------------------
152−
153−-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
154−{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
155−type SpiderEnv = SpiderTimeline
src/Reflex/Spider/SpiderTimelineHost.include.hsdeleted−57
@@ -1,57 +0,0 @@
1−instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2− {-# INLINABLE subscribeEvent #-}
3− subscribeEvent e = SpiderHostFrame $ do
4− --TODO: Unsubscribe eventually (manually and/or with weak ref)
5− val <- liftIO $ newIORef Nothing
6− subscription <- subscribe (unSpiderEvent e) $ Subscriber
7− { subscriberPropagate = \a -> do
8− liftIO $ writeIORef val $ Just a
9− scheduleClear val
10− , subscriberInvalidateHeight = \_ -> return ()
11− , subscriberRecalculateHeight = \_ -> return ()
12− }
13− return $ SpiderEventHandle
14− { spiderEventHandleSubscription = subscription
15− , spiderEventHandleValue = val
16− }
17−
18−instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
19− type EventTrigger (SpiderTimeline x) = RootTrigger x
20− type EventHandle (SpiderTimeline x) = SpiderEventHandle x
21− type HostFrame (SpiderTimeline x) = SpiderHostFrame x
22−
23−instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
24− {-# NOINLINE readEvent #-}
25− readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
26− result <- readIORef $ spiderEventHandleValue h
27− touch h
28− return result
29−
30−instance (
31−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
32− x ~ Global
33−#endif
34− ) => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
35− newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
36− newFanEventWithTrigger f = SpiderHost $ lift $ do
37− es <- newFanEventWithTriggerIO f
38− return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
39−
40−instance (
41−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
42− x ~ Global
43−#endif
44− ) => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
45− newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
46− newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
47− es <- newFanEventWithTriggerIO f
48− return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
49−
50−instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
51− {-# INLINABLE subscribeEvent #-}
52− subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
53−
54−instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
55− type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
56− fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
57− runHostFrame = runFrame . runSpiderHostFrame
src/Reflex/Time.hs+158−14
@@ -1,13 +1,21 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveGeneric #-}
4+{-# LANGUAGE DeriveTraversable #-}
25{-# LANGUAGE FlexibleContexts #-}
36{-# LANGUAGE MultiParamTypeClasses #-}
47{-# LANGUAGE RecursiveDo #-}
58{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE CPP #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
711#ifdef USE_TEMPLATE_HASKELL
812{-# LANGUAGE TemplateHaskell #-}
913#endif
10−{-# LANGUAGE TypeFamilies #-}
14+-- |
15+-- Module:
16+-- Reflex.Time
17+-- Description:
18+-- Clocks, timers, and other time-related functions.
1119module Reflex.Time where
1220
1321import Reflex.Class
@@ -23,36 +31,50 @@ import Control.Monad
2331import Control.Monad.Fix
2432import Control.Monad.IO.Class
2533import Data.Align
34+import Data.Data (Data)
2635import Data.Fixed
36+import Data.Semigroup (Semigroup(..))
2737import Data.Sequence (Seq, (|>))
2838import qualified Data.Sequence as Seq
2939import Data.These
3040import Data.Time.Clock
3141import Data.Typeable
42+import GHC.Generics (Generic)
3243import System.Random
3344
45+-- | Metadata associated with a timer "tick"
3446data TickInfo
3547 = TickInfo { _tickInfo_lastUTC :: UTCTime
3648 -- ^ UTC time immediately after the last tick.
3749 , _tickInfo_n :: Integer
38− -- ^ Number of time periods since t0
50+ -- ^ Number of time periods or ticks since the start of the timer
3951 , _tickInfo_alreadyElapsed :: NominalDiffTime
40− -- ^ Amount of time already elapsed in the current tick period.
52+ -- ^ Amount of time that has elapsed in the current tick period.
4153 }
4254 deriving (Eq, Ord, Show, Typeable)
4355
44−-- | Special case of tickLossyFrom that uses the post-build event to start the
45−-- tick thread.
56+-- | Fires an 'Event' once every time provided interval elapses, approximately.
57+-- The provided 'UTCTime' is used bootstrap the determination of how much time has elapsed with each tick.
58+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread.
4659tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
4760tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
4861
49−-- | Send events over time with the given basis time and interval
50−-- If the system starts running behind, occurrences will be dropped rather than buffered
51−-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the basis time
62+-- | Fires an 'Event' once every time provided interval elapses, approximately.
63+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread and the time of the post-build as the tick basis time.
64+tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
65+tickLossyFromPostBuildTime dt = do
66+ postBuild <- getPostBuild
67+ postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
68+ tickLossyFrom' $ (dt,) <$> postBuildTime
69+
70+-- | Fires an 'Event' approximately each time the provided interval elapses. If the system starts running behind, occurrences will be dropped rather than buffered.
71+-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the provided initial time.
5272tickLossyFrom
5373 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
5474 => NominalDiffTime
75+ -- ^ The length of a tick interval
5576 -> UTCTime
77+ -- ^ The basis time from which intervals count and with which the initial calculation of elapsed time will be made.
5678 -> Event t a
5779 -- ^ Event that starts a tick generation thread. Usually you want this to
5880 -- be something like the result of getPostBuild that only fires once. But
@@ -60,12 +82,12 @@ tickLossyFrom
6082 -> m (Event t TickInfo)
6183tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
6284
63−-- | 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'.
6486tickLossyFrom'
6587 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
6688 => Event t (NominalDiffTime, UTCTime)
6789 -- ^ Event that starts a tick generation thread. Usually you want this to
68− -- 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
6991 -- there could be uses for starting multiple timer threads.
7092 -> m (Event t TickInfo)
7193tickLossyFrom' e = do
@@ -76,12 +98,16 @@ tickLossyFrom' e = do
7698 Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
7799 cb (tick, pair)
78100
101+-- | Like 'tickLossy', but immediately calculates the first tick and provides a 'Dynamic' that is updated as ticks fire.
79102clockLossy :: (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)
80103clockLossy dt t0 = do
81104 initial <- liftIO $ getCurrentTick dt t0
82105 e <- tickLossy dt t0
83106 holdDyn initial e
84107
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.
85111getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
86112getCurrentTick dt t0 = do
87113 t <- getCurrentTime
@@ -96,7 +122,7 @@ delay dt e = performEventAsync $ ffor e $ \a cb -> liftIO $ void $ forkIO $ do
96122 cb a
97123
98124-- | Send events with Poisson timing with the given basis and rate
99−-- Each occurence of the resulting event will contain the index of
125+-- Each occurrence of the resulting event will contain the index of
100126-- the current interval, with 0 representing the basis time
101127poissonLossyFrom
102128 :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
@@ -115,7 +141,7 @@ poissonLossyFrom rnd rate = inhomogeneousPoissonFrom rnd (constant rate) rate
115141
116142
117143-- | Send events with Poisson timing with the given basis and rate
118−-- Each occurence of the resulting event will contain the index of
144+-- Each occurrence of the resulting event will contain the index of
119145-- the current interval, with 0 representing the basis time.
120146-- Automatically begin sending events when the DOM is built
121147poissonLossy
@@ -222,6 +248,125 @@ batchOccurrences t newValues = do
222248 delayed <- delay t toDelay
223249 return $ tag buffer delayed
224250
251+-- | Throttle an input event, ensuring that at least a given amount of time passes between occurrences of the output event. If the input event occurs too
252+-- frequently, the output event occurs with the most recently seen input value after the given delay passes since the last occurrence of the output.
253+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
254+throttle :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
255+throttle t e = do
256+ let f (immediate, buffer) x = case x of -- (Just newState, out)
257+ This a -- If only the input event fires
258+ | immediate -> -- and we're in immediate mode
259+ -- Immediate mode turns off, and the buffer is empty.
260+ -- We fire the output event with the input event value immediately.
261+ (Just (False, Nothing), Just a)
262+ | otherwise -> -- and we're not in immediate mode
263+ -- Immediate mode remains off, and we replace the contents of the buffer (if any) with the input value.
264+ -- We don't fire the output event.
265+ (Just (False, Just a), Nothing)
266+ That _ -> -- If only the delayed output event fires,
267+ case buffer of
268+ Nothing -> -- and the buffer is empty:
269+ -- Immediate mode turns back on, and the buffer remains empty.
270+ -- We don't fire.
271+ (Just (True, Nothing), Nothing)
272+ Just b -> -- and the buffer is full:
273+ -- Immediate mode remains off, and the buffer is cleared.
274+ -- We fire with the buffered value.
275+ (Just (False, Nothing), Just b)
276+ These a _ -> -- If both the input and delayed output event fire simultaneously:
277+ -- Immediate mode turns off, and the buffer is empty.
278+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
279+ (Just (False, Nothing), Just a)
280+ rec (_, outE) <- mapAccumMaybeDyn f (True, Nothing) $ align e delayed -- We start in immediate mode with an empty buffer.
281+ delayed <- delay t outE
282+ return outE
283+
284+data ThrottleState b
285+ = ThrottleState_Immediate
286+ | ThrottleState_Buffered (ThrottleBuffer b)
287+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
288+
289+data ThrottleBuffer b
290+ = ThrottleBuffer_Empty -- Empty conflicts with lens, and hiding it would require turning
291+ -- on PatternSynonyms
292+ | ThrottleBuffer_Full b
293+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
294+
295+instance Semigroup b => Semigroup (ThrottleBuffer b) where
296+ x <> y = case x of
297+ ThrottleBuffer_Empty -> y
298+ ThrottleBuffer_Full b1 -> case y of
299+ ThrottleBuffer_Empty -> x
300+ ThrottleBuffer_Full b2 -> ThrottleBuffer_Full $ b1 <> b2
301+ {-# INLINE (<>) #-}
302+
303+instance Semigroup b => Monoid (ThrottleBuffer b) where
304+ mempty = ThrottleBuffer_Empty
305+ {-# INLINE mempty #-}
306+ mappend = (<>)
307+ {-# INLINE mappend #-}
308+
309+-- | Throttle an input event, ensuring that the output event doesn't occur more often than you are ready for it. If the input event occurs too
310+-- frequently, the output event will contain semigroup-based summaries of the input firings that happened since the last output firing.
311+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
312+-- The first parameter is a function that receives access to the output event, and should construct an event that fires when the receiver is
313+-- ready for more input. For example, using @delay 20@ would give a simple time-based throttle.
314+--
315+-- NB: The provided lag function must *actually* delay the event.
316+throttleBatchWithLag :: (MonadFix m, MonadHold t m, PerformEvent t m, Semigroup a) => (Event t () -> m (Event t ())) -> Event t a -> m (Event t a)
317+-- Invariants:
318+-- * Immediate mode must turn off whenever output is produced.
319+-- * Output must be produced whenever immediate mode turns from on to off.
320+-- * Immediate mode can only go from off to on when the delayed event fires.
321+-- * Every input firing must go into either an immediate output firing or the
322+-- buffer, but not both.
323+-- * An existing full buffer must either stay in the buffer or go to output,
324+-- but not both.
325+throttleBatchWithLag lag e = do
326+ let f state x = case x of -- (Just $ newState, out)
327+ This a -> -- If only the input event fires
328+ case state of
329+ ThrottleState_Immediate -> -- and we're in immediate mode
330+ -- Immediate mode turns off, and the buffer is empty.
331+ -- We fire the output event with the input event value immediately.
332+ (Just $ ThrottleState_Buffered $ ThrottleBuffer_Empty, Just a)
333+ ThrottleState_Buffered b -> -- and we're not in immediate mode
334+ -- Immediate mode remains off, and we accumulate the input value.
335+ -- We don't fire the output event.
336+ (Just $ ThrottleState_Buffered $ b <> ThrottleBuffer_Full a, Nothing)
337+ That _ -> -- If only the delayed output event fires,
338+ case state of
339+ ThrottleState_Immediate -> -- and we're in immediate mode
340+ -- Nothing happens.
341+ (Nothing, Nothing)
342+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
343+ -- Immediate mode turns back on, and the buffer remains empty.
344+ -- We don't fire.
345+ (Just ThrottleState_Immediate, Nothing)
346+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
347+ -- Immediate mode remains off, and the buffer is cleared.
348+ -- We fire with the buffered value.
349+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just b)
350+ These a _ -> -- If both the input and delayed output event fire simultaneously:
351+ case state of
352+ ThrottleState_Immediate -> -- and we're in immediate mode
353+ -- Immediate mode turns off, and the buffer is empty.
354+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
355+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
356+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
357+ -- Immediate mode stays off, and the buffer remains empty.
358+ -- We fire with the input event's value.
359+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
360+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
361+ -- Immediate mode remains off, and the buffer is cleared.
362+ -- We fire with everything including the buffered value.
363+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just (b <> a))
364+ rec (_stateDyn, outE) <- mapAccumMaybeDyn f
365+ ThrottleState_Immediate -- We start in immediate mode with an empty buffer.
366+ (align e delayed)
367+ delayed <- lag (void outE)
368+ return outE
369+
225370#ifdef USE_TEMPLATE_HASKELL
226371makeLensesWith (lensRules & simpleLenses .~ True) ''TickInfo
227372#else
@@ -237,4 +382,3 @@ tickInfo_alreadyElapsed :: Lens' TickInfo NominalDiffTime
237382tickInfo_alreadyElapsed f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 x2 y) <$> f x3
238383{-# INLINE tickInfo_alreadyElapsed #-}
239384#endif
240−
src/Reflex/TriggerEvent/Base.hs+5−1
@@ -22,8 +22,10 @@ import Control.Monad.Ref
2222import Data.Coerce
2323import Data.Dependent.Sum
2424import Data.IORef
25+import Data.Monoid ((<>))
2526import qualified Data.Semigroup as S
2627import Reflex.Class
28+import Reflex.Adjustable.Class
2729import Reflex.Host.Class
2830import Reflex.PerformEvent.Class
2931import Reflex.PostBuild.Class
@@ -120,6 +122,8 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
120122 buildDynamic a0 = lift . buildDynamic a0
121123 {-# INLINABLE headE #-}
122124 headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
123127
124128instance Adjustable t m => Adjustable t (TriggerEventT t m) where
125129 {-# INLINABLE runWithReplace #-}
@@ -134,7 +138,7 @@ instance Adjustable t m => Adjustable t (TriggerEventT t m) where
134138-- TODO: Monoid and Semigroup can likely be derived once ReaderT has them.
135139instance (Monoid a, Applicative m) => Monoid (TriggerEventT t m a) where
136140 mempty = pure mempty
137− mappend = liftA2 mappend
141+ mappend = (<>)
138142
139143instance (S.Semigroup a, Applicative m) => S.Semigroup (TriggerEventT t m a) where
140144 (<>) = liftA2 (S.<>)
src/Reflex/TriggerEvent/Class.hs+6−1
@@ -2,7 +2,6 @@
22-- new 'Event's that can be triggered from 'IO'.
33{-# LANGUAGE FlexibleInstances #-}
44{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
65{-# LANGUAGE UndecidableInstances #-}
76module Reflex.TriggerEvent.Class
87 ( TriggerEvent (..)
@@ -13,6 +12,7 @@ import Reflex.Class
1312import Control.Monad.Reader
1413import Control.Monad.State
1514import qualified Control.Monad.State.Strict as Strict
15+import Control.Monad.Trans.Maybe (MaybeT)
1616
1717--TODO: Shouldn't have IO hard-coded
1818-- | 'TriggerEvent' represents actions that can create 'Event's that can be
@@ -48,3 +48,8 @@ instance TriggerEvent t m => TriggerEvent t (Strict.StateT s m) where
4848 newTriggerEvent = lift newTriggerEvent
4949 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
5050 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
51+
52+instance TriggerEvent t m => TriggerEvent t (MaybeT m) where
53+ newTriggerEvent = lift newTriggerEvent
54+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
55+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
src/Reflex/Widget/Basic.hs+3−1
@@ -10,8 +10,10 @@ module Reflex.Widget.Basic where
1010
1111import Control.Monad.Fix (MonadFix)
1212import Data.Map (Map)
13+
1314import Reflex.Class
14−import Reflex.Patch.MapWithMove
15+import Reflex.Adjustable.Class
16+import Data.Patch.MapWithMove
1517
1618
1719-- | Build sortable content in such a way that re-sorting it can cause minimal
src/Reflex/Workflow.hs+14−28
@@ -1,64 +1,50 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
21{-# LANGUAGE RecursiveDo #-}
32{-# 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."
410module Reflex.Workflow (
5− -- * Workflows
611 Workflow (..)
712 , workflow
813 , workflowView
914 , mapWorkflow
1015 , mapWorkflowCheap
11− -- * Better workflows
12− , W (..)
13− , runW
14− , prompt
1516 ) where
1617
1718import Control.Arrow ((***))
1819import Control.Monad.Fix (MonadFix)
19−import Control.Monad.Free.Church
20−import Data.Functor.Compose
2120
2221import Reflex.Class
22+import Reflex.Adjustable.Class
2323import Reflex.Network
2424import Reflex.NotReady.Class
2525import Reflex.PostBuild.Class
2626
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.
2729newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
2830
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).
2932workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
3033workflow w0 = do
3134 rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
3235 return $ fmap fst eResult
3336
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'.
3438workflowView :: 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)
3539workflowView w0 = do
3640 rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
3741 eReplace <- fmap switch $ hold never $ fmap snd eResult
3842 return $ fmap fst eResult
3943
44+-- | Map a function over a 'Workflow', possibly changing the return type.
4045mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
4146mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
4247
48+-- | Map a "cheap" function over a 'Workflow'. Refer to the documentation for 'pushCheap' for more information and performance considerations.
4349mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
4450mapWorkflowCheap f (Workflow x) = Workflow (fmap (f *** fmapCheap (mapWorkflowCheap f)) x)
45−
46−--------------------------------------------------------------------------------
47−-- Workflow monad
48−--------------------------------------------------------------------------------
49−
50−type WInternal t m = F (Compose m (Event t))
51−newtype W t m a = W { unW :: WInternal t m a } deriving (Functor, Applicative, Monad)
52−
53−runW :: forall t m a. (Adjustable t m, MonadHold t m, MonadFix m, PostBuild t m) => W t m a -> m (Event t a)
54−runW (W w0) = do
55− let go :: WInternal t m a -> m (Event t (WInternal t m a))
56− go w = runF w
57− (\l -> (return l <$) <$> getPostBuild) --TODO: Can this just be blank?
58− (\(Compose r) -> fmap (fmapCheap (wrap . Compose)) r)
59− rec (next0, built) <- runWithReplace (go w0) $ go <$> next
60− next <- switch <$> hold next0 built
61− return $ fmapMaybe (\w -> runF w Just (const Nothing)) next
62−
63−prompt :: (Reflex t, Functor m) => m (Event t a) -> W t m a
64−prompt = W . wrap . fmap return . Compose
stylizenew file+4
@@ -0,0 +1,4 @@
1+#!/usr/bin/env bash
2+set -euo pipefail
3+
4+for x in **/*.hs ; do stylish-haskell -i "$x" ; done
test/Adjustable.hsnew file+62
@@ -0,0 +1,62 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE RecursiveDo #-}
5+
6+module Main where
7+
8+import Control.Monad.Fix
9+import Data.Maybe
10+import qualified Data.Map as Map
11+
12+import Reflex
13+import Reflex.EventWriter.Base
14+import Reflex.Network
15+import Reflex.Patch.MapWithMove
16+import Test.Run
17+
18+main :: IO ()
19+main = do
20+ let actions = [ Increment, Update0th, Increment, Swap, Increment, Increment ]
21+ os <- runAppB testPatchMapWithMove $ map Just actions
22+ -- If the final counter value in the adjusted widgets corresponds to the number of times it has
23+ -- been incremented, we know that the networks haven't broken.
24+ let expectedCount = length $ ffilter (== Increment) actions
25+ -- let !True = last (last os) == [expectedCount,expectedCount] -- TODO re-enable this test after issue #369 has been resolved
26+ return ()
27+
28+data PatchMapTestAction
29+ = Increment
30+ | Swap
31+ | Update0th
32+ deriving Eq
33+
34+-- See https://github.com/reflex-frp/reflex/issues/369 for the bug that this is testing.
35+testPatchMapWithMove
36+ :: forall t m
37+ . ( Reflex t
38+ , Adjustable t m
39+ , MonadHold t m
40+ , MonadFix m
41+ )
42+ => Event t PatchMapTestAction
43+ -> m (Behavior t [Int])
44+testPatchMapWithMove pulse = do
45+ let pulseAction = ffor pulse $ \case
46+ Increment -> Nothing
47+ Swap -> patchMapWithMove $ Map.fromList
48+ [ (0, NodeInfo (From_Move 1) (Just 1))
49+ , (1, NodeInfo (From_Move 0) (Just 0))
50+ ]
51+ Update0th -> patchMapWithMove $ Map.fromList
52+ [ (0, NodeInfo (From_Insert 'z') Nothing) ]
53+ (_, result) <- runBehaviorWriterT $ mdo
54+ counter <- foldDyn (+) 1 $ fmapMaybe (\e -> if isNothing e then Just 1 else Nothing) pulseAction
55+ _ <- mapMapWithAdjustWithMove
56+ (\_ _ -> networkHold
57+ (tellBehavior $ constant [])
58+ ((\t -> tellBehavior $ constant [t]) <$> updated counter))
59+ (Map.fromList $ zip [0..] "ab")
60+ (fmapMaybe id pulseAction)
61+ return ()
62+ return result
test/DebugCycles.hsnew file+171
@@ -0,0 +1,171 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE PatternSynonyms #-}
8+{-# LANGUAGE RankNTypes #-}
9+
10+module Main where
11+
12+import Data.Foldable
13+import Control.Lens
14+import Control.Applicative
15+import Control.Monad
16+import Control.Monad.Fix
17+import Control.Exception
18+import System.Timeout
19+import Data.Maybe (isJust)
20+import Data.Functor.Misc
21+import qualified Data.Map as Map
22+import Data.Map (Map)
23+import qualified Data.IntMap as IntMap
24+import Data.IntMap (IntMap)
25+import Data.These
26+import Data.Align
27+import Reflex
28+import Reflex.EventWriter.Base
29+import Test.Run
30+import Test.Hspec
31+import Reflex.Spider.Internal (EventLoopException)
32+import Data.Witherable (Filterable)
33+
34+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
35+import Data.These.Lens
36+#endif
37+
38+type Widget t m = (MonadHold t m, Reflex t, MonadFix m)
39+
40+connectDyn :: Widget t m => Event t () -> (Dynamic t a, Dynamic t a) -> m (Dynamic t a)
41+connectDyn e (d, d') = do
42+ dd <- holdDyn d (d' <$ e)
43+ return $ join dd
44+
45+dynLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
46+dynLoop (e1, e2) = do
47+ -- "heightBagRemove: Height 2 not present in bag HeightBag {_heightBag_size = 2, _heightBag_contents = fromList [(0,1)]}"
48+ rec
49+ d <- count e1
50+ d' <- connectDyn e2 (d, liftA2 (+) d d')
51+ return $ updated d'
52+
53+connectOnCoincidence :: Widget t m => Event t () -> Event t a -> m (Event t a)
54+connectOnCoincidence click e = do
55+ d <- holdDyn never (e <$ click)
56+ return $ coincidence (updated d)
57+
58+coincidenceLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
59+coincidenceLoop (e1, e2) = do
60+-- "heightBagRemove: Height 1 not present in bag HeightBag {_heightBag_size = 1, _heightBag_contents = fromList [(0,0)]}"
61+-- (simpler version of dynLoop)
62+ rec
63+ e' <- connectOnCoincidence e2 (updated d)
64+ d <- count (align e' e1)
65+ return $ updated d
66+
67+addHeight :: Reflex t => Event t a -> Event t a
68+addHeight e = leftmost [e4, e4] where
69+ e1 = leftmost [e, e]
70+ e2 = leftmost [e1, e1]
71+ e3 = leftmost [e2, e2]
72+ e4 = leftmost [e3, e3]
73+
74+-- Take an existing test and build it inside a
75+buildLoop :: Widget t m => (forall t m. Widget t m => (Event t Int, Event t ()) -> m (Event t Int)) -> (Event t Int, Event t ()) -> m (Event t Int)
76+buildLoop test (e1, e2) = switchHold never buildLoop
77+ where buildLoop = pushAlways (const $ test (e1, e2)) e2
78+
79+connectButtonPromptly :: Widget t m => Event t () -> Event t a -> m (Event t a)
80+connectButtonPromptly click e = do
81+ d <- holdDyn never (e <$ click)
82+ return (switchDyn d)
83+
84+connectButton :: Widget t m => Event t () -> Event t a -> m (Event t a)
85+connectButton click e = do
86+ d <- hold never (e <$ click)
87+ return (switch d)
88+
89+switchLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
90+switchLoop01 (e1, e2) = do
91+ rec
92+ e' <- connectButton e2 (updated d)
93+ d <- count (align e' e1)
94+ return $ updated d
95+
96+mergeLoop :: forall t m. (Adjustable t m, Widget t m) => (Event t Int, Event t ()) -> m (Event t Int)
97+mergeLoop (e1, e2) = do
98+ rec
99+ (_, e) <- runEventWriterT $
100+ runWithReplace w (leftmost [w <$ e1])
101+ return (sum <$> e)
102+ where
103+ w = do
104+ c <- count e1
105+ tellEvent (updated ((pure <$> c) :: Dynamic t [Int]))
106+
107+switchLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
108+switchLoop02 (e1, e2) = do
109+ rec
110+ e' <- connectButton e2 (updated d)
111+ d <- count (leftmost [e', e1])
112+ return $ updated d
113+
114+switchLoop03 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
115+switchLoop03 (e1, e2) = do
116+ rec
117+ e' <- connectButton e2 (addHeight $ updated d)
118+ d <- count (align e' e1)
119+ return $ updated d
120+
121+staticLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
122+staticLoop01 (e1, e2) = do
123+ rec
124+ d <- foldDyn (+) (0 :: Int) (1 <$ align e1 (updated d))
125+ return $ updated d
126+
127+staticLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
128+staticLoop02 (e1, e2) = do
129+ rec
130+ d <- foldDyn (+) (0 :: Int) (leftmost [e1, updated d])
131+ return $ updated d
132+
133+buildStaticLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
134+buildStaticLoop (e1, e2) = switchHold never buildLoop
135+ where buildLoop = pushAlways (const $ staticLoop01 (e1, e2)) e2
136+
137+splitThese :: Filterable f => f (These a b) -> (f a, f b)
138+splitThese f = (mapMaybe (preview here) f, mapMaybe (preview there) f)
139+
140+main :: IO ()
141+main = hspec $ do
142+ describe "DebugCycles" $ do
143+ it "throws EventLoopException on switchLoop01" $ do
144+ check switchLoop01
145+ it "throws EventLoopException on switchLoop02" $ do
146+ check switchLoop02
147+ it "throws EventLoopException on switchLoop03" $ do
148+ check switchLoop03
149+ it "throws EventLoopException on buildSwitchLoop" $ do
150+ check $ buildLoop switchLoop01
151+ xit "throws EventLoopException on mergeLoop" $ do
152+ check mergeLoop
153+ xit "throws EventLoopException on staticLoop01" $ do
154+ check staticLoop01
155+ xit "throws EventLoopException on staticLoop02" $ do
156+ check staticLoop02
157+ xit "throws EventLoopException on buildStaticLoop" $ do
158+ check buildStaticLoop
159+ xit "throws EventLoopException on coincidenceLoop" $ do
160+ check coincidenceLoop
161+ xit "throws EventLoopException on dynLoop" $ do
162+ check dynLoop
163+ xit "throws EventLoopException on buildCoincidenceLoop" $ do
164+ check $ buildLoop coincidenceLoop
165+ where
166+ milliseconds = (*1000)
167+ occs = [ This 1, This 2, That (), This 3, That (), This 1 ]
168+ check test = do
169+ let action = timeout (milliseconds 50) $ do
170+ runApp' (test . splitThese) (Just <$> occs)
171+ action `shouldThrow` (const True :: Selector EventLoopException)
test/EventWriterT.hs+95−5
@@ -1,12 +1,25 @@
1−{-# LANGUAGE FlexibleContexts, GADTs #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
27module Main where
38
49import Control.Lens
510import Control.Monad
11+import Control.Monad.Fix
12+import qualified Data.Dependent.Map as DMap
13+import Data.Functor.Misc
14+import qualified Data.Map as M
615import Data.These
716
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+
821import Reflex
9−import Reflex.EventWriter
22+import Reflex.EventWriter.Base
1023import Test.Run
1124
1225main :: IO ()
@@ -23,6 +36,15 @@ main = do
2336 , These () ()
2437 ]
2538 print os2
39+ os3@[[Nothing, Just [2]]] <- runApp' (unwrapApp testMoribundTellEvent) [Just ()]
40+ print os3
41+ os4@[[Nothing, Just [2]]] <- runApp' (unwrapApp testMoribundTellEventDMap) [Just ()]
42+ print os4
43+ os5@[[Nothing, Just [1, 2]]] <- runApp' (unwrapApp testLiveTellEventDMap) [Just ()]
44+ print os5
45+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
46+ print os6
47+ let ![[Nothing, Nothing]] = os6
2648 return ()
2749
2850unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
@@ -31,14 +53,82 @@ unwrapApp x appIn = do
3153 return e
3254
3355testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
34−testOrdering pulse = do
35− forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
36− return ()
56+testOrdering pulse = forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
3757
3858testSimultaneous :: (Reflex t, Adjustable t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
3959testSimultaneous pulse = do
4060 let e0 = fmapMaybe (^? here) pulse
4161 e1 = fmapMaybe (^? there) pulse
4262 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
63+
64+-- | Test that a widget telling and event which fires at the same time it has been replaced
65+-- doesn't count along with the new widget.
66+testMoribundTellEvent
67+ :: forall t m
68+ . ( Reflex t
69+ , Adjustable t m
70+ , MonadHold t m
71+ , MonadFix m
72+ )
73+ => Event t ()
74+ -> EventWriterT t [Int] m ()
75+testMoribundTellEvent pulse = do
76+ rec let tellIntOnReplace :: Int -> EventWriterT t [Int] m ()
77+ tellIntOnReplace x = tellEvent $ [x] <$ rwrFinished
78+ (_, rwrFinished) <- runWithReplace (tellIntOnReplace 1) $ tellIntOnReplace 2 <$ pulse
79+ return ()
80+
81+-- | The equivalent of 'testMoribundTellEvent' for 'traverseDMapWithKeyWithAdjust'.
82+testMoribundTellEventDMap
83+ :: forall t m
84+ . ( Reflex t
85+ , Adjustable t m
86+ , MonadHold t m
87+ , MonadFix m
88+ )
89+ => Event t ()
90+ -> EventWriterT t [Int] m ()
91+testMoribundTellEventDMap pulse = do
92+ rec let tellIntOnReplace :: Int -> EventWriterT t [Int] m ()
93+ tellIntOnReplace x = tellEvent $ [x] <$ rwrFinished
94+ (_, rwrFinished :: Event t (PatchDMap (Const2 () Int) Identity)) <-
95+ traverseDMapWithKeyWithAdjust
96+ (\(Const2 ()) (Identity v) -> Identity . const v <$> tellIntOnReplace v)
97+ (mapToDMap $ M.singleton () 1)
98+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton () 2) <$ pulse)
99+ return ()
100+
101+-- | Ensures that elements which are _not_ removed can still fire 'tellEvent's
102+-- during the same frame as other elements are updated.
103+testLiveTellEventDMap
104+ :: forall t m
105+ . ( Reflex t
106+ , Adjustable t m
107+ , MonadHold t m
108+ , MonadFix m
109+ )
110+ => Event t ()
111+ -> EventWriterT t [Int] m ()
112+testLiveTellEventDMap pulse = do
113+ rec let tellIntOnReplace :: Int -> EventWriterT t [Int] m ()
114+ tellIntOnReplace x = tellEvent $ [x] <$ rwrFinished
115+ (_, rwrFinished :: Event t (PatchDMap (Const2 Int ()) Identity)) <-
116+ traverseDMapWithKeyWithAdjust
117+ (\(Const2 k) (Identity ()) -> Identity <$> tellIntOnReplace k)
118+ (mapToDMap $ M.singleton 1 ())
119+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
43120 return ()
44121
122+delayedPulse
123+ :: forall t m
124+ . ( Reflex t
125+ , Adjustable t m
126+ , MonadHold t m
127+ , MonadFix m
128+ )
129+ => Event t ()
130+ -> EventWriterT t [Int] m ()
131+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
132+ -- This has the effect of delaying pulse' from pulse
133+ (_, pulse') <- runWithReplace (pure ()) $ pure [1] <$ pulse
134+ tellEvent pulse'
test/GC.hs+14−8
@@ -1,4 +1,9 @@
1−{-# LANGUAGE OverloadedStrings, FlexibleContexts, GADTs, TypeFamilies, RankNTypes, ScopedTypeVariables #-}
1+{-# LANGUAGE FlexibleContexts #-}
2+{-# LANGUAGE GADTs #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE TypeFamilies #-}
27module Main where
38
49import Control.Monad
@@ -13,15 +18,17 @@ import Data.GADT.Compare
1318import Data.IORef
1419import Data.Semigroup
1520import Data.These
21+import Data.Type.Equality ((:~:)(Refl))
1622
1723import Data.Functor.Misc
18−import Reflex.Patch
24+import Data.Patch
1925
20−import qualified Reflex.Spider.Internal as S
2126import qualified Reflex.Host.Class as Host
27+import qualified Reflex.Spider.Internal as S
2228
23−import System.Mem
2429import System.Exit
30+import System.Mem
31+import Data.Coerce
2532
2633main :: IO ()
2734main = do
@@ -41,7 +48,7 @@ hostPerf ref = S.runSpiderHost $ do
4148 eventToPerform <- Host.runHostFrame $ do
4249 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
4350 <- S.SpiderHostFrame
44− $ fmap ( S.merge
51+ $ fmap ( S.mergeG coerce
4552 . S.dynamicHold)
4653 $ S.hold DMap.empty
4754 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
@@ -50,8 +57,8 @@ hostPerf ref = S.runSpiderHost $ do
5057 { S.subscriberPropagate = S.subscriberPropagate sub
5158 }
5259 return (s, o))
53− $ runIdentity <$> S.select
54− (S.fan $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
60+ $ runIdentity . runIdentity <$> S.selectG
61+ (S.fanG $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
5562 (WrapArg Request)
5663 return $ alignWith (mergeThese (<>))
5764 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
@@ -77,7 +84,6 @@ hostPerf ref = S.runSpiderHost $ do
7784 Nothing -> []
7885 Host.fireEventsAndRead followupEventTriggers $ return ()
7986 return ()
80− return ()
8187
8288data Tell a where
8389 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+20−9
@@ -1,23 +1,30 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveFunctor #-}
23{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE TypeFamilies #-}
44{-# LANGUAGE GeneralizedNewtypeDeriving #-}
55{-# LANGUAGE LambdaCase #-}
66{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
710
811import Control.Lens
912import Control.Monad.Fix
1013import Data.Align
11−import Data.AppendMap (AppendMap)
1214import qualified Data.AppendMap as AMap
1315import Data.Functor.Misc
1416import Data.Map (Map)
1517import qualified Data.Map as Map
18+import Data.Map.Monoidal (MonoidalMap)
1619import Data.Semigroup
1720import Data.These
1821
22+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
23+import Data.These.Lens
24+#endif
25+
1926import Reflex
20−import Reflex.Patch.MapWithMove
27+import Data.Patch.MapWithMove
2128import Test.Run
2229
2330newtype MyQuery = MyQuery SelectedCount
@@ -27,14 +34,18 @@ instance Query MyQuery where
2734 type QueryResult MyQuery = ()
2835 crop _ _ = ()
2936
30−instance (Ord k, Query a, Eq (QueryResult a)) => Query (Selector k a) where
37+instance (Ord k, Query a, Eq (QueryResult a), Align (MonoidalMap k)) => Query (Selector k a) where
3138 type QueryResult (Selector k a) = Selector k (QueryResult a)
3239 crop q r = undefined
3340
34−newtype Selector k a = Selector { unSelector :: AppendMap k a }
41+newtype Selector k a = Selector { unSelector :: MonoidalMap k a }
3542 deriving (Show, Read, Eq, Ord, Functor)
3643
37−instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
44+#if !(MIN_VERSION_monoidal_containers(0,4,1))
45+deriving instance Ord k => Align (MonoidalMap k)
46+#endif
47+
48+instance (Ord k, Eq a, Monoid a, Align (MonoidalMap k)) => Semigroup (Selector k a) where
3849 (Selector a) <> (Selector b) = Selector $ fmapMaybe id $ f a b
3950 where
4051 f = alignWith $ \case
@@ -44,14 +55,14 @@ instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
4455 let z = x `mappend` y
4556 in if z == mempty then Nothing else Just z
4657
47−instance (Ord k, Eq a, Monoid a) => Monoid (Selector k a) where
58+instance (Ord k, Eq a, Monoid a, Align (MonoidalMap k)) => Monoid (Selector k a) where
4859 mempty = Selector AMap.empty
4960 mappend = (<>)
5061
51−instance (Eq a, Ord k, Group a) => Group (Selector k a) where
62+instance (Eq a, Ord k, Group a, Align (MonoidalMap k)) => Group (Selector k a) where
5263 negateG = fmap negateG
5364
54−instance (Eq a, Ord k, Group a) => Additive (Selector k a)
65+instance (Eq a, Ord k, Group a, Align (MonoidalMap k)) => Additive (Selector k a)
5566
5667main :: IO ()
5768main = do
test/Reflex/Bench/Focused.hs+13−1
@@ -130,6 +130,16 @@ mapDynChain = iterM (return . fmap (+1))
130130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
131131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
132132
133+holdDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134+holdDynChain = iterM (\d -> sample (current d) >>= flip holdDyn (updated d))
135+
136+buildDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
137+buildDynChain = iterM (\d -> do
138+ let b = fmap (+1) (current d)
139+ e = fmap (*2) (updated d)
140+ buildDynamic (sample b) e)
141+
142+
133143combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134144combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
135145
@@ -184,7 +194,7 @@ switchMergeBehaviors mapChanges = pull . joinMap <$> holdMap mapChanges
184194
185195-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
186196holdMapDyn :: (Reflex t, MonadHold t m, MonadFix m, Ord k) => UpdatedMap t k a -> m (Dynamic t (Map k a))
187−holdMapDyn (UpdatedMap initial changes) = foldDyn (flip (Map.foldWithKey modify)) initial changes
197+holdMapDyn (UpdatedMap initial changes) = foldDyn (flip (Map.foldrWithKey modify)) initial changes
188198
189199 where
190200 modify k Nothing items = Map.delete k items
@@ -308,6 +318,8 @@ dynamics :: Word -> [(String, TestCase)]
308318dynamics n =
309319 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
310320 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
321+ , testE "holdDynChain" $ fmap updated $ holdDynChain n =<< d
322+ , testE "buildDynChain" $ fmap updated $ buildDynChain n =<< d
311323 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
312324 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
313325 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
test/Reflex/Plan/Pure.hs+5−4
@@ -41,6 +41,7 @@ instance MonadHold (Pure Int) PurePlan where
4141 holdIncremental initial = liftPlan . holdIncremental initial
4242 buildDynamic getInitial = liftPlan . buildDynamic getInitial
4343 headE = liftPlan . headE
44+ now = liftPlan now
4445
4546instance MonadSample (Pure Int) PurePlan where
4647 sample = liftPlan . sample
@@ -55,15 +56,15 @@ instance TestPlan (Pure Int) PurePlan where
5556runPure :: PurePlan a -> (a, IntSet)
5657runPure (PurePlan p) = runStateT p mempty $ 0
5758
58−relavantTimes :: IntSet -> IntSet
59−relavantTimes occs = IntSet.fromList [0..l + 1]
59+relevantTimes :: IntSet -> IntSet
60+relevantTimes occs = IntSet.fromList [0..l + 1]
6061 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
6162
6263testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63−testBehavior (b, occs) = IntMap.fromSet (sample b) (relavantTimes occs)
64+testBehavior (b, occs) = IntMap.fromSet (sample b) (relevantTimes occs)
6465
6566testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66−testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relavantTimes occs)
67+testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relevantTimes occs)
6768
6869
6970
test/Reflex/Plan/Reflex.hs+2−2
@@ -74,13 +74,13 @@ deriving instance ReflexHost t => MonadFix (Plan t)
7474
7575
7676instance (ReflexHost t, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO) => TestPlan t (Plan t) where
77− plan occurances = Plan $ do
77+ plan occurrences = Plan $ do
7878 (e, ref) <- newEventWithTriggerRef
7979 modify (IntMap.unionWith mappend (firings ref))
8080 return e
8181
8282 where
83− firings ref = IntMap.fromList (makeFiring ref <$> occurances)
83+ firings ref = IntMap.fromList (makeFiring ref <$> occurrences)
8484 makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
8585
8686
test/Reflex/Test/CrossImpl.hs+24−15
@@ -12,7 +12,6 @@
1212{-# LANGUAGE TypeFamilies #-}
1313{-# LANGUAGE TypeOperators #-}
1414{-# LANGUAGE UndecidableInstances #-}
15−module Reflex.Test.CrossImpl (test) where
1615
1716import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
1817
@@ -20,27 +19,23 @@ import Control.Monad.Ref
2019import Reflex.Class
2120import Reflex.Dynamic
2221import Reflex.Host.Class
23−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
2422import qualified Reflex.Pure as P
2523import qualified Reflex.Spider.Internal as S
24+import qualified Reflex.Profiled as Prof
2625
2726import Control.Arrow (second, (&&&))
2827import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
2928import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
30−import Control.Monad.Writer hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
31−import Data.Dependent.Map (DMap, DSum (..))
32−import qualified Data.Dependent.Map as DMap
29+import Data.Dependent.Sum (DSum (..))
3330import Data.Foldable
34−import Data.Functor.Misc
3531import Data.Map.Strict (Map)
3632import qualified Data.Map.Strict as Map
3733import qualified Data.Set as Set
34+import Data.Monoid
3835import Data.Traversable
3936import System.Exit
4037import System.Mem
4138
42−import System.IO.Unsafe
43−
4439mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
4540mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
4641 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
@@ -77,11 +72,14 @@ instance MapMSignals (Event t a) (Event t' a) t t' where
7772instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
7873 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
7974
80−testSpider :: (forall m t. TestCaseConstraint t m => (Behavior t a, Event t b) -> m (Behavior t c, Event t d)) -> (Map Int a, Map Int b) -> (Map Int c, Map Int d)
81−testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
75+testTimeline
76+ :: (forall m t. TestCaseConstraint t m => (Behavior t a, Event t b) -> m (Behavior t c, Event t d))
77+ -> (Map Int a, Map Int b)
78+ -> (forall m t. (MonadReflexHost t m, MonadIO m, MonadRef m, Ref m ~ Ref IO, MonadSample t m) => m (Map Int c, Map Int d))
79+testTimeline builder (bMap, eMap) = do
8280 (re, reTrigger) <- newEventWithTriggerRef
8381 (rb, rbTrigger) <- newEventWithTriggerRef
84− b <- runHostFrame $ hold (error "testSpider: No value for input behavior yet") rb
82+ b <- runHostFrame $ hold (error "testTimeline: No value for input behavior yet") rb
8583 (b', e') <- runHostFrame $ builder (b, re)
8684 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
8785 let times = relevantTestingTimes (bMap, eMap)
@@ -106,9 +104,11 @@ testAgreement :: (Eq c, Eq d, Show c, Show d) => (forall m t. TestCaseConstraint
106104testAgreement builder inputs = do
107105 let identityResult = testPure builder inputs
108106 tracePerf "---------" $ return ()
109− let spiderResult = testSpider builder inputs
107+ spiderResult <- S.runSpiderHost $ testTimeline builder inputs
108+ tracePerf "---------" $ return ()
109+ profiledResult <- S.runSpiderHost $ Prof.runProfiledM $ testTimeline builder inputs
110110 tracePerf "---------" $ return ()
111− let resultsAgree = identityResult == spiderResult
111+ let resultsAgree = identityResult == spiderResult && identityResult == profiledResult
112112 if resultsAgree
113113 then do --putStrLn "Success:"
114114 --print identityResult
@@ -116,6 +116,7 @@ testAgreement builder inputs = do
116116 else do putStrLn "Failure:"
117117 putStrLn $ "Pure result: " <> show identityResult
118118 putStrLn $ "Spider result: " <> show spiderResult
119+ putStrLn $ "Profiled result: " <> show profiledResult
119120 return resultsAgree
120121
121122type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
@@ -222,6 +223,11 @@ testCases =
222223 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
223224 let b' = pull $ sample =<< sample bb
224225 return (b', e)
226+ , (,) "foldDynWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(_, e) -> do
227+ d <- foldDyn (:) [] $
228+ pushAlways (\a -> foldDyn (:) [a] e) e
229+ let b = current (join (fmap distributeListOverDynPure d))
230+ return (b, e)
225231 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
226232 bb <- hold "b" e
227233 bd <- hold never . fmap (const e) =<< headE e
@@ -233,6 +239,9 @@ testCases =
233239 rec result <- holdUniqDyn d
234240 d <- holdDyn (0 :: Int) e
235241 return (current result, updated result)
242+
243+
244+
236245 {-
237246 , (,) "mergeIncrementalWithMove" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, PatchDMapWithMove.moveDMapKey LeftTag RightTag), (2, mempty)]) $ \(b, e :: Event t (PatchDMapWithMove (EitherTag () ()) (Const2 () ()))) -> do
238247 x <- holdIncremental (DMap.singleton LeftTag $ void e) $ PatchDMapWithMove.mapPatchDMapWithMove (\(Const2 _) -> void e) <$> e
@@ -248,8 +257,8 @@ splitRecombineEvent e =
248257 in leftmost [ea, eb]
249258
250259
251−test :: IO ()
252−test = do
260+main :: IO ()
261+main = do
253262 results <- forM testCases $ \(name, TestCase inputs builder) -> do
254263 putStrLn $ "Test: " <> name
255264 testAgreement builder inputs
test/Reflex/Test/Micro.hs+71−4
@@ -3,6 +3,7 @@
33{-# LANGUAGE FlexibleContexts #-}
44{-# LANGUAGE FlexibleInstances #-}
55{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
67{-# LANGUAGE MultiParamTypeClasses #-}
78{-# LANGUAGE RankNTypes #-}
89{-# LANGUAGE RecursiveDo #-}
@@ -23,6 +24,24 @@ import Data.Monoid
2324
2425import Prelude
2526
27+pushDyn :: (Reflex t, MonadHold t m) => (a -> PushM t b) -> Dynamic t a -> m (Dynamic t b)
28+pushDyn f d = buildDynamic (sample (current d) >>= f) (pushAlways f (updated d))
29+
30+foldedDyn :: (Reflex t, MonadHold t m) => (a -> a -> a) -> Dynamic t a -> m (Dynamic t a)
31+foldedDyn f d = fmap join $ flip buildDynamic never $ do
32+ a <- sample (current d)
33+ foldDyn f a (updated d)
34+
35+scannedDyn :: (Reflex t, MonadHold t m) => Dynamic t a -> m (Dynamic t [a])
36+scannedDyn = fmap (fmap reverse) . foldedDyn (<>) . fmap pure
37+
38+scanInnerDyns :: (Reflex t, MonadHold t m) => Dynamic t (Dynamic t a) -> m (Dynamic t [a])
39+scanInnerDyns d = do
40+ scans <- scannedDyn d
41+ return (join (fmap distributeListOverDynPure scans))
42+
43+
44+
2645{-# ANN testCases "HLint: ignore Functor law" #-}
2746testCases :: [(String, TestCase)]
2847testCases =
@@ -201,6 +220,14 @@ testCases =
201220 bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
202221 return $ pull $ sample =<< sample bb
203222
223+
224+ , testB "foldDynWhileFiring" $ do
225+ e <- events1
226+ d <- foldDyn (:) [] $
227+ pushAlways (\a -> foldDyn (:) [a] e) e
228+
229+ return $ current (join (fmap distributeListOverDynPure d))
230+
204231 , testE "joinDyn" $ do
205232 e <- events1
206233 bb <- hold "b" e
@@ -223,6 +250,38 @@ testCases =
223250 d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
224251
225252 return $ current $ zipDynWith (<>) d1 d2
253+
254+ , testB "buildDynamicStrictness" $ do
255+ rec
256+ d'' <- pushDyn return d'
257+ d' <- pushDyn return d
258+ d <- holdDyn "0" =<< events1
259+
260+ _ <- sample (current d'')
261+ return (current d'')
262+
263+ , testB "factorDyn" $ do
264+ d <- holdDyn (Left "a") =<< eithers
265+
266+ eithers' <- eitherDyn d
267+ let unFactor = either id id
268+ return $ current (join (fmap unFactor eithers'))
269+
270+ , testB "pushDynDeep" $ do
271+ _ <- events1
272+ _ <- events2
273+
274+ d1 <- holdDyn "d1" =<< events1
275+ d2 <- holdDyn "d2" =<< events2
276+
277+ d <- flip pushDyn d1 $ \a ->
278+ flip pushDyn d2 $ \b ->
279+ flip pushDyn d1 $ \c ->
280+ return (a <> b <> c)
281+
282+ d' <- pushDyn scanInnerDyns d >>= scanInnerDyns
283+ return $ current d'
284+
226285 , testE "fan-1" $ do
227286 e <- fmap toMap <$> events1
228287 let es = select (fanMap e) . Const2 <$> values
@@ -263,15 +322,25 @@ testCases =
263322 let e = never <$ switch b
264323 return $ void e
265324 lazyHold
266−
325+ , testE "now-1" $ do
326+ e1 <- events1
327+ switchHoldPromptly never . pushAlways (\a -> fmap (a <$) now) $ e1
328+ , testE "now-2" $ do
329+ e1 <- events1
330+ let e = pushAlways (\a -> if a == "a" then now else return never) e1
331+ x <- accumDyn (<>) never e
332+ return . coincidence $ updated x
267333 ] where
268334
269335 events1, events2, events3 :: TestPlan t m => m (Event t String)
270336 events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
271337 events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
272−
273338 events3 = liftA2 mappend events1 events2
274339
340+ eithers :: TestPlan t m => m (Event t (Either String String))
341+ eithers = plan [(1, Left "e"), (3, Left "d"), (4, Right "c"), (6, Right "b"), (7, Left "a")]
342+
343+
275344 values = "abcde"
276345 toMap str = Map.fromList $ map (\c -> (c, c)) str
277346
@@ -281,5 +350,3 @@ testCases =
281350
282351 deep e = leftmost [e, e]
283352 leftmost2 e1 e2 = leftmost [e1, e2]
284−
285−
test/Reflex/TestPlan.hs+2−2
@@ -26,8 +26,8 @@ import Reflex.Class
2626import Prelude
2727
2828class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
29− -- | Speicify a plan of an input Event firing
30− -- Occurances must be in the future (i.e. Time > 0)
29+ -- | Specify a plan of an input Event firing
30+ -- Occurrences must be in the future (i.e. Time > 0)
3131 -- Initial specification is
3232
3333 plan :: [(Word, a)] -> m (Event t a)
test/RequesterT.hs+184−14
@@ -1,11 +1,40 @@
1−{-# LANGUAGE FlexibleContexts, GADTs, RankNTypes, ScopedTypeVariables #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE LambdaCase #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE RecursiveDo #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeApplications #-}
12+{-# LANGUAGE TypeFamilies #-}
213module Main where
314
4−import Control.Lens
15+import Control.Lens hiding (has)
516import 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
622import qualified Data.Dependent.Map as DMap
723import 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)
832import 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
938
1039import Reflex
1140import Reflex.Requester.Base
@@ -17,18 +46,38 @@ data RequestInt a where
1746
1847main :: IO ()
1948main = do
20− os1@[[Just [10,9,8,7,6,5,4,3,2,1]]] <- runApp' (unwrapApp testOrdering) $
49+ os1 <- runApp' (unwrapApp testOrdering) $
2150 [ Just ()
2251 ]
2352 print os1
24− os2@[[Just [1,3,5,7,9]],[Nothing,Nothing],[Just [2,4,6,8,10]],[Just [2,4,6,8,10],Nothing]]
25− <- runApp' (unwrapApp testSimultaneous) $ map Just $
26− [ This ()
27− , That ()
28− , This ()
29− , These () ()
30− ]
53+ os2 <- runApp' (unwrapApp testSimultaneous) $ map Just $
54+ [ This ()
55+ , That ()
56+ , This ()
57+ , These () ()
58+ ]
3159 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+
3281 return ()
3382
3483unwrapRequest :: DSum tag RequestInt -> Int
@@ -40,7 +89,7 @@ unwrapApp :: ( Reflex t, Monad m )
4089 -> m (Event t [Int])
4190unwrapApp x appIn = do
4291 ((), e) <- runRequesterT (x appIn) never
43− return $ fmap (map unwrapRequest . DMap.toList) e
92+ return $ fmap (map unwrapRequest . requesterDataToList) e
4493
4594testOrdering :: ( Response m ~ Identity
4695 , Request m ~ RequestInt
@@ -48,9 +97,8 @@ testOrdering :: ( Response m ~ Identity
4897 , Adjustable t m)
4998 => Event t ()
5099 -> m ()
51−testOrdering pulse = do
52− forM_ [10,9..1] $ \i -> requestingIdentity (RequestInt i <$ pulse)
53− return ()
100+testOrdering pulse = forM_ [10,9..1] $ \i ->
101+ requestingIdentity (RequestInt i <$ pulse)
54102
55103testSimultaneous :: ( Response m ~ Identity
56104 , Request m ~ RequestInt
@@ -63,3 +111,125 @@ testSimultaneous pulse = do
63111 switchE = fmapMaybe (^? there) pulse
64112 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
65113 requestingIdentity (RequestInt (i+1) <$ tellE)
114+
115+-- | Test that a widget requesting and event which fires at the same time it has been replaced
116+-- doesn't count along with the new widget.
117+testMoribundRequest
118+ :: forall t m
119+ . ( Reflex t
120+ , Adjustable t m
121+ , MonadHold t m
122+ , MonadFix m
123+ , Response m ~ Identity
124+ , Request m ~ RequestInt
125+ , Requester t m
126+ )
127+ => Event t ()
128+ -> m ()
129+testMoribundRequest pulse = do
130+ rec let requestIntOnReplace x = requestingIdentity $ RequestInt x <$ rwrFinished
131+ (_, rwrFinished) <- runWithReplace (requestIntOnReplace 1) $ requestIntOnReplace 2 <$ pulse
132+ return ()
133+
134+-- | The equivalent of 'testMoribundRequest' for 'traverseDMapWithKeyWithAdjust'.
135+testMoribundRequestDMap
136+ :: forall t m
137+ . ( Reflex t
138+ , Adjustable t m
139+ , MonadHold t m
140+ , MonadFix m
141+ , Response m ~ Identity
142+ , Request m ~ RequestInt
143+ , Requester t m
144+ )
145+ => Event t ()
146+ -> m ()
147+testMoribundRequestDMap pulse = do
148+ rec let requestIntOnReplace :: Int -> m ()
149+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
150+ (_, rwrFinished :: Event t (PatchDMap (Const2 () Int) Identity)) <-
151+ traverseDMapWithKeyWithAdjust
152+ (\(Const2 ()) (Identity v) -> Identity . const v <$> requestIntOnReplace v)
153+ (mapToDMap $ M.singleton () 1)
154+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton () 2) <$ pulse)
155+ return ()
156+
157+-- | Ensures that elements which are _not_ removed can still fire requests
158+-- during the same frame as other elements are updated.
159+testLiveRequestDMap
160+ :: forall t m
161+ . ( Reflex t
162+ , Adjustable t m
163+ , MonadHold t m
164+ , MonadFix m
165+ , Response m ~ Identity
166+ , Request m ~ RequestInt
167+ , Requester t m
168+ )
169+ => Event t ()
170+ -> m ()
171+testLiveRequestDMap pulse = do
172+ rec let requestIntOnReplace :: Int -> m ()
173+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
174+ (_, rwrFinished :: Event t (PatchDMap (Const2 Int ()) Identity)) <-
175+ traverseDMapWithKeyWithAdjust
176+ (\(Const2 k) (Identity ()) -> Identity <$> requestIntOnReplace k)
177+ (mapToDMap $ M.singleton 1 ())
178+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
179+ return ()
180+
181+delayedPulse
182+ :: forall t m
183+ . ( Reflex t
184+ , Adjustable t m
185+ , MonadHold t m
186+ , MonadFix m
187+ , Response m ~ Identity
188+ , Request m ~ RequestInt
189+ , PerformEvent t m
190+ , Requester t m
191+ )
192+ => Event t ()
193+ -> m ()
194+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
195+ -- This has the effect of delaying pulse' from pulse
196+ (_, pulse') <- runWithReplace (pure ()) $ pure (RequestInt 1) <$ pulse
197+ requestingIdentity pulse'
198+
199+data TestRequest a where
200+ TestRequest_Reverse :: String -> TestRequest String
201+ TestRequest_Increment :: Int -> TestRequest Int
202+
203+testMatchRequestsWithResponses
204+ :: forall m t req a
205+ . ( MonadFix m
206+ , MonadHold t m
207+ , Reflex t
208+ , PerformEvent t m
209+ , MonadIO (Performable m)
210+ , ForallF Show req
211+ , Has Read req
212+ )
213+ => Event t (req a) -> m (Event t (Map Int String))
214+testMatchRequestsWithResponses pulse = mdo
215+ (_, requests) <- runRequesterT (requesting pulse) responses
216+ let rawResponses = M.map (\v ->
217+ case words v of
218+ ["reverse", str] -> reverse str
219+ ["increment", i] -> show $ succ $ (read i :: Int)
220+ ) <$> rawRequestMap
221+ (rawRequestMap, responses) <- matchResponsesWithRequests reqEncoder requests (head . M.toList <$> rawResponses)
222+ pure rawResponses
223+ where
224+ reqEncoder :: forall a. req a -> (String, String -> Maybe a)
225+ reqEncoder r =
226+ ( whichever @Show @req @a $ show r
227+ , \x -> has @Read r $ readMaybe x
228+ )
229+
230+deriveArgDict ''TestRequest
231+
232+instance Show (TestRequest a) where
233+ show = \case
234+ TestRequest_Reverse str -> "reverse " <> str
235+ TestRequest_Increment i -> "increment " <> show i
test/Test/Run.hs+8
@@ -64,3 +64,11 @@ runApp' :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
6464runApp' app input = do
6565 let app' = fmap (AppOut (pure ())) . app
6666 map (map snd) <$> runApp (app' . _appIn_event) () (map (fmap That) input)
67+
68+runAppB :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
69+ => (Event t eIn -> PerformEventT t m (Behavior t bOut))
70+ -> [Maybe eIn]
71+ -> IO [[bOut]]
72+runAppB app input = do
73+ let app' = fmap (flip AppOut never) . app
74+ map (map fst) <$> runApp (app' . _appIn_event) () (map (fmap That) input)
test/hlint.hs+6−10
@@ -1,11 +1,11 @@
11module Main where
22
33import Control.Monad
4−import Language.Haskell.HLint3 (hlint)
4+import Language.Haskell.HLint (hlint)
55import System.Directory
66import System.Exit (exitFailure, exitSuccess)
7−import System.FilePath.Find
87import System.FilePath
8+import System.FilePath.Find
99
1010main :: IO ()
1111main = do
@@ -20,7 +20,10 @@ main = do
2020 , "--ignore=Use >=>"
2121 , "--ignore=Use ."
2222 , "--ignore=Use unless"
23+ , "--ignore=Reduce duplication"
2324 , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--cpp-define=DEBUG"
26+ , "--ignore=Use tuple-section"
2427 ]
2528 recurseInto = and <$> sequence
2629 [ fileType ==? Directory
@@ -28,16 +31,9 @@ main = do
2831 ]
2932 matchFile = and <$> sequence
3033 [ extension ==? ".hs"
31− , let notElem' = liftOp notElem
32− in filePath `notElem'` filePathExceptions pwd
3334 ]
34− files <- find recurseInto matchFile pwd
35+ files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
3536 ideas <- fmap concat $ forM files $ \f -> do
3637 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
3738 runHlint f
3839 if null ideas then exitSuccess else exitFailure
39−
40−filePathExceptions :: FilePath -> [FilePath]
41−filePathExceptions pwd = map (pwd </>) $
42− [ "src/Data/AppendMap.hs" -- parse error when hlint runs
43− ]
test/rootCleanup.hs+3−3
@@ -1,10 +1,10 @@
1−import Control.Monad
21import Control.Concurrent
2+import Control.Monad
3+import Data.IORef
34import Reflex
45import Reflex.Host.Class
5−import System.Mem
6−import Data.IORef
76import System.Exit
7+import System.Mem
88
99main :: IO ()
1010main = do
test/semantics.hs−2
@@ -45,5 +45,3 @@ main = do
4545 ]
4646
4747 makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
48−
49−