on develop help sign in
89 files changed+6347−3694
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+41 .stylish-haskell.yaml+2−3 .travis.yml−15 CONTRIBUTING.md+66 ChangeLog.md+151 Quickref.md+143−11 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−34 dep/reflex-platform/default.nix+7 dep/reflex-platform/github.json+7 reflex.cabal+280−83 release.nix+58 src/Control/Monad/ReaderIO.hs+60 src/Data/AppendMap.hs+58−382 src/Data/FastMutableIntMap.hs+26−29 src/Data/FastWeakBag.hs+26−22 src/Data/Functor/Misc.hs−345 src/Data/Map/Misc.hs+71 src/Data/WeakBag.hs+14−12 src/Reflex.hs+10−2 src/Reflex/Adjustable/Class.hs+140 src/Reflex/BehaviorWriter/Base.hs+211 src/Reflex/BehaviorWriter/Class.hs+31 src/Reflex/Class.hs+789−339 src/Reflex/Collection.hs+225 src/Reflex/Dynamic.hs+92−234 src/Reflex/Dynamic/TH.hs+4−28 src/Reflex/Dynamic/Uniq.hs+1−1 src/Reflex/DynamicWriter.hs+4−189 src/Reflex/DynamicWriter/Base.hs+246 src/Reflex/DynamicWriter/Class.hs+28 src/Reflex/EventWriter.hs+4−266 src/Reflex/EventWriter/Base.hs+317 src/Reflex/EventWriter/Class.hs+26 src/Reflex/FastWeak.hs+83−16 src/Reflex/FunctorMaybe.hs+34−16 src/Reflex/Host/Class.hs+6−26 src/Reflex/Host/Headless.hs+128 src/Reflex/Network.hs+45 src/Reflex/NotReady/Class.hs+77 src/Reflex/Optimizer.hs+13−4 src/Reflex/Patch.hs−33 src/Reflex/Patch/Class.hs−20 src/Reflex/Patch/DMap.hs−61 src/Reflex/Patch/DMapWithMove.hs−281 src/Reflex/Patch/Map.hs−52 src/Reflex/Patch/MapWithMove.hs−159 src/Reflex/PerformEvent/Base.hs+9−4 src/Reflex/PerformEvent/Class.hs+6−2 src/Reflex/PostBuild/Base.hs+15−3 src/Reflex/PostBuild/Class.hs−2 src/Reflex/Profiled.hs+99−23 src/Reflex/Pure.hs+38−27 src/Reflex/Query/Base.hs+122−51 src/Reflex/Query/Class.hs+92−11 src/Reflex/Requester/Base.hs+215−27 src/Reflex/Requester/Class.hs−1 src/Reflex/Spider.hs+5−7 src/Reflex/Spider/Internal.hs+977−506 src/Reflex/Spider/SpiderTimeline.include.hs−155 src/Reflex/Spider/SpiderTimelineHost.include.hs−57 src/Reflex/Time.hs+384 src/Reflex/TriggerEvent/Base.hs+16−1 src/Reflex/TriggerEvent/Class.hs+6−1 src/Reflex/Widget/Basic.hs+4−2 src/Reflex/Workflow.hs+50 stylize+4 test/Adjustable.hs+62 test/DebugCycles.hs+171 test/EventWriterT.hs+96−6 test/GC.hs+14−8 test/Headless.hs+10 test/QueryT.hs+24−22 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+37−28 test/Reflex/Test/Micro.hs+84−17 test/Reflex/TestPlan.hs+2−2 test/RequesterT.hs+186−16 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−15
@@ -1,15 +0,0 @@
1−# Cache Buster: 0
2−language: nix
3−cache:
4− directories:
5− - /nix
6−matrix:
7− include:
8− - env: COMPILER=ghc7103
9− - env: COMPILER=ghc801
10− - env: COMPILER=ghcjs
11−script:
12− - set -e
13− - nix-build -E "with (import <nixpkgs> {}); pkgs.haskell.packages.$COMPILER.callPackage ./default.nix { }"
14− - nix-collect-garbage -d # This is important to do right before 'script' ends so the cache gets GCed
15−
CONTRIBUTING.mdnew file+66
@@ -0,0 +1,66 @@
1+# Contribution Guide
2+
3+Contributions and issue reports are encouraged and appreciated!
4+
5+- [Opening Issues](#opening-issues)
6+- [Submitting Changes](#submitting-changes)
7+ - [Guidelines for Commit Messages](#guidelines-for-commit-messages)
8+ - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
9+ - [Code Quality](#code-quality)
10+ - [Documentation](#documentation)
11+
12+## Opening Issues
13+
14+Before opening an issue, please check whether your issue has already been reported. Assuming it has not:
15+
16+* Describe the issue you're encountering or the suggestion you're making
17+* Include any relevant steps to reproduce or code samples you can. It's always easier for us to debug if we have something that demonstrates the error.
18+* Let us know what version of reflex you were using. If you're using a github checkout, provide the git hash.
19+* Describe how you're building reflex (i.e., via reflex-platform, cabal install, stack, obelisk, etc.). If you're using reflex-platform or obelisk, provide the git hash of your checkout.
20+
21+## Submitting Changes
22+
23+### Guidelines for Commit Messages
24+
25+#### Summary Line
26+The summary line of your commit message should summarize the changes being made. Commit messages should be written in the imperative mood and should describe what happens when the commit is applied.
27+
28+One way to think about it is that your commit message should be able to complete the sentence:
29+"When applied, this commit will..."
30+
31+#### Body
32+For breaking changes, new features, refactors, or other major changes, the body of the commit message should describe the motivation behind the change in greater detail and may include references to the issue tracker. The body shouldn't repeat code/comments from the diff.
33+
34+### Guidelines for Pull Requests
35+
36+Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
37+
38+### Code Quality
39+
40+#### Warnings
41+
42+Your pull request should add no new warnings to the project. It should also generally not disable any warnings.
43+
44+#### Build and Test
45+
46+Make sure the project builds and that the tests pass! This will generally also be checked by CI before merge, but trying it yourself first means you'll catch problems earlier and your contribution can be merged that much sooner!
47+
48+#### Dependencies
49+
50+Include version bounds whenever adding a dependency to the library stanza of the cabal file. Note that libraries added to reflex.cabal also need to be added to default.nix.
51+
52+### Documentation
53+
54+#### In the code
55+We're always striving to improve documentation. Please include [haddock](https://haskell-haddock.readthedocs.io/en/latest/index.html) documentation for any added code, and update the documentation for any code you modify.
56+
57+#### In the [Changelog](ChangeLog.md)
58+Add an entry to the changelog when your PR:
59+* Adds a feature
60+* Deprecates something
61+* Includes a breaking change
62+* Makes any other change that will impact users
63+
64+#### In the [Readme](README.md)
65+The readme is the first place a lot of people look for information about the repository. Update any parts of the readme that are affected by your PR.
66+
ChangeLog.mdnew file+151
@@ -0,0 +1,151 @@
1+# Revision history for reflex
2+
3+## 0.8.2.0
4+
5+* Add `matchResponseMapWithRequests`, which it similar to `matchResponsesWithRequests` but allows processing of multiple responses at once.
6+
7+## 0.8.1.1
8+
9+* Allow newer hlint for older GHCs, and add upper bound for newer GHCs
10+
11+## 0.8.1.0
12+
13+* Add support for GHC 8.10
14+* Drop support for GHC < 8.4
15+
16+## 0.8.0.0
17+
18+* Replace 0.7.2.0 with 0.8.0.0 to reflect the `MonadHold` interface change. Deprecates 0.7.2.0.
19+
20+## 0.7.2.0 -- *Deprecated*
21+
22+* ([#416](https://github.com/reflex-frp/reflex/pull/416)) Add `now :: m (Event t ())` to `MonadHold`.
23+* Extend some dependency version bounds
24+* Fix HLint 3 test
25+
26+## 0.7.1.1
27+
28+*Backport release*.
29+Changes do not carry forward to 0.7.2.0.
30+
31+* Add support for GHC 8.10
32+* Drop support for GHC < 8.4
33+* Extend some dependency version bounds
34+* Fix HLint 3 test
35+
36+## 0.7.1.0
37+
38+* ([#413](https://github.com/reflex-frp/reflex/pull/413), [#417](https://github.com/reflex-frp/reflex/pull/417)) Add `Reflex.Host.Headless` module which provides `runHeadlessApp` as an easy way to run a Reflex network in a "headless" environment.
39+* ([#420](https://github.com/reflex-frp/reflex/pull/420)) Add a [`Data.Zip.Unzip`](https://hackage.haskell.org/package/semialign-1.1/docs/Data-Zip.html#t:Unzip) instance for `Event`.
40+* ([#419](https://github.com/reflex-frp/reflex/pull/419)) Add `distributeIntMapOverDynPure` and `joinDynThroughIntMap` as convenience functions for working with `Dynamic` `IntMap`s.
41+
42+
43+## 0.7.0.0
44+
45+* Add lifting instances for most classes to `Reflex.Profiled.Profiled`. ([#398](https://github.com/reflex-frp/reflex/pull/398))
46+* Class `MonadQuery t q m` now has a `Monad m` superclass constraint. ([#400](https://github.com/reflex-frp/reflex/pull/400))
47+* **(Breaking change)** Rename class `MonadBehaviorWriter` -> `BehaviorWriter` for consistency with `EventWriter`/`DynamicWriter`. ([#401](https://github.com/reflex-frp/reflex/pull/401))
48+* Introduce deprecated alias `MonadBehaviorWriter = BehaviorWriter`. ([#401](https://github.com/reflex-frp/reflex/pull/401))
49+* Fix bug in spider where event subscriptions would be prematurely finalized due to over-aggressive inlining. ([#409](https://github.com/reflex-frp/reflex/pull/409))
50+* Add instances of `PerformEvent` and `TriggerEvent` for `MaybeT`. ([#395](https://github.com/reflex-frp/reflex/pull/395))
51+
52+## 0.6.4.1
53+
54+* Fix a bug in the Reflex Profiled transformer where
55+ `Reflex.Class.mergeIncrementalG` and
56+ `Reflex.Class.mergeIncrementalWithMoveG` implementations referenced
57+ itself instead of the inner transformed timeline, causing an
58+ infinite loop.
59+
60+## 0.6.4
61+
62+* Support GHC 8.8
63+
64+* Add `Reflex.Query.Base.mapQueryT`. See that module for documentation
65+
66+* The `Reflex.Patch.*` modules were moved to the `patch` library.
67+ They are `Data.Patch.*` there, but reexported under their old names for backwards compatability here.
68+
69+* Additional instances for `Query` classes for basic types.
70+
71+* Add cabal flags `debug-propagation` and `debug-event-cycles` to build in debugging
72+ code for performance and for cyclic dependencies between events
73+
74+## 0.6.3
75+
76+* `Data.WeakBag.traverse` and `Data.FastWeakBag.traverse` have been deprecated.
77+ They are replaced with `Data.WeakBag.traverse_` and `Data.FastWeakBag.traverse_`, respectively.
78+
79+* Fixes a bug in `Reflex.Patch.MapWithMove.patchThatSortsMapWith` that was producing invalid `PatchMapWithMove`.
80+
81+* Add missing `NotReady` instances:
82+ - `instance NotReady (SpiderTimeline x) (SpiderHost x)`
83+ - `instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x))`
84+
85+## 0.6.2.4
86+
87+* Update to monoidal-containers 0.6
88+
89+## 0.6.2.3
90+
91+* Add an upper-bound to witherable
92+
93+## 0.6.2.2
94+
95+* Support these >= 1. Add `split-these` flag to control whether to use new these/semialign combination or not.
96+
97+* Update version bounds to fix some CI failures
98+
99+* Add travis CI configuration
100+
101+## 0.6.2.1
102+
103+* Generalize `fan` to `fanG` to take a `DMap` with non-`Identity`
104+ functor:
105+ * `fan` to `fanG`
106+ * `EventSelectorG` for `fanG` result selector.
107+
108+* Reduce the amount of unsafeCoerce in coercing newtypes under Event/Dynamic/Behavior.
109+ * Add fused ReaderIO for the purpose of coercion (ReaderT's third argument has nominal role preventing automated coerce)
110+ * Add incrementalCoercion/coerceIncremental to go with dynamicCoercion/coerceDynamic
111+
112+* Generalize merging functions:
113+ `merge` to `mergeG`,
114+ `mergeIncremental` to `mergeIncrementalG`,
115+ `mergeIncrementalWithMove` to `mergeIncrementalWithMoveG`.
116+
117+* Generalize distribute function:
118+ `distributeDMapOverDynPure` to `distributeDMapOverDynPureG`,
119+
120+## 0.6.2.0
121+
122+* Fix `holdDyn` so that it is lazy in its event argument
123+ These produce `DMap`s whose values needn't be `Identity`.
124+
125+* Stop using the now-deprecated `*Tag` classes (e.g., `ShowTag`).
126+
127+* Fix `holdDyn` so that it is lazy in its event argument.
128+
129+## 0.6.1.0
130+
131+* Re-export all of `Data.Map.Monoidal`
132+
133+* Fix `QueryT` and `RequesterT` tests
134+
135+## 0.6.0.0 -- 2019-03-20
136+
137+* Deprecate `FunctorMaybe` in favor of `Data.Witherable.Filterable`. We still export `fmapMaybe`, `ffilter`, etc., but they all rely on `Filterable` now.
138+
139+* Rename `MonadDynamicWriter` to `DynamicWriter` and add a deprecation for the old name.
140+
141+* Remove many deprecated functions.
142+
143+* Add a `Num` instance for `Dynamic`.
144+
145+* Add `matchRequestsWithResponses` to make it easier to use `Requester` with protocols that don't do this matching for you.
146+
147+* Add `withRequesterT` to map functions over the request and response of a `RequesterT`.
148+
149+* Suppress nil patches in `QueryT` as an optimization. The `Query` type must now have an `Eq` instance.
150+
151+* Add `throttleBatchWithLag` to `Reflex.Time`. See that module for details.
Quickref.md+143−11
@@ -13,7 +13,6 @@ Some of these functions are *pure*: They operate on Events, Behaviors, or Dynam
1313[S] -- Function runs in any monad supporting MonadSample
1414[H] -- Function runs in any monad supporting MonadHold
1515```
16−
1716Since MonadHold depends on MonadSample, any [S] function also runs in [H] context.
1817
1918## Functions producing Event
@@ -31,6 +30,7 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
3130[ ] ffilter :: (a -> Bool) -> Event a -> Event a
3231[ ] ffor :: Event a -> (a -> b) -> Event b
3332[ ] fforMaybe :: Event a -> (a -> Maybe b) -> Event b
33+[ ] <$ :: a -> Event b -> Event a
3434
3535-- Event to identical Event with debug trace. (Only prints if Event is ultimately used.)
3636[ ] traceEvent :: Show a => String -> Event a -> Event a
@@ -46,24 +46,27 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
4646[ ] attachPromptlyDynWith :: (a -> b -> c) -> Dynamic a -> Event b -> Event c
4747[ ] attachWithMaybe :: (a -> b -> Maybe c) -> Behavior a -> Event b -> Event c
4848[ ] attachPromptlyDynWithMaybe :: (a -> b -> Maybe c) -> Dynamic a -> Event b -> Event c
49+[ ] <@> :: Behavior (a -> b) -> Event a -> Event b
50+[ ] <@ :: Behavior a -> Event b -> Event a
4951
5052-- Combine multiple Events
5153[ ] <> :: Semigroup a => Event a -> Event a -> Event a
5254[ ] difference :: Event a -> Event b -> Event a
5355[ ] align :: Event a -> Event b -> Event (These a b)
5456[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
57+ -- Note align functions from Data.Align in semialign package
5558[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
5659[ ] leftmost :: [Event a] -> Event a
5760[ ] mergeList :: [Event a] -> Event (NonEmpty a)
58−[ ] merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
61+[ ] merge :: GCompare k => DMap k Event -> Event (DMap k Identity)
5962[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
6063
6164-- Efficient one-to-many fanout
62−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
63−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
64−[ ] select :: EventSelector k -> k a -> Event a
65−[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
66−[ ] 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)
6770
6871-- Event to Event via function that can sample current values
6972[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
@@ -96,6 +99,10 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
9699[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
97100-- ... plus many more due to typeclass membership
98101
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+
99106-- Behavior to Behavior by sampling current values
100107[S] sample :: Behavior a -> m a
101108[ ] pull :: m a -> Behavior a
@@ -133,12 +140,17 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
133140[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
134141[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
135142
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+
136147-- Efficient one-to-many fanout
137148[ ] demux :: Ord k => Dynamic k -> Demux k
138149[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
139150
140151-- Dynamic to Dynamic, removing updates w/o value change
141−[ ] uniqDyn :: Eq a => Dynamic a -> Dynamic a
152+[H] holdUniqDyn :: Eq a => Dynamic a -> m (Dynamic a)
153+[H] holdUniqDynBy :: (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
142154
143155-- Dynamic to identical Dynamic with debug trace. (Only prints if Dynamic is ultimately used.)
144156[ ] traceDyn :: Show a => String -> Dynamic a -> Dynamic a
@@ -155,8 +167,8 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
155167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
156168[ ] switch :: Behavior (Event a) -> Event a
157169
158−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
159−[ ] switchPromptlyDyn :: Dynamic (Event a) -> Event a
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
171+[ ] switchDyn :: Dynamic (Event a) -> Event a
160172
161173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
162174[ ] coincidence :: Event (Event a) -> Event a
@@ -179,5 +191,125 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
179191
180192-- Similar to above, for Events. Created Event initially tracks the first argument.
181193-- At switchover, the output Event immediately tracks the new Event.
182−[H] switchPromptly :: Event a -> Event (Event a) -> m (Event a)
194+[H] switchHold :: Event a -> Event (Event a) -> m (Event a)
195+```
196+
197+## Typeclasses to introspect and modify an FRP network.
198+
199+The functions mentioned above are used to create a static FRP network.
200+There are additional typeclasses that can be used to modify the FRP network, to have it interact with IO action, or to introspect the building of the network.
201+
202+The typeclasses and their associated annotations include:
203+
204+- `PostBuild`
205+ Fire an Event when an FRP network has been set up.
206+ ```haskell
207+ [B] -- Function runs in any monad supporting PostBuild
208+ ```
209+
210+- `Adjustable`
211+ Use Events to add or remove pieces of an FRP network.
212+ ```haskell
213+ [A] -- Function runs in any monad supporting Adjustable
214+ ```
215+
216+- `TriggerEvent`
217+ Create new externally-fired Events from within an FRP network.
218+ ```haskell
219+ [T] -- Function runs in any monad supporting TriggerEvent
220+ ```
221+
222+- `PerformEvent`
223+ Use Events to trigger IO actions and to collect their results.
224+ ```haskell
225+ [P] -- Function runs in any monad supporting PerformEvent
226+ ```
227+
228+## Startup
229+
230+```haskell
231+-- One-shot Event that is triggered once the FRP network has been built
232+[B] getPostBuild :: m (Event ())
233+```
234+
235+## Collection management functions
236+
237+```haskell
238+-- Turn a Dynamic key/value map into a set of dynamically-changing widgets.
239+[H,A,B] listWithKey :: Ord k =>
240+ Dynamic (Map k v) -> (k -> Dynamic v -> m a ) -> m (Dynamic (Map k a))
241+
242+-- Same as above where the widget constructor doesn't care about the key.
243+[H,A,B] list :: Ord k =>
244+ Dynamic (Map k v) -> ( Dynamic v -> m a ) -> m (Dynamic (Map k a))
245+
246+-- Even simpler version where there are no keys and we just use a list.
247+[H,A,B] simpleList ::
248+ Dynamic [v] -> ( Dynamic v -> m a ) -> m (Dynamic [a])
249+
250+-- Like listWithKey specialized for widgets returning (Event a).
251+[H,A,B] listViewWithKey :: Ord k =>
252+ Dynamic (Map k v) -> (k -> Dynamic v -> m (Event a)) -> m (Event (Map k a))
253+
254+-- Create a dynamically-changing set of widgets, one of which is selected at any time.
255+[H,A,B] selectViewListWithKey_ :: Ord k => Dynamic k ->
256+ Dynamic (Map k v) -> (k -> Dynamic v -> Dynamic Bool -> m (Event a)) -> m (Event k)
257+
258+-- Same as listWithKey, but takes initial values and an updates Event instead of a Dynamic.
259+[H,A] listWithKeyShallowDiff :: Ord k =>
260+ Map k v -> Event (Map k (Maybe v)) -> (k -> v -> Event v -> m a) -> m (Dynamic (Map k a))
261+```
262+
263+## Creating new events from within an FRP network.
264+
265+```haskell
266+-- Create a new Event and a function that will cause the Event to fire, from within an FRP network
267+[T] newTriggerEvent :: m (Event a, a -> IO ())
268+```
269+
270+## Connecting to the real world (I/O)
271+
272+```haskell
273+-- Run side-effecting actions in Event when it occurs; returned Event contains
274+-- results. Side effects run in the (Performable m) monad which is associated with
275+-- the (PerformEvent t m) typeclass constraint.
276+-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
277+[P] performEvent :: Event (Performable m a ) -> m (Event a)
278+
279+-- Just run side-effects; no return Event
280+[P] performEvent_ :: Event (Performable m ()) -> m ()
281+
282+-- Actions run asynchronously; actions are given a callback to send return values
283+[P,T] performEventAsync :: Event ((a -> IO ()) -> Performable m ()) -> m (Event a)
284+```
285+
286+### Time
287+
288+```haskell
289+-- Create Event at given interval with given basis time.
290+[P,T] tickLossy :: NominalDiffTime -> UTCTime -> m (Event t TickInfo)
291+
292+-- Delay an Event's occurrences by a given amount in seconds.
293+[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
294+```
295+
296+## Networks
297+
298+```haskell
299+-- Functions from Reflex.Adjustable / Reflex.Network used to deal with Dynamics/Events carrying (m a)
300+
301+[A] runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
302+
303+-- Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
304+-- The returned Event of network results occurs when the Dynamic does. Note: Often, the type a is an Event,
305+-- in which case the return value is an Event-of-Events that would typically be flattened (via switchHold).
306+[P,A] networkView :: Dynamic (m a) -> m (Event a)
307+
308+-- Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the
309+-- Event fires. The returned Dynamic of network results occurs when the Event does. Note: Often, the type a is an
310+-- Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
311+[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
312+
313+-- Render a placeholder network to be shown while another network is not yet done building
314+[P,A] untilReady :: m a -> m b -> m (a, Event b)
183315```
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−34
@@ -1,34 +0,0 @@
1−{ mkDerivation, ghc, base, bifunctors, containers, deepseq
2−, dependent-map, dependent-sum, exception-transformers
3−, haskell-src-exts, haskell-src-meta, hlint, lens, MemoTrie
4−, monad-control, mtl, primitive, ref-tf, semigroupoids
5−, semigroups, split, stdenv, stm, syb, template-haskell
6−, these, transformers, transformers-compat, prim-uniq
7−, data-default, filepath, directory, filemanip
8−, useTemplateHaskell ? true
9−}:
10−mkDerivation {
11− pname = "reflex";
12− version = "0.5.0";
13− src = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [ ".git" "dist" ])) ./.;
14− libraryHaskellDepends = [
15− base bifunctors containers dependent-map dependent-sum
16− exception-transformers lens
17− MemoTrie monad-control mtl primitive ref-tf semigroupoids
18− semigroups stm syb template-haskell these transformers
19− transformers-compat prim-uniq
20− base bifunctors containers deepseq dependent-map dependent-sum
21− mtl ref-tf split transformers data-default
22− ] ++ (if !useTemplateHaskell then [] else [
23− haskell-src-exts haskell-src-meta
24− ]);
25− testHaskellDepends = if ghc.isGhcjs or false then [] else [
26− hlint filepath directory filemanip
27− ];
28− configureFlags = if useTemplateHaskell then [] else [
29− "-f-use-template-haskell"
30− ];
31− homepage = "https://github.com/reflex-frp/reflex";
32− description = "Higher-order Functional Reactive Programming";
33− license = stdenv.lib.licenses.bsd3;
34−}
dep/reflex-platform/default.nixnew file+7
@@ -0,0 +1,7 @@
1+# DO NOT HAND-EDIT THIS FILE
2+import ((import <nixpkgs> {}).fetchFromGitHub (
3+ let json = builtins.fromJSON (builtins.readFile ./github.json);
4+ in { inherit (json) owner repo rev sha256;
5+ private = json.private or false;
6+ }
7+))
dep/reflex-platform/github.jsonnew file+7
@@ -0,0 +1,7 @@
1+{
2+ "owner": "reflex-frp",
3+ "repo": "reflex-platform",
4+ "branch": "develop",
5+ "rev": "f628398d076243a0851b27e625b37f65dff9b89b",
6+ "sha256": "0sl0hf1glgyb1vmf2mhw4r9ipmcqk1y19d3wsic7dix2jwywzrh9"
7+}
reflex.cabal+280−83
@@ -1,7 +1,17 @@
11Name: reflex
2−Version: 0.5.0
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,124 +41,168 @@ 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
59+flag debug-cycles
60+ description: Enable debugging of event cycles
61+ default: False
62+ manual: True
63+
64+flag split-these
65+ description: Use split these/semialign packages
66+ manual: False
67+ default: True
68+
4669library
70+ default-language: Haskell2010
4771 hs-source-dirs: src
4872 build-depends:
4973 MemoTrie == 0.6.*,
50− base >= 4.7 && < 4.11,
51− bifunctors >= 5.2 && < 5.5,
52− comonad,
53− containers == 0.5.*,
74+ base >= 4.11 && < 4.15,
75+ bifunctors >= 5.2 && < 5.6,
76+ comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
78+ constraints-extras >= 0.3 && < 0.4,
79+ containers >= 0.6 && < 0.7,
5480 data-default >= 0.5 && < 0.8,
55− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
5682 exception-transformers == 0.4.*,
5783 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
5885 monad-control >= 1.0.1 && < 1.1,
5986 mtl >= 2.1 && < 2.3,
60− prim-uniq >= 0.1.0.1 && < 0.2,
61− 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,
91+ random == 1.1.*,
6292 ref-tf == 0.4.*,
6393 reflection == 2.1.*,
6494 semigroupoids >= 4.0 && < 6,
65− semigroups >= 0.16 && < 0.19,
66− stm == 2.4.*,
95+ stm >= 2.4 && < 2.6,
6796 syb >= 0.5 && < 0.8,
68− these >= 0.4 && < 0.8,
69− transformers >= 0.2,
70− transformers-compat >= 0.3
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
71109
72110 exposed-modules:
111+ Control.Monad.ReaderIO
73112 Data.AppendMap,
74− Data.Functor.Misc,
75− Data.WeakBag,
76− Data.FastWeakBag,
77113 Data.FastMutableIntMap,
114+ Data.FastWeakBag,
115+ Data.Map.Misc,
116+ Data.WeakBag,
78117 Reflex,
79118 Reflex.Class,
80− Reflex.EventWriter,
119+ Reflex.Adjustable.Class,
120+ Reflex.BehaviorWriter.Base,
121+ Reflex.BehaviorWriter.Class,
122+ Reflex.Collection,
81123 Reflex.Dynamic,
82124 Reflex.Dynamic.Uniq,
83125 Reflex.DynamicWriter,
126+ Reflex.DynamicWriter.Base,
127+ Reflex.DynamicWriter.Class,
128+ Reflex.EventWriter,
129+ Reflex.EventWriter.Base,
130+ Reflex.EventWriter.Class,
84131 Reflex.FastWeak,
85132 Reflex.FunctorMaybe,
86133 Reflex.Host.Class,
87− Reflex.Patch,
88− Reflex.Patch.Class,
89− Reflex.Patch.DMap,
90− Reflex.Patch.DMapWithMove,
91− Reflex.Patch.Map,
92− Reflex.Patch.MapWithMove,
93− Reflex.TriggerEvent.Base,
94− Reflex.TriggerEvent.Class,
134+ Reflex.Host.Headless,
135+ Reflex.Network,
136+ Reflex.NotReady.Class,
95137 Reflex.PerformEvent.Base,
96138 Reflex.PerformEvent.Class,
97139 Reflex.PostBuild.Base,
98140 Reflex.PostBuild.Class,
99141 Reflex.Profiled,
142+ Reflex.Pure,
100143 Reflex.Query.Base,
101144 Reflex.Query.Class,
102145 Reflex.Requester.Base,
103146 Reflex.Requester.Class,
104147 Reflex.Spider,
105148 Reflex.Spider.Internal,
106− Reflex.Widget.Basic
149+ Reflex.Time,
150+ Reflex.TriggerEvent.Base,
151+ Reflex.TriggerEvent.Class,
152+ Reflex.Widget.Basic,
153+ Reflex.Workflow
107154
108− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively -ddump-simpl -ddump-to-file -dsuppress-coercions -dsuppress-idinfo
109− 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
110164
111− if flag(specialize-to-spidertimeline-global)
112− cpp-options: -DSPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
113− else
114− exposed-modules: Reflex.Pure
165+ ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
115166
116167 if flag(debug-trace-events)
117168 cpp-options: -DDEBUG_TRACE_EVENTS
118− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
119171
120172 if flag(use-reflex-optimizer)
121173 cpp-options: -DUSE_REFLEX_OPTIMIZER
122174 build-depends: ghc
123175 exposed-modules: Reflex.Optimizer
124176
177+ if flag(debug-propagation)
178+ cpp-options: -DDEBUG -DDEBUG_TRACE_PROPAGATION -DDEBUG_TRACE_INVALIDATION
179+
180+ if flag(debug-cycles)
181+ cpp-options: -DDEBUG_CYCLES
182+
125183 if flag(use-template-haskell)
126184 cpp-options: -DUSE_TEMPLATE_HASKELL
127185 build-depends:
128− dependent-sum >= 0.3 && < 0.5,
129− haskell-src-exts >= 1.16 && < 1.19,
186+ dependent-sum >= 0.6 && < 0.8,
187+ haskell-src-exts >= 1.16 && < 1.24,
130188 haskell-src-meta >= 0.6 && < 0.9,
131− template-haskell >= 2.9 && < 2.13
189+ template-haskell >= 2.9 && < 2.17
132190 exposed-modules:
133191 Reflex.Dynamic.TH
134192 other-extensions: TemplateHaskell
135193 else
136194 build-depends:
137− dependent-sum == 0.4.*
138−
139− if flag(expose-all-unfoldings)
140− ghc-options: -fexpose-all-unfoldings
195+ dependent-sum >= 0.6 && < 0.8
141196
142− if flag(experimental-dependent-sum-instances)
143− ghc-options: -DEXPERIMENTAL_DEPENDENT_SUM_INSTANCES
197+ if flag(fast-weak) && impl(ghcjs)
198+ cpp-options: -DGHCJS_FAST_WEAK
144199
145200 if impl(ghcjs)
146− build-depends: ghcjs-base
201+ build-depends:
202+ ghcjs-base == 0.2.*
147203
148204test-suite semantics
205+ default-language: Haskell2010
149206 type: exitcode-stdio-1.0
150207 main-is: semantics.hs
151208 hs-source-dirs: test
@@ -154,33 +211,46 @@ test-suite semantics
154211 base,
155212 bifunctors,
156213 containers,
157− deepseq >= 1.3 && < 1.5,
214+ deepseq,
158215 dependent-map,
159216 dependent-sum,
160217 mtl,
161218 ref-tf,
162219 reflex,
163220 split,
164− transformers >= 0.3
165− if flag(specialize-to-spidertimeline-global)
166− 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
167229
168230test-suite CrossImpl
231+ default-language: Haskell2010
169232 type: exitcode-stdio-1.0
170233 main-is: Reflex/Test/CrossImpl.hs
171234 hs-source-dirs: test
172− ghc-options: -O2 -Wall -rtsopts -main-is Reflex.Test.CrossImpl.test
235+ ghc-options: -O2 -Wall -rtsopts
173236 build-depends:
174237 base,
175238 containers,
176239 dependent-map,
240+ dependent-sum,
241+ deepseq,
177242 mtl,
243+ transformers,
178244 ref-tf,
179245 reflex
180− if flag(specialize-to-spidertimeline-global)
181− buildable: False
246+ other-modules:
247+ Reflex.Test
248+ Reflex.TestPlan
249+ Reflex.Plan.Reflex
250+ Reflex.Plan.Pure
182251
183252test-suite hlint
253+ default-language: Haskell2010
184254 type: exitcode-stdio-1.0
185255 main-is: hlint.hs
186256 hs-source-dirs: test
@@ -188,103 +258,226 @@ test-suite hlint
188258 , directory
189259 , filepath
190260 , filemanip
191− , hlint == 1.9.*
261+ if impl(ghc >= 8.8)
262+ build-depends: hlint >= 3 && < 4
263+ else
264+ build-depends: hlint (< 2.1 || >= 2.2.2) && < 4
192265 if impl(ghcjs)
193266 buildable: False
194− buildable: False
195267
196268test-suite EventWriterT
269+ default-language: Haskell2010
197270 type: exitcode-stdio-1.0
198271 main-is: EventWriterT.hs
199272 hs-source-dirs: test
200273 build-depends: base
274+ , containers
275+ , deepseq
276+ , dependent-map
201277 , dependent-sum
202278 , lens
279+ , mtl
203280 , these
204281 , transformers
205282 , reflex
206283 , ref-tf
207284
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+
208321test-suite RequesterT
322+ default-language: Haskell2010
209323 type: exitcode-stdio-1.0
210324 main-is: RequesterT.hs
211325 hs-source-dirs: test
212326 build-depends: base
213− , dependent-sum
327+ , constraints
328+ , constraints-extras
329+ , containers
330+ , deepseq
214331 , dependent-map
332+ , dependent-sum
215333 , lens
334+ , mtl
335+ , ref-tf
336+ , reflex
337+ , text
216338 , these
217339 , 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
218365 , reflex
219366 , ref-tf
220− buildable: False
367+ , these
368+
369+ other-modules:
370+ Test.Run
221371
222372test-suite QueryT
373+ default-language: Haskell2010
223374 type: exitcode-stdio-1.0
224375 main-is: QueryT.hs
225376 hs-source-dirs: test
226377 build-depends: base
227378 , containers
228− , dependent-sum
229379 , dependent-map
380+ , dependent-sum
381+ , deepseq
230382 , lens
383+ , monoidal-containers
384+ , mtl
385+ , patch
386+ , ref-tf
387+ , reflex
231388 , these
232389 , transformers
233− , reflex
234− , 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
235399
236400test-suite GC-Semantics
401+ default-language: Haskell2010
237402 type: exitcode-stdio-1.0
238403 main-is: GC.hs
239404 hs-source-dirs: test
240− if flag(specialize-to-spidertimeline-global)
241− buildable: False
242405 build-depends: base
406+ , containers
243407 , dependent-sum
244408 , dependent-map
409+ , deepseq
410+ , mtl
411+ , patch
245412 , these
246413 , transformers
247414 , reflex
248415 , ref-tf
249− if impl(ghc < 8)
250− 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
251425
252426test-suite rootCleanup
427+ default-language: Haskell2010
253428 type: exitcode-stdio-1.0
254429 main-is: rootCleanup.hs
255430 hs-source-dirs: test
256431 build-depends: base
432+ , containers
433+ , deepseq
434+ , dependent-sum
435+ , mtl
257436 , reflex
437+ , ref-tf
438+ , these
439+ other-modules:
440+ Reflex.Plan.Pure
441+ Reflex.TestPlan
442+ Test.Run
258443
259444benchmark spider-bench
445+ default-language: Haskell2010
260446 type: exitcode-stdio-1.0
261− hs-source-dirs: bench
447+ hs-source-dirs: bench test
262448 main-is: Main.hs
263449 ghc-options: -Wall -O2 -rtsopts
264450 build-depends:
265451 base,
266− criterion == 1.1.*,
267− deepseq >= 1.3 && < 1.5,
452+ containers,
453+ criterion,
454+ deepseq,
268455 dependent-map,
269456 dependent-sum,
457+ ref-tf,
270458 mtl,
271459 primitive,
272460 reflex,
461+ split,
273462 stm,
274− transformers >= 0.3
463+ transformers
464+ other-modules:
465+ Reflex.TestPlan
466+ Reflex.Plan.Reflex
467+ Reflex.Bench.Focused
275468
276469benchmark saulzar-bench
470+ default-language: Haskell2010
277471 type: exitcode-stdio-1.0
278472 hs-source-dirs: bench test
279473 c-sources: bench-cbits/checkCapability.c
280474 main-is: RunAll.hs
281475 ghc-options: -Wall -O2 -rtsopts -threaded
282− ghc-prof-options: -fprof-auto
283476 build-depends:
284477 base,
285− containers == 0.5.*,
286− criterion == 1.1.*,
287− deepseq >= 1.3 && < 1.5,
478+ containers,
479+ criterion,
480+ deepseq,
288481 dependent-map,
289482 dependent-sum,
290483 loch-th,
@@ -296,7 +489,11 @@ benchmark saulzar-bench
296489 split,
297490 stm,
298491 time,
299− transformers >= 0.3
492+ transformers
493+ other-modules:
494+ Reflex.TestPlan
495+ Reflex.Plan.Reflex
496+ Reflex.Bench.Focused
300497
301498source-repository head
302499 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−29
@@ -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,6 +21,7 @@ module Data.FastMutableIntMap
2021 , patchIntMapNewElements
2122 , patchIntMapNewElementsMap
2223 , getDeletions
24+ , toList
2325 ) where
2426
2527--TODO: Pure JS version
@@ -27,41 +29,52 @@ module Data.FastMutableIntMap
2729--TODO: Fast patch type
2830
2931import Prelude hiding (lookup)
30−import Data.IORef
32+
33+import Control.Monad.IO.Class
34+import Data.Foldable (traverse_)
3135import Data.IntMap.Strict (IntMap)
3236import qualified Data.IntMap.Strict as IntMap
33−import Data.Maybe
34−import Reflex.Patch.Class
35−import Data.Foldable (traverse_)
36−import Control.Monad.IO.Class
37+import Data.IORef
38+import Data.Patch.Class
39+import Data.Patch.IntMap
3740
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.
3843newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
3944
45+-- | Create a new 'FastMutableIntMap' out of an 'IntMap'
4046new :: IntMap a -> IO (FastMutableIntMap a)
4147new m = FastMutableIntMap <$> newIORef m
4248
49+-- | Create a new empty 'FastMutableIntMap'
4350newEmpty :: IO (FastMutableIntMap a)
4451newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
4552
53+-- | Insert an element into a 'FastMutableIntMap' at the given key
4654insert :: FastMutableIntMap a -> Int -> a -> IO ()
4755insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
4856
57+-- | Attempt to lookup an element by key in a 'FastMutableIntMap'
4958lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
5059lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
5160
61+-- | Runs the provided action over the intersection of a 'FastMutableIntMap' and an 'IntMap'
5262forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
5363forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
5464 a <- liftIO $ readIORef r
5565 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
5666
67+-- | Runs the provided action over the values of a 'FastMutableIntMap'
5768for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
5869for_ (FastMutableIntMap r) f = do
5970 a <- liftIO $ readIORef r
6071 traverse_ f a
6172
73+-- | Checks whether a 'FastMutableIntMap' is empty
6274isEmpty :: FastMutableIntMap a -> IO Bool
6375isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
6476
77+-- | Retrieves the size of a 'FastMutableIntMap'
6578size :: FastMutableIntMap a -> IO Int
6679size (FastMutableIntMap r) = IntMap.size <$> readIORef r
6780
@@ -72,29 +85,13 @@ getFrozenAndClear (FastMutableIntMap r) = do
7285 writeIORef r IntMap.empty
7386 return result
7487
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.
7590applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
7691applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
7792 v <- readIORef r
7893 writeIORef r $! applyAlways p v
7994 return $ IntMap.intersection v m
8095
81−newtype PatchIntMap a = PatchIntMap (IntMap (Maybe a)) deriving (Functor, Foldable, Traversable, Monoid)
82−
83−instance Patch (PatchIntMap a) where
84− type PatchTarget (PatchIntMap a) = IntMap a
85− apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
86− let removes = IntMap.filter isNothing p
87− adds = IntMap.mapMaybe id p
88− in IntMap.union adds $ v `IntMap.difference` removes
89−
90−traverseIntMapPatchWithKey :: Applicative t => (Int -> a -> t b) -> PatchIntMap a -> t (PatchIntMap b)
91−traverseIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap <$> IntMap.traverseWithKey (\k mv -> traverse (f k) mv) m
92−
93−patchIntMapNewElements :: PatchIntMap a -> [a]
94−patchIntMapNewElements (PatchIntMap m) = catMaybes $ IntMap.elems m
95−
96−patchIntMapNewElementsMap :: PatchIntMap a -> IntMap a
97−patchIntMapNewElementsMap (PatchIntMap m) = IntMap.mapMaybe id m
98−
99−getDeletions :: PatchIntMap v -> IntMap v' -> IntMap v'
100−getDeletions (PatchIntMap m) v = IntMap.intersection v m
96+toList :: FastMutableIntMap a -> IO [(Int, a)]
97+toList (FastMutableIntMap r) = IntMap.toList <$> readIORef r
src/Data/FastWeakBag.hs+26−22
@@ -3,7 +3,7 @@
33#ifdef USE_REFLEX_OPTIMIZER
44{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
55#endif
6−#ifdef ghcjs_HOST_OS
6+#ifdef GHCJS_FAST_WEAK
77{-# LANGUAGE ForeignFunctionInterface #-}
88{-# LANGUAGE JavaScriptFFI #-}
99#endif
@@ -18,40 +18,40 @@ module Data.FastWeakBag
1818 , isEmpty
1919 , insert
2020 , traverse
21+ , traverse_
2122 , remove
2223 -- * Internal functions
2324 -- These will not always be available.
24−#ifndef ghcjs_HOST_OS
25+#ifndef GHCJS_FAST_WEAK
2526 , _weakBag_children --TODO: Don't export this
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
32−#ifdef ghcjs_HOST_OS
35+#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.
49−#ifdef ghcjs_HOST_OS
49+#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
@@ -59,7 +59,7 @@ data FastWeakBag a = FastWeakBag
5959-- the caller retains the ticket, the item is guranteed to stay in memory (and
6060-- thus in the 'FastWeakBag'). The ticket can also be used to remove the item from
6161-- the 'FastWeakBag' prematurely (i.e. while it is still alive), using 'remove'.
62−#ifdef ghcjs_HOST_OS
62+#ifdef GHCJS_FAST_WEAK
6363newtype FastWeakBagTicket a = FastWeakBagTicket JSVal
6464#else
6565data FastWeakBagTicket a = FastWeakBagTicket
@@ -74,7 +74,7 @@ insert :: a -- ^ The item
7474 -> FastWeakBag a -- ^ The 'FastWeakBag' to insert into
7575 -> IO (FastWeakBagTicket a) -- ^ Returns a 'FastWeakBagTicket' that ensures the item
7676 -- is retained and allows the item to be removed.
77−#ifdef ghcjs_HOST_OS
77+#ifdef GHCJS_FAST_WEAK
7878insert a wb = js_insert (unsafeToRawJSVal a) wb
7979foreign import javascript unsafe "$r = new h$FastWeakBagTicket($2, $1);" js_insert :: JSVal -> FastWeakBag a -> IO (FastWeakBagTicket a)
8080#else
@@ -93,7 +93,7 @@ insert a (FastWeakBag nextId children) = {-# SCC "insert" #-} do
9393-- | Create an empty 'FastWeakBag'.
9494{-# INLINE empty #-}
9595empty :: IO (FastWeakBag a)
96−#ifdef ghcjs_HOST_OS
96+#ifdef GHCJS_FAST_WEAK
9797empty = js_empty
9898foreign import javascript unsafe "$r = new h$FastWeakBag();" js_empty :: IO (FastWeakBag a)
9999#else
@@ -110,21 +110,21 @@ empty = {-# SCC "empty" #-} do
110110-- | Check whether a 'FastWeakBag' is empty.
111111{-# INLINE isEmpty #-}
112112isEmpty :: FastWeakBag a -> IO Bool
113−#ifdef ghcjs_HOST_OS
113+#ifdef GHCJS_FAST_WEAK
114114isEmpty = js_isEmpty
115115foreign import javascript unsafe "(function(){ for(var i = 0; i < $1.tickets.length; i++) { if($1.tickets[i] !== null) { return false; } }; return true; })()" js_isEmpty :: FastWeakBag a -> IO Bool --TODO: Clean up as we go along so this isn't O(n) every time
116116#else
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 ()
126−#ifdef ghcjs_HOST_OS
127−traverse wb f = do
125+traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
126+#ifdef GHCJS_FAST_WEAK
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,18 +135,22 @@ 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 #-}
148152remove :: FastWeakBagTicket a -> IO ()
149−#ifdef ghcjs_HOST_OS
153+#ifdef GHCJS_FAST_WEAK
150154remove = js_remove
151155foreign import javascript unsafe "$1.bag.tickets[$1.pos] = null; $1.bag = new h$FastWeakBag(); $1.bag.tickets.push($1); $1.pos = 0;" js_remove :: FastWeakBagTicket a -> IO () --TODO: Don't bother with the new surrogate FastWeakBag; instead, make the GC check for bag === null, and then null it out here
152156#else
src/Data/Functor/Misc.hsdeleted−345
@@ -1,345 +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− , dmapToMapWith
27− , mapToDMap
28− , weakenDMapWith
29− -- * WrapArg
30− , WrapArg (..)
31− -- * Convenience functions for DMap
32− , mapWithFunctorToDMap
33− , mapKeyValuePairsMonotonic
34− , combineDMapsWithKey
35− , EitherTag (..)
36− , dmapToThese
37− , eitherToDSum
38− , dsumToEither
39− -- * Deprecated functions
40− , sequenceDmap
41− , wrapDMap
42− , rewrapDMap
43− , unwrapDMap
44− , unwrapDMapMaybe
45− , extractFunctorDMap
46− , ComposeMaybe (..)
47− ) where
48−
49−import Control.Applicative (Applicative, (<$>))
50−import Control.Monad.Identity
51−import Data.Dependent.Map (DMap)
52−import qualified Data.Dependent.Map as DMap
53−import Data.Dependent.Sum
54−import Data.GADT.Compare
55−import Data.GADT.Show
56−import Data.Map (Map)
57−import qualified Data.Map as Map
58−import Data.Some (Some)
59−import qualified Data.Some as Some
60−import Data.These
61−import Data.Typeable hiding (Refl)
62−
63−--------------------------------------------------------------------------------
64−-- Const2
65−--------------------------------------------------------------------------------
66−
67−-- | 'Const2' stores a value of a given type 'k' and ensures that a particular
68−-- type 'v' is always given for the last type parameter
69−data Const2 :: * -> x -> x -> * where
70− Const2 :: k -> Const2 k v v
71− deriving (Typeable)
72−
73−unConst2 :: Const2 k v v' -> k
74−unConst2 (Const2 k) = k
75−
76−deriving instance Eq k => Eq (Const2 k v v')
77−deriving instance Ord k => Ord (Const2 k v v')
78−deriving instance Show k => Show (Const2 k v v')
79−deriving instance Read k => Read (Const2 k v v)
80−
81−instance Show k => GShow (Const2 k v) where
82−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
83− gshowToShow (Const2 _) = id
84−#else
85− gshowsPrec n x@(Const2 _) = showsPrec n x
86−#endif
87−
88−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
89−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
90− showTagToShow (Const2 _) _ = id
91−#else
92− showTaggedPrec (Const2 _) = showsPrec
93−#endif
94−
95−instance Eq k => GEq (Const2 k v) where
96−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
97− geqToEq _ = id
98− geqUnify (Const2 _) (Const2 _) _ = id
99−#else
100− geq (Const2 a) (Const2 b) =
101− if a == b
102− then Just Refl
103− else Nothing
104−#endif
105−
106−instance Ord k => GCompare (Const2 k v) where
107−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
108− gcompareToOrd (Const2 _) = id
109− gcompare (Const2 a) (Const2 b) = strengthenOrdering $ compare a b
110−#else
111− gcompare (Const2 a) (Const2 b) = case compare a b of
112− LT -> GLT
113− EQ -> GEQ
114− GT -> GGT
115−#endif
116−
117−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
118−instance {-# INCOHERENT #-} (Eq k, Eq v) => EqTag (Const2 k v) Identity where
119− eqTagToEq (Const2 _) _ = id
120−
121−instance {-# INCOHERENT #-} Eq k => EqTag (Const2 k v) (Const2 k v) where
122− eqTagToEq (Const2 _) _ = id
123−#endif
124−
125−-- | Convert a 'DMap' to a regular 'Map'
126−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
127−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
128−
129−dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
130−dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
131−
132−-- | Convert a regular 'Map' to a 'DMap'
133−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
134−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
135−
136−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
137−-- to a 'DMap'
138−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
139−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
140−
141−weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
142−weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (Some.This k, f v)) . DMap.toAscList
143−
144−--------------------------------------------------------------------------------
145−-- WrapArg
146−--------------------------------------------------------------------------------
147−
148−-- | 'WrapArg' can be used to tag a value in one functor with a type
149−-- representing another functor. This was primarily used with dependent-map <
150−-- 0.2, in which the value type was not wrapped in a separate functor.
151−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
152− WrapArg :: f a -> WrapArg g f (g a)
153−
154−deriving instance Eq (f a) => Eq (WrapArg g f (g' a))
155−deriving instance Ord (f a) => Ord (WrapArg g f (g' a))
156−deriving instance Show (f a) => Show (WrapArg g f (g' a))
157−deriving instance Read (f a) => Read (WrapArg g f (g a))
158−
159−instance GEq f => GEq (WrapArg g f) where
160−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
161− geqToEq (WrapArg f) = geqToEq f
162− geqUnify (WrapArg a) (WrapArg b) = geqUnify a b
163−#else
164− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
165−#endif
166−
167−instance GCompare f => GCompare (WrapArg g f) where
168−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
169− gcompareToOrd (WrapArg f) = gcompareToOrd f
170−#endif
171− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
172− GLT -> GLT
173− GEQ -> GEQ
174− GGT -> GGT
175−
176−--------------------------------------------------------------------------------
177−-- Convenience functions for DMap
178−--------------------------------------------------------------------------------
179−
180−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
181−-- well as the value. The provided function MUST preserve the ordering of the
182−-- keys, or the resulting 'DMap' will be malformed.
183−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
184−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
185−
186−{-# INLINE combineDMapsWithKey #-}
187−-- | Union two 'DMap's of different types, yielding another type. Each key that
188−-- is present in either input map will be present in the output.
189−combineDMapsWithKey :: forall f g h i.
190− GCompare f
191− => (forall a. f a -> These (g a) (h a) -> i a)
192− -> DMap f g
193− -> DMap f h
194− -> DMap f i
195−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
196− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
197− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
198− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
199− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
200− GLT -> (gk :=> f gk (This gv)) : go gs' hs
201− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
202− GGT -> (hk :=> f hk (That hv)) : go gs hs'
203−
204−-- | Extract the values of a 'DMap' of 'EitherTag's.
205−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
206−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
207− (Nothing, Nothing) -> Nothing
208− (Just (Identity a), Nothing) -> Just $ This a
209− (Nothing, Just (Identity b)) -> Just $ That b
210− (Just (Identity a), Just (Identity b)) -> Just $ These a b
211−
212−-- | Tag type for 'Either' to use it as a 'DSum'.
213−data EitherTag l r a where
214− LeftTag :: EitherTag l r l
215− RightTag :: EitherTag l r r
216− deriving (Typeable)
217−
218−deriving instance Show (EitherTag l r a)
219−deriving instance Eq (EitherTag l r a)
220−deriving instance Ord (EitherTag l r a)
221−
222−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
223−instance {-# INCOHERENT #-} (Show (f l), Show (f r)) => ShowTag (EitherTag l r) f where
224− showTagToShow e _ = case e of
225− LeftTag -> id
226− RightTag -> id
227−
228−instance {-# INCOHERENT #-} (Eq (f l), Eq (f r)) => EqTag (EitherTag l r) f where
229− eqTagToEq e _ = case e of
230− LeftTag -> id
231− RightTag -> id
232−#endif
233−
234−instance GEq (EitherTag l r) where
235−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
236− geqToEq _ = id
237− geqUnify LeftTag LeftTag _ same = same
238− geqUnify RightTag RightTag _ same = same
239− geqUnify _ _ unknown _ = unknown
240−#endif
241− geq a b = case (a, b) of
242− (LeftTag, LeftTag) -> Just Refl
243− (RightTag, RightTag) -> Just Refl
244− _ -> Nothing
245−
246−instance GCompare (EitherTag l r) where
247−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
248− gcompareToOrd _ = id
249−#endif
250− gcompare a b = case (a, b) of
251− (LeftTag, LeftTag) -> GEQ
252− (LeftTag, RightTag) -> GLT
253− (RightTag, LeftTag) -> GGT
254− (RightTag, RightTag) -> GEQ
255−
256−instance GShow (EitherTag l r) where
257−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
258− gshowToShow _ = id
259−#else
260− gshowsPrec _ a = case a of
261− LeftTag -> showString "LeftTag"
262− RightTag -> showString "RightTag"
263−#endif
264−
265−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
266−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
267− showTagToShow t _ = case t of
268− LeftTag -> id
269− RightTag -> id
270−#else
271− showTaggedPrec t n (Identity a) = case t of
272− LeftTag -> showsPrec n a
273− RightTag -> showsPrec n a
274−#endif
275−
276−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
277−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
278−eitherToDSum = \case
279− Left a -> (LeftTag :=> Identity a)
280− Right b -> (RightTag :=> Identity b)
281−
282−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
283−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
284−dsumToEither = \case
285− (LeftTag :=> Identity a) -> Left a
286− (RightTag :=> Identity b) -> Right b
287−
288−--------------------------------------------------------------------------------
289−-- ComposeMaybe
290−--------------------------------------------------------------------------------
291−
292−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
293−-- make the 'f' parameter have a nominal type role. We need f to be
294−-- representational so that we can use safe 'coerce'.
295−#if MIN_VERSION_transformers(5,2,0)
296−newtype ComposeMaybe f a =
297−#else
298−newtype ComposeMaybe (f :: * -> *) (a :: *) =
299−#endif
300− ComposeMaybe { getComposeMaybe :: Maybe (f a) } deriving (Show, Eq, Ord)
301−
302−deriving instance Functor f => Functor (ComposeMaybe f)
303−
304−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
305−instance {-# INCOHERENT #-} EqTag f g => EqTag f (ComposeMaybe g) where
306− eqTagToEq f _ = eqTagToEq f (Proxy :: Proxy g)
307−
308−instance {-# INCOHERENT #-} GShow k => ShowTag k (ComposeMaybe k) where
309− showTagToShow k _ r = gshowToShow k (showTagToShow k (Proxy :: Proxy k) r)
310−#endif
311−--------------------------------------------------------------------------------
312−-- Deprecated functions
313−--------------------------------------------------------------------------------
314−
315−{-# INLINE sequenceDmap #-}
316−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ -> fmap Identity)' instead" #-}
317−-- | Run the actions contained in the 'DMap'
318−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
319−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
320−
321−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
322−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
323−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
324−wrapDMap f = DMap.map $ f . runIdentity
325−
326−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
327−-- | Replace one functor for a 'DMap''s values with a different functor
328−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
329−rewrapDMap = DMap.map
330−
331−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
332−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
333−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
334−unwrapDMap f = DMap.map $ Identity . f
335−
336−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
337−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
338−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
339−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
340−
341−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
342−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
343−-- underlying functor
344−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
345−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
src/Data/Map/Misc.hsnew file+71
@@ -0,0 +1,71 @@
1+{-# LANGUAGE LambdaCase #-}
2+-- | Additional functions for manipulating 'Map's.
3+module Data.Map.Misc
4+ (
5+ -- * Working with Maps
6+ diffMapNoEq
7+ , diffMap
8+ , applyMap
9+ , mapPartitionEithers
10+ , applyMapKeysSet
11+ ) where
12+
13+import Data.Align
14+import Data.Map (Map)
15+import qualified Data.Map as Map
16+import Data.Maybe
17+import Data.Set (Set)
18+import qualified Data.Set as Set
19+import Data.These
20+
21+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new@ respectively. @Just@ represents an association present in @new@ and @Nothing@
22+-- represents an association only present in @old@ but no longer present in @new@.
23+--
24+-- Similar to 'diffMap' but doesn't require 'Eq' on the values, thus can't tell if a value has changed or not.
25+diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
26+diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
27+ This _ -> Just Nothing
28+ These _ new -> Just $ Just new
29+ That new -> Just $ Just new
30+
31+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new respectively. @Just@ represents an association present in @new@ and either not
32+-- present in @old@ or where the value has changed. @Nothing@ represents an association only present in @old@ but no longer present in @new@.
33+--
34+-- See also 'diffMapNoEq' for a similar but weaker version which does not require 'Eq' on the values but thus can't indicated a value not changing between
35+-- @old@ and @new@ with @Nothing@.
36+diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
37+diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
38+ This _ -> Just Nothing
39+ These old new
40+ | old == new -> Nothing
41+ | otherwise -> Just $ Just new
42+ That new -> Just $ Just new
43+
44+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new map from the given input @'Map' k v@.
45+--
46+-- See also 'Data.Patch.Map' and 'Data.Patch.MapWithMove'.
47+applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
48+applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
49+ where (deletions, insertions) = Map.mapEither maybeToEither patch
50+ maybeToEither = \case
51+ Nothing -> Left ()
52+ Just r -> Right r
53+
54+-- |Split a @'Map' k (Either a b)@ into @Map k a@ and @Map k b@, equivalent to @'Map.mapEither' id@
55+{-# DEPRECATED mapPartitionEithers "Use 'mapEither' instead" #-}
56+mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
57+mapPartitionEithers = Map.mapEither id
58+
59+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new @'Set' k@ from the given input set.
60+--
61+-- Equivalent to:
62+--
63+-- @
64+-- applyMapKeysSet patch ('Map.keysSet' m) == 'Map.keysSet' ('applyMap' patch m)
65+-- @
66+--
67+-- but avoids the intervening @Map@ and needs no values.
68+applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
69+applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
70+ where (insertions, deletions) = Map.partition isJust patch
71+
src/Data/WeakBag.hs+14−12
@@ -15,29 +15,29 @@ 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?
40− , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a)))
40+ , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a))) -- ^ The items referenced by the WeakBag
4141 }
4242
4343-- | When inserting an item into a 'WeakBag', a 'WeakBagTicket' is returned. If
@@ -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+10−2
@@ -6,13 +6,20 @@ module Reflex
66 ) where
77
88import Reflex.Class as X
9−import Reflex.EventWriter as X
9+import Reflex.Adjustable.Class as X
10+import Reflex.BehaviorWriter.Base as X
11+import Reflex.BehaviorWriter.Class as X
12+import Reflex.Collection as X
1013import Reflex.Dynamic as X
14+import Reflex.EventWriter.Base as X
15+import Reflex.EventWriter.Class as X
1116#ifdef USE_TEMPLATE_HASKELL
1217import Reflex.Dynamic.TH as X
1318#endif
1419import Reflex.Dynamic.Uniq as X
15−import Reflex.DynamicWriter as X
20+import Reflex.DynamicWriter.Base as X
21+import Reflex.DynamicWriter.Class as X
22+import Reflex.NotReady.Class as X
1623import Reflex.PerformEvent.Base as X
1724import Reflex.PerformEvent.Class as X
1825import Reflex.PostBuild.Base as X
@@ -23,5 +30,6 @@ import Reflex.Query.Class as X
2330import Reflex.Requester.Base as X
2431import Reflex.Requester.Class as X
2532import Reflex.Spider as X
33+import Reflex.Time as X
2634import Reflex.TriggerEvent.Base as X
2735import Reflex.TriggerEvent.Class as X
src/Reflex/Adjustable/Class.hsnew file+140
@@ -0,0 +1,140 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FunctionalDependencies #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+-- |
14+-- Module:
15+-- Reflex.Adjustable.Class
16+-- Description:
17+-- A class for actions that can be "adjusted" over time based on some 'Event'
18+-- such that, when observed after the firing of any such 'Event', the result
19+-- is as though the action was originally run with the 'Event's value.
20+module Reflex.Adjustable.Class
21+ (
22+ -- * The Adjustable typeclass
23+ Adjustable(..)
24+ , sequenceDMapWithAdjust
25+ , sequenceDMapWithAdjustWithMove
26+ , mapMapWithAdjustWithMove
27+ -- * Deprecated aliases
28+ , MonadAdjust
29+ ) where
30+
31+import Control.Monad.Identity
32+import Control.Monad.Reader
33+import Data.Dependent.Map (DMap)
34+import Data.GADT.Compare (GCompare(..))
35+import qualified Data.Dependent.Map as DMap
36+import Data.Functor.Constant
37+import Data.Functor.Misc
38+import Data.IntMap.Strict (IntMap)
39+import qualified Data.IntMap.Strict as IntMap
40+import Data.Map (Map)
41+
42+import Reflex.Class
43+import Data.Patch.DMapWithMove
44+
45+-- | A 'Monad' that supports adjustment over time. After an action has been
46+-- run, if the given events fire, it will adjust itself so that its net effect
47+-- is as though it had originally been run with the new value. Note that there
48+-- is some issue here with persistent side-effects: obviously, IO (and some
49+-- other side-effects) cannot be undone, so it is up to the instance implementer
50+-- to determine what the best meaning for this class is in such cases.
51+class (Reflex t, Monad m) => Adjustable t m | m -> t where
52+ runWithReplace
53+ :: m a
54+ -> Event t (m b)
55+ -> m (a, Event t b)
56+
57+ traverseIntMapWithKeyWithAdjust
58+ :: (IntMap.Key -> v -> m v')
59+ -> IntMap v
60+ -> Event t (PatchIntMap v)
61+ -> m (IntMap v', Event t (PatchIntMap v'))
62+
63+ traverseDMapWithKeyWithAdjust
64+ :: GCompare k
65+ => (forall a. k a -> v a -> m (v' a))
66+ -> DMap k v
67+ -> Event t (PatchDMap k v)
68+ -> m (DMap k v', Event t (PatchDMap k v'))
69+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
70+ traverseDMapWithKeyWithAdjust f dm0 dm' = fmap (fmap (fmap fromPatchWithMove)) $
71+ traverseDMapWithKeyWithAdjustWithMove f dm0 $ fmap toPatchWithMove dm'
72+ where
73+ toPatchWithMove (PatchDMap m) = PatchDMapWithMove $ DMap.map toNodeInfoWithMove m
74+ toNodeInfoWithMove = \case
75+ ComposeMaybe (Just v) -> NodeInfo (From_Insert v) $ ComposeMaybe Nothing
76+ ComposeMaybe Nothing -> NodeInfo From_Delete $ ComposeMaybe Nothing
77+ fromPatchWithMove (PatchDMapWithMove m) = PatchDMap $ DMap.map fromNodeInfoWithMove m
78+ fromNodeInfoWithMove (NodeInfo from _) = ComposeMaybe $ case from of
79+ From_Insert v -> Just v
80+ From_Delete -> Nothing
81+ From_Move _ -> error "traverseDMapWithKeyWithAdjust: implementation of traverseDMapWithKeyWithAdjustWithMove inserted spurious move"
82+
83+ traverseDMapWithKeyWithAdjustWithMove
84+ :: GCompare k
85+ => (forall a. k a -> v a -> m (v' a))
86+ -> DMap k v
87+ -> Event t (PatchDMapWithMove k v)
88+ -> m (DMap k v', Event t (PatchDMapWithMove k v'))
89+
90+instance Adjustable t m => Adjustable t (ReaderT r m) where
91+ runWithReplace a0 a' = do
92+ r <- ask
93+ lift $ runWithReplace (runReaderT a0 r) $ fmap (`runReaderT` r) a'
94+ traverseIntMapWithKeyWithAdjust f dm0 dm' = do
95+ r <- ask
96+ lift $ traverseIntMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
97+ traverseDMapWithKeyWithAdjust f dm0 dm' = do
98+ r <- ask
99+ lift $ traverseDMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
100+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
101+ r <- ask
102+ lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
103+
104+-- | Traverse a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
105+-- to the 'DMap' can add, remove, or update values.
106+sequenceDMapWithAdjust
107+ :: (GCompare k, Adjustable t m)
108+ => DMap k m
109+ -> Event t (PatchDMap k m)
110+ -> m (DMap k Identity, Event t (PatchDMap k Identity))
111+sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
112+
113+-- | Traverses a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
114+-- to the 'DMap' can add, remove, update, move, or swap values.
115+sequenceDMapWithAdjustWithMove
116+ :: (GCompare k, Adjustable t m)
117+ => DMap k m
118+ -> Event t (PatchDMapWithMove k m)
119+ -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
120+sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
121+
122+-- | Traverses a 'Map', running the provided 'Adjustable' action. The provided 'Event' of patches to the 'Map'
123+-- can add, remove, update, move, or swap values.
124+mapMapWithAdjustWithMove
125+ :: forall t m k v v'. (Adjustable t m, Ord k)
126+ => (k -> v -> m v')
127+ -> Map k v
128+ -> Event t (PatchMapWithMove k v)
129+ -> m (Map k v', Event t (PatchMapWithMove k v'))
130+mapMapWithAdjustWithMove f m0 m' = do
131+ (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
132+ return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
133+
134+--------------------------------------------------------------------------------
135+-- Deprecated functions
136+--------------------------------------------------------------------------------
137+
138+{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
139+-- | Synonym for 'Adjustable'
140+type MonadAdjust = Adjustable
src/Reflex/BehaviorWriter/Base.hsnew file+211
@@ -0,0 +1,211 @@
1+{-|
2+Module: Reflex.BehaviorWriter.Base
3+Description: Implementation of BehaviorWriter
4+-}
5+{-# LANGUAGE CPP #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE TypeFamilies #-}
13+{-# LANGUAGE UndecidableInstances #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+#ifdef USE_REFLEX_OPTIMIZER
16+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
17+#endif
18+module Reflex.BehaviorWriter.Base
19+ ( BehaviorWriterT (..)
20+ , runBehaviorWriterT
21+ , withBehaviorWriterT
22+ ) where
23+
24+import Control.Monad.Exception
25+import Control.Monad.Identity
26+import Control.Monad.IO.Class
27+import Control.Monad.Morph
28+import Control.Monad.Reader
29+import Control.Monad.Ref
30+import Control.Monad.State.Strict
31+import Data.Dependent.Map (DMap)
32+import qualified Data.Dependent.Map as DMap
33+import Data.Functor.Misc
34+import Data.IntMap (IntMap)
35+import qualified Data.IntMap as IntMap
36+import Data.Map (Map)
37+import qualified Data.Map as Map
38+import Data.Some (Some)
39+
40+import Reflex.Class
41+import Reflex.Adjustable.Class
42+import Reflex.BehaviorWriter.Class
43+import Reflex.Host.Class
44+import Reflex.PerformEvent.Class
45+import Reflex.PostBuild.Class
46+import Reflex.Query.Class
47+import Reflex.Requester.Class
48+import Reflex.TriggerEvent.Class
49+
50+-- | A basic implementation of 'BehaviorWriter'.
51+newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
52+ -- The list is kept in reverse order
53+ deriving
54+ ( Functor
55+ , Applicative
56+ , Monad
57+ , MonadTrans
58+ , MFunctor
59+ , MonadIO
60+ , MonadFix
61+ , MonadAsyncException
62+ , MonadException
63+ )
64+
65+-- | Run a 'BehaviorWriterT' action. The behavior writer output will be provided
66+-- along with the result of the action.
67+runBehaviorWriterT :: (Monad m, Reflex t, Monoid w) => BehaviorWriterT t w m a -> m (a, Behavior t w)
68+runBehaviorWriterT (BehaviorWriterT a) = do
69+ (result, ws) <- runStateT a []
70+ return (result, mconcat $ reverse ws)
71+
72+-- | Map a function over the output of a 'BehaviorWriterT'.
73+withBehaviorWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m)
74+ => (w -> w')
75+ -> BehaviorWriterT t w m a
76+ -> BehaviorWriterT t w' m a
77+withBehaviorWriterT f dw = do
78+ (r, d) <- lift $ do
79+ (r, d) <- runBehaviorWriterT dw
80+ let d' = fmap f d
81+ return (r, d')
82+ tellBehavior d
83+ return r
84+
85+deriving instance MonadHold t m => MonadHold t (BehaviorWriterT t w m)
86+deriving instance MonadSample t m => MonadSample t (BehaviorWriterT t w m)
87+
88+instance MonadRef m => MonadRef (BehaviorWriterT t w m) where
89+ type Ref (BehaviorWriterT t w m) = Ref m
90+ newRef = lift . newRef
91+ readRef = lift . readRef
92+ writeRef r = lift . writeRef r
93+
94+instance MonadAtomicRef m => MonadAtomicRef (BehaviorWriterT t w m) where
95+ atomicModifyRef r = lift . atomicModifyRef r
96+
97+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (BehaviorWriterT t w m) where
98+ newEventWithTrigger = lift . newEventWithTrigger
99+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
100+
101+instance (Monad m, Monoid w, Reflex t) => BehaviorWriter t w (BehaviorWriterT t w m) where
102+ tellBehavior w = BehaviorWriterT $ modify (w :)
103+
104+instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
105+ ask = lift ask
106+ local f (BehaviorWriterT a) = BehaviorWriterT $ mapStateT (local f) a
107+ reader = lift . reader
108+
109+instance PerformEvent t m => PerformEvent t (BehaviorWriterT t w m) where
110+ type Performable (BehaviorWriterT t w m) = Performable m
111+ performEvent_ = lift . performEvent_
112+ performEvent = lift . performEvent
113+
114+instance TriggerEvent t m => TriggerEvent t (BehaviorWriterT t w m) where
115+ newTriggerEvent = lift newTriggerEvent
116+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
117+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
118+
119+instance PostBuild t m => PostBuild t (BehaviorWriterT t w m) where
120+ getPostBuild = lift getPostBuild
121+
122+instance MonadState s m => MonadState s (BehaviorWriterT t w m) where
123+ get = lift get
124+ put = lift . put
125+
126+instance Requester t m => Requester t (BehaviorWriterT t w m) where
127+ type Request (BehaviorWriterT t w m) = Request m
128+ type Response (BehaviorWriterT t w m) = Response m
129+ requesting = lift . requesting
130+ requesting_ = lift . requesting_
131+
132+instance (MonadQuery t q m, Monad m) => MonadQuery t q (BehaviorWriterT t w m) where
133+ tellQueryIncremental = lift . tellQueryIncremental
134+ askQueryResult = lift askQueryResult
135+ queryIncremental = lift . queryIncremental
136+
137+instance (Adjustable t m, Monoid w, MonadHold t m, Reflex t) => Adjustable t (BehaviorWriterT t w m) where
138+ runWithReplace a0 a' = do
139+ (result0, result') <- lift $ runWithReplace (runBehaviorWriterT a0) $ runBehaviorWriterT <$> a'
140+ tellBehavior . join =<< hold (snd result0) (snd <$> result')
141+ return (fst result0, fst <$> result')
142+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustImpl traverseIntMapWithKeyWithAdjust
143+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith
144+
145+traverseIntMapWithKeyWithAdjustImpl
146+ :: forall t w v' p p' v m.
147+ ( PatchTarget (p' (Behavior t w)) ~ IntMap (Behavior t w)
148+ , Patch (p' (Behavior t w))
149+ , Monoid w
150+ , Reflex t
151+ , MonadHold t m
152+ , Functor p
153+ , p ~ p'
154+ )
155+ => ( (IntMap.Key -> v -> m (v', Behavior t w))
156+ -> IntMap v
157+ -> Event t (p v)
158+ -> m (IntMap (v', Behavior t w), Event t (p (v', Behavior t w)))
159+ )
160+ -> (IntMap.Key -> v -> BehaviorWriterT t w m v')
161+ -> IntMap v
162+ -> Event t (p v)
163+ -> BehaviorWriterT t w m (IntMap v', Event t (p v'))
164+traverseIntMapWithKeyWithAdjustImpl base f (dm0 :: IntMap v) dm' = do
165+ (result0, result') <- lift $ base (\k v -> runBehaviorWriterT $ f k v) dm0 dm'
166+ let liftedResult0 = fmap fst result0
167+ liftedResult' = fmap (fmap fst) result'
168+ liftedWritten0 :: IntMap (Behavior t w)
169+ liftedWritten0 = fmap snd result0
170+ liftedWritten' = fmap (fmap snd) result'
171+ i <- holdIncremental liftedWritten0 liftedWritten'
172+ tellBehavior $ pull $ do
173+ m <- sample $ currentIncremental i
174+ mconcat . IntMap.elems <$> traverse sample m
175+ return (liftedResult0, liftedResult')
176+
177+newtype BehaviorWriterTLoweredResult t w v a = BehaviorWriterTLoweredResult (v a, Behavior t w)
178+
179+traverseDMapWithKeyWithAdjustImpl
180+ :: forall t w k v' p p' v m.
181+ ( PatchTarget (p' (Some k) (Behavior t w)) ~ Map (Some k) (Behavior t w)
182+ , Patch (p' (Some k) (Behavior t w))
183+ , Monoid w
184+ , Reflex t
185+ , MonadHold t m
186+ )
187+ => ( (forall a. k a -> v a -> m (BehaviorWriterTLoweredResult t w v' a))
188+ -> DMap k v
189+ -> Event t (p k v)
190+ -> m (DMap k (BehaviorWriterTLoweredResult t w v'), Event t (p k (BehaviorWriterTLoweredResult t w v')))
191+ )
192+ -> ((forall a. BehaviorWriterTLoweredResult t w v' a -> v' a) -> p k (BehaviorWriterTLoweredResult t w v') -> p k v')
193+ -> ((forall a. BehaviorWriterTLoweredResult t w v' a -> Behavior t w) -> p k (BehaviorWriterTLoweredResult t w v') -> p' (Some k) (Behavior t w))
194+ -> (forall a. k a -> v a -> BehaviorWriterT t w m (v' a))
195+ -> DMap k v
196+ -> Event t (p k v)
197+ -> BehaviorWriterT t w m (DMap k v', Event t (p k v'))
198+traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith f (dm0 :: DMap k v) dm' = do
199+ (result0, result') <- lift $ base (\k v -> fmap BehaviorWriterTLoweredResult $ runBehaviorWriterT $ f k v) dm0 dm'
200+ let getValue (BehaviorWriterTLoweredResult (v, _)) = v
201+ getWritten (BehaviorWriterTLoweredResult (_, w)) = w
202+ liftedResult0 = DMap.map getValue result0
203+ liftedResult' = ffor result' $ mapPatch getValue
204+ liftedWritten0 :: Map (Some k) (Behavior t w)
205+ liftedWritten0 = weakenDMapWith getWritten result0
206+ liftedWritten' = ffor result' $ weakenPatchWith getWritten
207+ i <- holdIncremental liftedWritten0 liftedWritten'
208+ tellBehavior $ pull $ do
209+ m <- sample $ currentIncremental i
210+ mconcat . Map.elems <$> traverse sample m
211+ return (liftedResult0, liftedResult')
src/Reflex/BehaviorWriter/Class.hsnew file+31
@@ -0,0 +1,31 @@
1+{-|
2+Module: Reflex.BehaviorWriter.Class
3+Description: This module defines the 'BehaviorWriter' class
4+-}
5+{-# LANGUAGE CPP #-}
6+{-# LANGUAGE ConstraintKinds #-}
7+{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE FunctionalDependencies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+module Reflex.BehaviorWriter.Class
14+ ( MonadBehaviorWriter
15+ , BehaviorWriter(..)
16+ ) where
17+
18+import Control.Monad.Reader (ReaderT, lift)
19+import Reflex.Class (Behavior)
20+
21+{-# DEPRECATED MonadBehaviorWriter "Use 'BehaviorWriter' instead" #-}
22+-- | Type synonym for 'BehaviorWriter'
23+type MonadBehaviorWriter = BehaviorWriter
24+
25+-- | 'BehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
26+-- and combines them monoidally to provide a 'Behavior' result.
27+class (Monad m, Monoid w) => BehaviorWriter t w m | m -> t w where
28+ tellBehavior :: Behavior t w -> m ()
29+
30+instance BehaviorWriter t w m => BehaviorWriter t w (ReaderT r m) where
31+ tellBehavior = lift . tellBehavior
src/Reflex/Class.hs+789−339
@@ -1,12 +1,14 @@
1+{-# LANGUAGE BangPatterns #-}
12{-# LANGUAGE CPP #-}
3+{-# LANGUAGE ConstraintKinds #-}
24{-# LANGUAGE DefaultSignatures #-}
35{-# LANGUAGE FlexibleContexts #-}
46{-# LANGUAGE FlexibleInstances #-}
57{-# LANGUAGE FunctionalDependencies #-}
68{-# LANGUAGE GADTs #-}
79{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
910{-# LANGUAGE NoMonomorphismRestriction #-}
11+{-# LANGUAGE PolyKinds #-}
1012{-# LANGUAGE RankNTypes #-}
1113{-# LANGUAGE RecursiveDo #-}
1214{-# LANGUAGE RoleAnnotations #-}
@@ -14,45 +16,56 @@
1416{-# LANGUAGE TypeFamilies #-}
1517{-# LANGUAGE TypeOperators #-}
1618{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
1720#ifdef USE_REFLEX_OPTIMIZER
1821{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1922#endif
20−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
21−{-# LANGUAGE EmptyDataDecls #-}
22−{-# OPTIONS_GHC -Wno-redundant-constraints #-}
23−#endif
2423
25−-- | This module contains the Reflex interface, as well as a variety of
26−-- convenience functions for working with 'Event's, 'Behavior's, and other
27−-- 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.
2831module Reflex.Class
29− ( module Reflex.Patch
32+ ( module Data.Patch
3033 -- * Primitives
3134 , Reflex (..)
3235 , mergeInt
3336 , coerceBehavior
3437 , coerceEvent
3538 , coerceDynamic
39+ , coerceIncremental
3640 , MonadSample (..)
3741 , MonadHold (..)
38− -- ** 'fan'-related types
42+ -- ** 'fan' related types
3943 , EventSelector (..)
44+ , EventSelectorG (..)
4045 , EventSelectorInt (..)
41− -- ** 'Incremental'-related types
4246 -- * Convenience functions
4347 , constDyn
4448 , pushAlways
4549 -- ** Combining 'Event's
4650 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
4754 , mergeMap
55+ , mergeIntMap
4856 , mergeMapIncremental
4957 , mergeMapIncrementalWithMove
58+ , mergeIntMapIncremental
59+ , coincidencePatchMap
60+ , coincidencePatchMapWithMove
61+ , coincidencePatchIntMap
5062 , mergeList
5163 , mergeWith
5264 , difference
5365 , alignEventWithMaybe
5466 -- ** Breaking up 'Event's
5567 , splitE
68+ , fan
5669 , fanEither
5770 , fanThese
5871 , fanMap
@@ -60,11 +73,16 @@ module Reflex.Class
6073 , EitherTag (..)
6174 , eitherToDSum
6275 , dsumToEither
63− -- ** Switching between 'Event's
64− , switchPromptly
65− , switchPromptOnly
76+ , factorEvent
77+ , filterEventKey
78+ -- ** Collapsing 'Event . Event'
79+ , switchHold
80+ , switchHoldPromptly
81+ , switchHoldPromptOnly
82+ , switchHoldPromptOnlyIncremental
6683 -- ** Using 'Event's to sample 'Behavior's
6784 , tag
85+ , tagMaybe
6886 , attach
6987 , attachWith
7088 , attachWithMaybe
@@ -72,6 +90,7 @@ module Reflex.Class
7290 , gate
7391 -- ** Combining 'Dynamic's
7492 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
7594 , distributeListOverDyn
7695 , distributeListOverDynWith
7796 , zipDyn
@@ -98,6 +117,14 @@ module Reflex.Class
98117 , mapAccumM_
99118 , mapAccumMaybe_
100119 , mapAccumMaybeM_
120+ , accumIncremental
121+ , accumMIncremental
122+ , accumMaybeIncremental
123+ , accumMaybeMIncremental
124+ , mapAccumIncremental
125+ , mapAccumMIncremental
126+ , mapAccumMaybeIncremental
127+ , mapAccumMaybeMIncremental
101128 , zipListWithEvent
102129 , numberOccurrences
103130 , numberOccurrencesFrom
@@ -107,6 +134,9 @@ module Reflex.Class
107134 , tailE
108135 , headTailE
109136 , takeWhileE
137+ , takeWhileJustE
138+ , dropWhileE
139+ , takeDropWhileJustE
110140 , switcher
111141 -- * Debugging functions
112142 , traceEvent
@@ -114,21 +144,24 @@ module Reflex.Class
114144 -- * Unsafe functions
115145 , unsafeDynamic
116146 , unsafeMapIncremental
117− -- * 'FunctorMaybe'
118− , FunctorMaybe (..)
147+ -- * 'Filterable' convenience functions
148+ , FunctorMaybe -- fmapMaybe is purposely not exported from deprecated 'FunctorMaybe' and the new alias is exported instead
149+ , mapMaybe -- Re-exported for convenience
150+ , fmapMaybe
119151 , fforMaybe
120152 , ffilter
153+ , filterLeft
154+ , filterRight
121155 -- * Miscellaneous convenience functions
122156 , ffor
123− , MonadAdjust (..)
124− , sequenceDMapWithAdjust
125− , sequenceDMapWithAdjustWithMove
126− , mapMapWithAdjustWithMove
157+ , ffor2
158+ , ffor3
127159 -- * Deprecated functions
128− , appendEvents
129− , onceE
130− , sequenceThese
160+ , switchPromptly
161+ , switchPromptOnly
162+ -- * "Cheap" functions
131163 , fmapMaybeCheap
164+ , mapMaybeCheap
132165 , fmapCheap
133166 , fforCheap
134167 , fforMaybeCheap
@@ -138,97 +171,63 @@ module Reflex.Class
138171 , mergeWithCheap'
139172 -- * Slow, but general, implementations
140173 , slowHeadE
141−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
142− , Spider
143− , SpiderEnv
144− , SpiderTimeline
145− , Global
146− , Behavior (..)
147− , Event (..)
148− , Dynamic (..)
149− , Incremental (..)
150− , never
151− , constant
152− , push
153− , pushCheap
154− , pull
155− , merge
156− , fan
157− , switch
158− , coincidence
159− , current
160− , updated
161− , unsafeBuildDynamic
162− , unsafeBuildIncremental
163− , mergeIncremental
164− , mergeIncrementalWithMove
165− , currentIncremental
166− , updatedIncremental
167− , incrementalToDynamic
168− , behaviorCoercion
169− , eventCoercion
170− , dynamicCoercion
171−#endif
172174 ) where
173175
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+
174187import Control.Applicative
175−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
176−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
177−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
178−import Control.Monad.Trans.Cont (ContT ())
179−import Control.Monad.Trans.Except (ExceptT ())
180−import Control.Monad.Trans.RWS (RWST ())
181−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)
182195import Data.Align
183196import Data.Bifunctor
184197import Data.Coerce
185198import Data.Default
186−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
187201import qualified Data.Dependent.Map as DMap
188−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)
189206import Data.Foldable
190−import Data.Functor.Bind hiding (join)
191−import qualified Data.Functor.Bind as Bind
192−import Data.Functor.Constant
207+import Data.Functor.Bind
193208import Data.Functor.Misc
194209import Data.Functor.Plus
195210import Data.IntMap.Strict (IntMap)
196211import qualified Data.IntMap.Strict as IntMap
197212import Data.List.NonEmpty (NonEmpty (..))
198213import Data.Map (Map)
199−import Data.Maybe
200−import Data.Monoid hiding (Alt, (<>))
201−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
214+import Data.Semigroup (Semigroup (..))
215+import Data.Some (Some(Some))
202216import Data.String
203217import Data.These
204−import Data.Traversable
205218import Data.Type.Coercion
206−import Reflex.FunctorMaybe
207−import Reflex.Patch
208−import Data.FastMutableIntMap (PatchIntMap)
209−
210−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
211−import Reflex.Spider.Internal (EventM, Global, HasSpiderTimeline, SpiderHost (..), SpiderHostFrame (..),
212− SpiderPullM, SpiderPushM (..), behaviorHoldIdentity, dynamicConst,
213− dynamicCurrent, dynamicDynIdentity, dynamicHold, dynamicHoldIdentity,
214− dynamicUpdated, newMapDyn, readBehaviorTracked, readBehaviorUntracked,
215− runFrame, runSpiderHostFrame)
216−import qualified Reflex.Spider.Internal
217−import qualified Reflex.Spider.Internal as S
218−import Unsafe.Coerce
219−#endif
220−
221−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
222−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
223226
224227import Debug.Trace (trace)
225228
226−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
227−#include "Spider/SpiderTimeline.include.hs"
228−#endif
229−
230229-- | The 'Reflex' class contains all the primitive functionality needed for
231−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
230+-- Functional Reactive Programming (FRP). The @/t/@ type parameter indicates
232231-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
233232-- and the type of the timeline determines the FRP engine to be used. For most
234233-- purposes, the 'Reflex.Spider' implementation is recommended.
@@ -238,9 +237,6 @@ class ( MonadHold t (PushM t)
238237 , Functor (Dynamic t)
239238 , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
240239 , Monad (Dynamic t)
241−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
242− , t ~ SpiderTimeline Global
243−#endif
244240 ) => Reflex t where
245241 -- | A container for a value that can change over time. 'Behavior's can be
246242 -- sampled at will, but it is not possible to be notified when they change
@@ -263,7 +259,6 @@ class ( MonadHold t (PushM t)
263259 type PushM t :: * -> *
264260 -- | A monad for doing complex pull-based calculations efficiently
265261 type PullM t :: * -> *
266−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
267262 -- | An 'Event' with no occurrences
268263 never :: Event t a
269264 -- | Create a 'Behavior' that always has the given value
@@ -278,18 +273,23 @@ class ( MonadHold t (PushM t)
278273 -- recomputed whenever any of the read 'Behavior's changes
279274 pull :: PullM t a -> Behavior t a
280275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
281− -- 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
282277 -- that are occurring simultaneously
283− 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
284− -- | Efficiently fan-out an event to many destinations. This function should
285− -- be partially applied, and then the result applied repeatedly to create
286− -- child events
287− 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+
288288 -- | Create an 'Event' that will occur whenever the currently-selected input
289289 -- 'Event' occurs
290290 switch :: Behavior t (Event t a) -> Event t a
291− -- | Create an 'Event' that will occur whenever the input event is occurring
292− -- 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.
293293 coincidence :: Event t (Event t a) -> Event t a
294294 -- | Extract the 'Behavior' of a 'Dynamic'.
295295 current :: Dynamic t a -> Behavior t a
@@ -298,14 +298,19 @@ class ( MonadHold t (PushM t)
298298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
299299 -- recent firing of the given 'Event', if any.
300300 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
301− -- | 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
302302 -- in the same way that the accumulated application of patches would change
303303 -- that value.
304304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
305305 -- | Create a merge whose parents can change over time
306− 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)
307310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
308− 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)
309314 -- | Extract the 'Behavior' component of an 'Incremental'
310315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
311316 -- | Extract the 'Event' component of an 'Incremental'
@@ -321,86 +326,31 @@ class ( MonadHold t (PushM t)
321326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
322327 -- occurrence type
323328 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)
324333 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
325334 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
326−#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
327347
328348--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.
329351mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
330352mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
331353
332−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
333−instance t ~ SpiderTimeline Global => Reflex t where
334− newtype Behavior t a = SpiderBehavior { unSpiderBehavior :: Reflex.Spider.Internal.Behavior Global a }
335− newtype Event t a = SpiderEvent { unSpiderEvent :: Reflex.Spider.Internal.Event Global a }
336− newtype Dynamic t a = SpiderDynamic { unSpiderDynamic :: Reflex.Spider.Internal.Dynamic Global (Identity a) } -- deriving (Functor, Applicative, Monad)
337− newtype Incremental t p = SpiderIncremental { unSpiderIncremental :: Reflex.Spider.Internal.Dynamic Global p }
338− type PullM t = SpiderPullM Global
339− type PushM t = SpiderPushM Global
340−never :: Reflex t => Event t a
341−constant :: Reflex t => a -> Behavior t a
342−push :: Reflex t => (a -> PushM t (Maybe b)) -> Event t a -> Event t b
343−pushCheap :: Reflex t => (a -> PushM t (Maybe b)) -> Event t a -> Event t b
344−pull :: Reflex t => PullM t a -> Behavior t a
345−merge :: (Reflex t, GCompare k) => DMap k (Event t) -> Event t (DMap k Identity)
346−fan :: (Reflex t, GCompare k) => Event t (DMap k Identity) -> EventSelector t k
347−switch :: Reflex t => Behavior t (Event t a) -> Event t a
348−coincidence :: Reflex t => Event t (Event t a) -> Event t a
349−current :: Reflex t => Dynamic t a -> Behavior t a
350−updated :: Reflex t => Dynamic t a -> Event t a
351−unsafeBuildDynamic :: Reflex t => PullM t a -> Event t a -> Dynamic t a
352−unsafeBuildIncremental :: (Reflex t, Patch p) => PullM t (PatchTarget p) -> Event t p -> Incremental t p
353−mergeIncremental :: (Reflex t, GCompare k) => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
354−mergeIncrementalWithMove :: (Reflex t, GCompare k) => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
355−currentIncremental :: (Reflex t, Patch p) => Incremental t p -> Behavior t (PatchTarget p)
356−updatedIncremental :: (Reflex t, Patch p) => Incremental t p -> Event t p
357−incrementalToDynamic :: (Reflex t, Patch p) => Incremental t p -> Dynamic t (PatchTarget p)
358−behaviorCoercion :: Reflex t => Coercion a b -> Coercion (Behavior t a) (Behavior t b)
359−eventCoercion :: Reflex t => Coercion a b -> Coercion (Event t a) (Event t b)
360−dynamicCoercion :: Reflex t => Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
361−{-# INLINE never #-}
362−never = SpiderEvent S.eventNever
363−{-# INLINE constant #-}
364−constant = SpiderBehavior . S.behaviorConst
365−{-# INLINE push #-}
366−push f = SpiderEvent . S.push (coerce f) . unSpiderEvent
367−{-# INLINE pushCheap #-}
368−pushCheap f = SpiderEvent . S.pushCheap (coerce f) . unSpiderEvent
369−{-# INLINE pull #-}
370−pull = SpiderBehavior . S.pull . coerce
371−{-# INLINE merge #-}
372−merge = SpiderEvent . S.merge . S.dynamicConst . (coerce :: DMap k (Event (SpiderTimeline x)) -> DMap k (S.Event x))
373−{-# INLINE fan #-}
374−fan e = EventSelector $ SpiderEvent . S.select (S.fan (unSpiderEvent e))
375−{-# INLINE switch #-}
376−switch = SpiderEvent . S.switch . (coerce :: S.Behavior x (Event (SpiderTimeline x) a) -> S.Behavior x (S.Event x a)) . unSpiderBehavior
377−{-# INLINE coincidence #-}
378−coincidence = SpiderEvent . S.coincidence . (coerce :: S.Event x (Event (SpiderTimeline x) a) -> S.Event x (S.Event x a)) . unSpiderEvent
379−{-# INLINE current #-}
380−current = SpiderBehavior . S.dynamicCurrent . unSpiderDynamic
381−{-# INLINE updated #-}
382−updated = coerceEvent . SpiderEvent . dynamicUpdated . unSpiderDynamic
383−{-# INLINE unsafeBuildDynamic #-}
384−unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ S.unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
385−{-# INLINE unsafeBuildIncremental #-}
386−unsafeBuildIncremental readV0 dv = SpiderIncremental $ S.dynamicDyn $ S.unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
387−{-# INLINE mergeIncremental #-}
388−mergeIncremental = SpiderEvent . S.merge . (unsafeCoerce :: S.Dynamic x (PatchDMap k (Event (SpiderTimeline x))) -> S.Dynamic x (PatchDMap k (S.Event x))) . unSpiderIncremental
389−{-# INLINE mergeIncrementalWithMove #-}
390−mergeIncrementalWithMove = SpiderEvent . S.mergeWithMove . (unsafeCoerce :: S.Dynamic x (PatchDMapWithMove k (Event (SpiderTimeline x))) -> S.Dynamic x (PatchDMapWithMove k (S.Event x))) . unSpiderIncremental
391−{-# INLINE currentIncremental #-}
392−currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
393−{-# INLINE updatedIncremental #-}
394−updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
395−{-# INLINE incrementalToDynamic #-}
396−incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ S.unsafeBuildDynamic (readBehaviorUntracked $ dynamicCurrent i) $ flip S.push (dynamicUpdated i) $ \p -> do
397− c <- readBehaviorUntracked $ dynamicCurrent i
398− return $ Identity <$> apply p c
399−eventCoercion Coercion = Coercion
400−behaviorCoercion Coercion = Coercion
401−dynamicCoercion = unsafeCoerce
402−#endif
403−
404354-- | Coerce a 'Behavior' between representationally-equivalent value types
405355coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
406356coerceBehavior = coerceWith $ behaviorCoercion Coercion
@@ -413,8 +363,14 @@ coerceEvent = coerceWith $ eventCoercion Coercion
413363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
414364coerceDynamic = coerceWith $ dynamicCoercion Coercion
415365
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+
416372-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
417−-- _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
418374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
419375-- if this is not the case, the resulting 'Dynamic' will behave
420376-- nondeterministically.
@@ -442,7 +398,7 @@ class MonadSample t m => MonadHold t m where
442398 -- value and will be updated whenever the given 'Event' occurs. The update
443399 -- takes effect immediately after the 'Event' occurs; if the occurrence that
444400 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
445− -- 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
446402 -- one.
447403 hold :: a -> Event t a -> m (Behavior t a)
448404 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
@@ -457,16 +413,118 @@ class MonadSample t m => MonadHold t m where
457413 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
458414 default holdIncremental :: (Patch p, m ~ f m', MonadTrans f, MonadHold t m') => PatchTarget p -> Event t p -> m (Incremental t p)
459415 holdIncremental v0 = lift . holdIncremental v0
460− buildDynamic :: PullM t a -> Event t a -> m (Dynamic t a)
416+ buildDynamic :: PushM t a -> Event t a -> m (Dynamic t a)
461417 {-
462418 default buildDynamic :: (m ~ f m', MonadTrans f, MonadHold t m') => PullM t a -> Event t a -> m (Dynamic t a)
463419 buildDynamic getV0 = lift . buildDynamic getV0
464420 -}
465− -- | 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
466422 -- the supplied 'Event'.
467423 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'
468474
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')
469526
527+-- | A somewhat slow implementation of 'headE'
470528slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
471529slowHeadE e = do
472530 rec be <- hold e $ fmapCheap (const never) e'
@@ -475,18 +533,31 @@ slowHeadE e = do
475533
476534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
477535-- key. This is much more efficient than filtering for each key with
478−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
479537newtype EventSelector t k = EventSelector
480538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
481539 -- determined by the type of the key, so this can be used to fan-out
482540 -- 'Event's whose sub-'Event's have different types.
483541 --
484542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
485− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
486544 -- occurrences of an 'Event'.
487545 select :: forall a. k a -> Event t a
488546 }
489547
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.
490561newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
491562
492563--------------------------------------------------------------------------------
@@ -502,6 +573,7 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
502573 holdIncremental a0 = lift . holdIncremental a0
503574 buildDynamic a0 = lift . buildDynamic a0
504575 headE = lift . headE
576+ now = lift now
505577
506578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
507579 sample = lift . sample
@@ -512,6 +584,7 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
512584 holdIncremental a0 = lift . holdIncremental a0
513585 buildDynamic a0 = lift . buildDynamic a0
514586 headE = lift . headE
587+ now = lift now
515588
516589instance MonadSample t m => MonadSample t (StateT s m) where
517590 sample = lift . sample
@@ -522,6 +595,7 @@ instance MonadHold t m => MonadHold t (StateT s m) where
522595 holdIncremental a0 = lift . holdIncremental a0
523596 buildDynamic a0 = lift . buildDynamic a0
524597 headE = lift . headE
598+ now = lift now
525599
526600instance MonadSample t m => MonadSample t (ExceptT e m) where
527601 sample = lift . sample
@@ -532,6 +606,7 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
532606 holdIncremental a0 = lift . holdIncremental a0
533607 buildDynamic a0 = lift . buildDynamic a0
534608 headE = lift . headE
609+ now = lift now
535610
536611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
537612 sample = lift . sample
@@ -542,6 +617,7 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
542617 holdIncremental a0 = lift . holdIncremental a0
543618 buildDynamic a0 = lift . buildDynamic a0
544619 headE = lift . headE
620+ now = lift now
545621
546622instance MonadSample t m => MonadSample t (ContT r m) where
547623 sample = lift . sample
@@ -552,6 +628,7 @@ instance MonadHold t m => MonadHold t (ContT r m) where
552628 holdIncremental a0 = lift . holdIncremental a0
553629 buildDynamic a0 = lift . buildDynamic a0
554630 headE = lift . headE
631+ now = lift now
555632
556633--------------------------------------------------------------------------------
557634-- Convenience functions
@@ -566,6 +643,14 @@ pushAlways f = push (fmap Just . f)
566643ffor :: Functor f => f a -> (a -> b) -> f b
567644ffor = flip fmap
568645
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+
569654instance Reflex t => Applicative (Behavior t) where
570655 pure = constant
571656 f <*> x = pull $ sample f `ap` sample x
@@ -593,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
593678 a >>= f = pull $ sample a >>= sample . f
594679 -- 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.
595680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
596682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
597684
598685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
599686 mempty = constant mempty
@@ -609,32 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
609696 negate = fmap negate
610697 signum = fmap signum
611698
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+
612708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
613709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
614710 sconcat = pull . fmap sconcat . mapM sample
615−#if MIN_VERSION_semigroups(0,17,0)
616711 stimes n = fmap $ stimes n
617−#else
618− times1p n = fmap $ times1p n
619−#endif
620712
621−-- | Flipped version of 'fmapMaybe'.
622−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
623−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
624720
625721-- | Filter 'f a' using the provided predicate.
626−-- Relies on 'fforMaybe'.
627−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
628−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
724+
725+-- | Filter 'Left's from 'f (Either a b)' into 'a'.
726+filterLeft :: Filterable f => f (Either a b) -> f a
727+filterLeft = mapMaybe (either Just (const Nothing))
728+
729+-- | Filter 'Right's from 'f (Either a b)' into 'b'.
730+filterRight :: Filterable f => f (Either a b) -> f b
731+filterRight = mapMaybe (either (const Nothing) Just)
629732
630733-- | Left-biased event union (prefers left event on simultaneous
631734-- occurrence).
632735instance Reflex t => Alt (Event t) where
633736 ev1 <!> ev2 = leftmost [ev1, ev2]
634737
635−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
636739instance Reflex t => Apply (Event t) where
637− 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+
638744
639745-- | 'Event' intersection (convenient interface to 'coincidence').
640746instance Reflex t => Bind (Event t) where
@@ -643,13 +749,18 @@ instance Reflex t => Bind (Event t) where
643749
644750instance Reflex t => Functor (Event t) where
645751 {-# INLINE fmap #-}
646− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
647753 {-# INLINE (<$) #-}
648754 x <$ e = fmapCheap (const x) e
649755
756+-- TODO Remove this instance
650757instance Reflex t => FunctorMaybe (Event t) where
651758 {-# INLINE fmapMaybe #-}
652− 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
653764
654765-- | Never: @'zero' = 'never'@.
655766instance Reflex t => Plus (Event t) where
@@ -660,7 +771,13 @@ instance Reflex t => Plus (Event t) where
660771tag :: Reflex t => Behavior t b -> Event t a -> Event t b
661772tag b = pushAlways $ \_ -> sample b
662773
663−-- | 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
664781-- current value of the 'Behavior'.
665782attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
666783attach = attachWith (,)
@@ -670,53 +787,118 @@ attach = attachWith (,)
670787attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
671788attachWith f = attachWithMaybe $ \a b -> Just $ f a b
672789
673−-- | 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
674791-- the 'Behavior'. The occurrence is discarded if the combining function returns
675792-- Nothing
676793attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
677794attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
678795
679−-- | 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
680797-- supplied 'Event'.
681−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)
682799tailE e = snd <$> headTailE e
683800
684−-- | Create a tuple of two 'Event's with the first one occuring only the first
685−-- time the supplied 'Event' occurs and the second occuring on all but the first
686−-- occurence.
687−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)
688805headTailE e = do
689806 eHead <- headE e
690807 be <- hold never $ fmap (const e) eHead
691808 return (eHead, switch be)
692809
693−-- | Starting at the current time, fire all the occurrences of the 'Event' for
694−-- which the given predicate returns 'True'. When 'False' is returned, do not
695−-- fire, and permanently stop firing, even if 'True' values are encountered
696−-- later.
697−takeWhileE :: forall t m a. (Reflex t, MonadFix m, MonadHold t m) => (a -> Bool) -> Event t a -> m (Event t a)
698−takeWhileE f e = do
699− rec let (eFalse, eTrue) = fanEither $ ffor e' $ \a -> if f a
700− then Right a
701− else Left never
702− be <- hold e eFalse
703− 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
704844 return eTrue
705845
706−-- | 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
707889-- same time with the respective values from the tuple.
708890splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
709891splitE e = (fmap fst e, fmap snd e)
710892
711893-- | Print the supplied 'String' and the value of the 'Event' on each
712−-- occurence. This should /only/ be used for debugging.
894+-- occurrence. This should /only/ be used for debugging.
713895--
714896-- Note: As with Debug.Trace.trace, the message will only be printed if the
715897-- 'Event' is actually used.
716898traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
717899traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
718900
719−-- | 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
720902-- 'Event'. This should /only/ be used for debugging.
721903--
722904-- Note: As with Debug.Trace.trace, the message will only be printed if the
@@ -727,11 +909,7 @@ traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
727909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
728910 (<>) = alignWith (mergeThese (<>))
729911 sconcat = fmap sconcat . mergeList . toList
730−#if MIN_VERSION_semigroups(0,17,0)
731912 stimes n = fmap $ stimes n
732−#else
733− times1p n = fmap $ times1p n
734−#endif
735913
736914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
737915 mempty = never
@@ -760,25 +938,38 @@ leftmost :: Reflex t => [Event t a] -> Event t a
760938leftmost = mergeWith const
761939
762940-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
763−-- 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
764942-- time.
765943mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
766944mergeList [] = never
767945mergeList es = mergeWithFoldCheap' id es
768946
769−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'
770953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
771954
772955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
773956-- occurs if at least one of them occurs and has a map of values of all 'Event's
774−-- occuring at that time.
957+-- occurring at that time.
775958mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
776959mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
777960
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+
778965-- | Create a merge whose parents can change over time
779966mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
780967mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
781968
969+-- | Create a merge whose parents can change over time
970+mergeIntMapIncremental :: Reflex t => Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
971+mergeIntMapIncremental = fmap dmapToIntMap . mergeIncremental . unsafeMapIncremental intMapWithFunctorToDMap (const2IntPatchDMapWith id)
972+
782973-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
783974mergeMapIncrementalWithMove :: (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Event t a)) -> Event t (Map k a)
784975mergeMapIncrementalWithMove = fmap dmapToMap . mergeIncrementalWithMove . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWithMoveWith id)
@@ -788,7 +979,7 @@ fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
788979fanEither e =
789980 let justLeft = either Just (const Nothing)
790981 justRight = either (const Nothing) Just
791− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
792983
793984-- | Split the event into separate events for 'This' and 'That' values,
794985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -800,47 +991,141 @@ fanThese e =
800991 that (That y) = Just y
801992 that (These _ y) = Just y
802993 that _ = Nothing
803− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
804995
805996-- | Split the event into an 'EventSelector' that allows efficient selection of
806997-- the individual 'Event's.
807998fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
808999fanMap = fan . fmap mapToDMap
8091000
810−-- | Switches to the new event whenever it receives one. Whenever a new event
811−-- is provided, if it is firing, its value will be the resulting event's value;
812−-- if it is not firing, but the old one is, the old one's value will be used.
813−switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
814−switchPromptly ea0 eea = do
1001+-- | Switches to the new event whenever it receives one. Only the old event is
1002+-- considered the moment a new one is switched in; the output event will fire at
1003+-- that moment only if the old event does.
1004+--
1005+-- Because the simultaneous firing case is irrelevant, this function imposes
1006+-- laxer "timing requirements" on the overall circuit, avoiding many potential
1007+-- cyclic dependency / metastability failures. It's also more performant. Use
1008+-- this rather than 'switchHoldPromptly' and 'switchHoldPromptOnly' unless you
1009+-- are absolutely sure you need to act on the new event in the coincidental
1010+-- case.
1011+switchHold :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1012+switchHold ea0 eea = switch <$> hold ea0 eea
1013+
1014+-- | Switches to the new event whenever it receives one. Whenever a new event is
1015+-- provided, if it is firing, its value will be the resulting event's value; if
1016+-- it is not firing, but the old one is, the old one's value will be used.
1017+--
1018+-- 'switchHold', by always forwarding the old event the moment it is switched
1019+-- out, avoids many potential cyclic dependency problems / metastability
1020+-- problems. It's also more performant. Use it instead unless you are sure you
1021+-- cannot.
1022+switchHoldPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1023+switchHoldPromptly ea0 eea = do
8151024 bea <- hold ea0 eea
8161025 let eLag = switch bea
8171026 eCoincidences = coincidence eea
8181027 return $ leftmost [eCoincidences, eLag]
8191028
820−-- | 'switch'es to a new event whenever it receives one. At the moment of
1029+-- | switches to a new event whenever it receives one. At the moment of
8211030-- switching, the old event will be ignored if it fires, and the new one will be
8221031-- used if it fires; this is the opposite of 'switch', which will use only the
8231032-- old value.
824−switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
825−switchPromptOnly e0 e' = do
1033+--
1034+-- 'switchHold', by always forwarding the old event the moment it is switched
1035+-- out, avoids many potential cyclic dependency problems / metastability
1036+-- problems. It's also more performant. Use it instead unless you are sure you
1037+-- cannot.
1038+switchHoldPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1039+switchHoldPromptOnly e0 e' = do
8261040 eLag <- switch <$> hold e0 e'
8271041 return $ coincidence $ leftmost [e', eLag <$ eLag]
8281042
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+
8291094instance Reflex t => Align (Event t) where
8301095 nil = never
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
8311099 align = alignEventWithMaybe Just
8321100
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+
8331115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
834−-- the 'Behavior' is true at the time of occurence.
1116+-- the 'Behavior' is true at the time of occurrence.
8351117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
8361118gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
8371119
838−-- | Create a new behavior given a starting behavior and switch to a the behvior
839−-- 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.
8401122switcher :: (Reflex t, MonadHold t m)
8411123 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
8421124switcher b eb = pull . (sample <=< sample) <$> hold b eb
8431125
1126+instance (Reflex t, IsString a) => IsString (Dynamic t a) where
1127+ fromString = pure . fromString
1128+
8441129-- | Combine two 'Dynamic's. The result will change whenever either (or both)
8451130-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
8461131zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
@@ -848,7 +1133,7 @@ zipDyn = zipDynWith (,)
8481133
8491134-- | Combine two 'Dynamic's with a combining function. The result will change
8501135-- whenever either (or both) input 'Dynamic' changes.
851−-- More efficient than liftA2.
1136+-- More efficient than 'liftA2'.
8521137zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
8531138zipDynWith f da db =
8541139 let eab = align (updated da) (updated db)
@@ -864,6 +1149,10 @@ zipDynWith f da db =
8641149 return $ Just $ f a b
8651150 in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
8661151
1152+instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
1153+ (<>) = zipDynWith (<>)
1154+ stimes n = fmap $ stimes n
1155+
8671156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
8681157 mconcat = distributeListOverDynWith mconcat
8691158 mempty = constDyn mempty
@@ -871,14 +1160,23 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
8711160
8721161-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
8731162-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
874−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
1163+-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
8751164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
876−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
8771175 [] -> constDyn DMap.empty
878− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
8791177 _ ->
880− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
881− 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
8821180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
8831181 olds <- sample $ current result
8841182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -890,21 +1188,73 @@ distributeListOverDyn = distributeListOverDynWith id
8901188
8911189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
8921190distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
893−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
8941201
8951202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
8961203-- unless the second supplied 'Event' occurs simultaneously.
8971204difference :: Reflex t => Event t a -> Event t b -> Event t a
8981205difference = alignEventWithMaybe $ \case
8991206 This a -> Just a
900− _ -> Nothing
1207+ _ -> Nothing
9011208
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
1210+-- 'Nothing' values are dropped.
9021211alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
903−alignEventWithMaybe f ea eb =
904− fmapMaybe (f <=< dmapToThese)
905− $ merge
906− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
907−
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)
9081258
9091259--------------------------------------------------------------------------------
9101260-- Accumulator
@@ -934,26 +1284,94 @@ class Reflex t => Accumulator t f | f -> t where
9341284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
9351285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
9361286
937−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)
9381295accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
939−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)
9401305accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
941−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)
9421315accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
943−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)
9441325accumMaybeMDyn f z e = do
9451326 rec let e' = flip push e $ \o -> do
9461327 v <- sample $ current d'
9471328 f v o
9481329 d' <- holdDyn z e'
9491330 return d'
950−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)
9511341mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
952−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)
9531351mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
954−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)
9551365mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
956−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)
9571375mapAccumMaybeMDyn f z e = do
9581376 rec let e' = flip push e $ \o -> do
9591377 v <- sample $ current d'
@@ -961,18 +1379,42 @@ mapAccumMaybeMDyn f z e = do
9611379 return $ case result of
9621380 (Nothing, Nothing) -> Nothing
9631381 _ -> Just result
964− d' <- holdDyn z $ fmapMaybe fst e'
965− return (d', fmapMaybe snd e')
1382+ d' <- holdDyn z $ mapMaybe fst e'
1383+ return (d', mapMaybe snd e')
9661384
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
9671387{-# INLINE accumB #-}
968−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)
9691394accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
9701397{-# INLINE accumMB #-}
971−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)
9721404accumMB 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.
9731408{-# INLINE accumMaybeB #-}
974−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)
9751415accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
9761418{-# INLINE accumMaybeMB #-}
9771419accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
9781420accumMaybeMB f z e = do
@@ -981,16 +1423,42 @@ accumMaybeMB f z e = do
9811423 f v o
9821424 d' <- hold z e'
9831425 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'.
9841430{-# INLINE mapAccumB #-}
985−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)
9861437mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
9871440{-# INLINE mapAccumMB #-}
988−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)
9891447mapAccumMB 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.
9901452{-# INLINE mapAccumMaybeB #-}
991−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)
9921459mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
9931460
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
9941462{-# INLINE mapAccumMaybeMB #-}
9951463mapAccumMaybeMB :: (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)
9961464mapAccumMaybeMB f z e = do
@@ -1000,8 +1468,8 @@ mapAccumMaybeMB f z e = do
10001468 return $ case result of
10011469 (Nothing, Nothing) -> Nothing
10021470 _ -> Just result
1003− d' <- hold z $ fmapMaybe fst e'
1004− return (d', fmapMaybe snd e')
1471+ d' <- hold z $ mapMaybe fst e'
1472+ return (d', mapMaybe snd e')
10051473
10061474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
10071475-- time. Discard the underlying 'Accumulator'.
@@ -1048,7 +1516,7 @@ instance Reflex t => Accumulator t (Event t) where
10481516 accumMaybeM f z e = updated <$> accumMaybeM f z e
10491517 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
10501518
1051−-- | 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
10521520-- list using the supplied function. If the list runs out of items, all
10531521-- subsequent 'Event' occurrences will be ignored.
10541522zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
@@ -1058,20 +1526,20 @@ zipListWithEvent f l e = do
10581526 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
10591527 mapAccumMaybe_ f' l e
10601528
1061−-- | 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
10621530{-# INLINE numberOccurrences #-}
10631531numberOccurrences :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Event t (b, a))
10641532numberOccurrences = numberOccurrencesFrom 0
10651533
1066−-- | Assign a number to each occurence of the given 'Event'
1534+-- | Assign a number to each occurrence of the given 'Event'
10671535{-# INLINE numberOccurrencesFrom #-}
10681536numberOccurrencesFrom :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t (b, a))
1069−numberOccurrencesFrom = mapAccum_ (\n a -> (n + 1, (n, a)))
1537+numberOccurrencesFrom = mapAccum_ (\n a -> let !next = n + 1 in (next, (n, a)))
10701538
1071−-- | 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
10721540{-# INLINE numberOccurrencesFrom_ #-}
10731541numberOccurrencesFrom_ :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t b)
1074−numberOccurrencesFrom_ = mapAccum_ (\n _ -> (n + 1, n))
1542+numberOccurrencesFrom_ = mapAccum_ (\n _ -> let !next = n + 1 in (next, n))
10751543
10761544-- | This is used to sample the value of a 'Behavior' using an 'Event'.
10771545--
@@ -1141,79 +1609,74 @@ infixl 4 <@>
11411609(<@) = tag
11421610infixl 4 <@
11431611
1144−-- | A 'Monad' that supports adjustment over time. After an action has been
1145−-- run, if the given events fire, it will adjust itself so that its net effect
1146−-- is as though it had originally been run with the new value. Note that there
1147−-- is some issue here with persistent side-effects: obviously, IO (and some
1148−-- other side-effects) cannot be undone, so it is up to the instance implementer
1149−-- to determine what the best meaning for this class is in such cases.
1150−class (Reflex t, Monad m) => MonadAdjust t m | m -> t where
1151− runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
1152− traverseIntMapWithKeyWithAdjust :: (IntMap.Key -> v -> m v') -> IntMap v -> Event t (PatchIntMap v) -> m (IntMap v', Event t (PatchIntMap v'))
1153− 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'))
1154− 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'))
1155−
1156−instance MonadAdjust t m => MonadAdjust t (ReaderT r m) where
1157− runWithReplace a0 a' = do
1158− r <- ask
1159− lift $ runWithReplace (runReaderT a0 r) $ fmap (`runReaderT` r) a'
1160− traverseIntMapWithKeyWithAdjust f dm0 dm' = do
1161− r <- ask
1162− lift $ traverseIntMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1163− traverseDMapWithKeyWithAdjust f dm0 dm' = do
1164− r <- ask
1165− lift $ traverseDMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1166− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
1167− r <- ask
1168− lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
1169−
1170−sequenceDMapWithAdjust :: (GCompare k, MonadAdjust t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
1171−sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
1172−
1173−sequenceDMapWithAdjustWithMove :: (GCompare k, MonadAdjust t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
1174−sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
1175−
1176−mapMapWithAdjustWithMove :: forall t m k v v'. (MonadAdjust t m, Ord k) => (k -> v -> m v') -> Map k v -> Event t (PatchMapWithMove k v) -> m (Map k v', Event t (PatchMapWithMove k v'))
1177−mapMapWithAdjustWithMove f m0 m' = do
1178− (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
1179− return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
1180−
11811612------------------
11821613-- Cheap Functions
11831614------------------
11841615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
11851617{-# INLINE pushAlwaysCheap #-}
11861618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
11871619pushAlwaysCheap f = pushCheap (fmap Just . f)
11881620
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'
11891627{-# INLINE fmapMaybeCheap #-}
11901628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1191−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
1630+
11921631
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
11931633{-# INLINE fforMaybeCheap #-}
11941634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1195−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
11961636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
11971638{-# INLINE fforCheap #-}
11981639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
11991640fforCheap = flip fmapCheap
12001641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
12011643{-# INLINE fmapCheap #-}
12021644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
12031645fmapCheap f = pushCheap $ return . Just . f
12041646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
12051648{-# INLINE tagCheap #-}
12061649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
12071650tagCheap b = pushAlwaysCheap $ \_ -> sample b
12081651
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'.
12091670{-# INLINE mergeWithCheap #-}
12101671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
12111672mergeWithCheap = mergeWithCheap' id
12121673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
12131675{-# INLINE mergeWithCheap' #-}
12141676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
12151677mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
12161678
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
12171680{-# INLINE mergeWithFoldCheap' #-}
12181681mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
12191682mergeWithFoldCheap' f es =
@@ -1226,24 +1689,11 @@ mergeWithFoldCheap' f es =
12261689-- Deprecated functions
12271690--------------------------------------------------------------------------------
12281691
1229−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
1230−-- occurs. If both occur at the same time they are combined using 'mappend'.
1231−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
1232−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
1233−appendEvents = alignWith $ mergeThese mappend
1234−
1235−-- | Alias for 'headE'
1236−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1237−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
1238−onceE = headE
1239−
1240−-- | Run both sides of a 'These' monadically, combining the results.
1241−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
1242−#ifdef USE_TEMPLATE_HASKELL
1243−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
1244−#endif
1245−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
1246−sequenceThese t = case t of
1247− This ma -> fmap This ma
1248− These ma mb -> liftM2 These ma mb
1249− That mb -> fmap That mb
1692+{-# DEPRECATED switchPromptly "Use 'switchHoldPromptly' instead. The 'switchHold*' naming convention was chosen because those functions are more closely related to each other than they are to 'switch'. " #-}
1693+-- | See 'switchHoldPromptly'
1694+switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1695+switchPromptly = switchHoldPromptly
1696+{-# DEPRECATED switchPromptOnly "Use 'switchHoldPromptOnly' instead. The 'switchHold*' naming convention was chosen because those functions are more closely related to each other than they are to 'switch'. " #-}
1697+-- | See 'switchHoldPromptOnly'
1698+switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1699+switchPromptOnly = switchHoldPromptOnly
src/Reflex/Collection.hsnew file+225
@@ -0,0 +1,225 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleInstances #-}
3+{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE RecursiveDo #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+-- |
14+-- Module:
15+-- Reflex.Collection
16+module Reflex.Collection
17+ (
18+ -- * Widgets on Collections
19+ listHoldWithKey
20+ , listWithKey
21+ , listWithKeyShallowDiff
22+ , listViewWithKey
23+ , selectViewListWithKey
24+ , selectViewListWithKey_
25+ -- * List Utils
26+ , list
27+ , simpleList
28+ ) where
29+
30+#ifdef MIN_VERSION_semialign
31+import Prelude hiding (zip, zipWith)
32+#if MIN_VERSION_semialign(1,1,0)
33+import Data.Zip (Zip (..))
34+#endif
35+#endif
36+
37+import Control.Monad.Identity
38+import Data.Align
39+import Data.Functor.Misc
40+import Data.Map (Map)
41+import qualified Data.Map as Map
42+import Data.Map.Misc
43+import Data.These
44+
45+import Reflex.Class
46+import Reflex.Adjustable.Class
47+import Reflex.Dynamic
48+import Reflex.PostBuild.Class
49+
50+-- | Create a set of widgets based on the provided 'Map'. When the
51+-- input 'Event' fires, remove widgets for keys with the value 'Nothing'
52+-- and add/replace widgets for keys with 'Just' values.
53+listHoldWithKey
54+ :: forall t m k v a
55+ . (Ord k, Adjustable t m, MonadHold t m)
56+ => Map k v
57+ -> Event t (Map k (Maybe v))
58+ -> (k -> v -> m a)
59+ -> m (Dynamic t (Map k a))
60+listHoldWithKey m0 m' f = do
61+ let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
62+ dm' = fmap
63+ (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey
64+ (\k v -> ComposeMaybe $ fmap (f k) v)
65+ )
66+ m'
67+ (a0, a') <- sequenceDMapWithAdjust dm0 dm'
68+
69+ --TODO: Move the dmapToMap to the righthand side so it doesn't get
70+ --fully redone every time
71+ fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a'
72+
73+--TODO: Something better than Dynamic t (Map k v) - we want something
74+--where the Events carry diffs, not the whole value
75+listWithKey
76+ :: forall t k v m a
77+ . (Ord k, Adjustable t m, PostBuild t m, MonadFix m, MonadHold t m)
78+ => Dynamic t (Map k v)
79+ -> (k -> Dynamic t v -> m a)
80+ -> m (Dynamic t (Map k a))
81+listWithKey vals mkChild = do
82+ postBuild <- getPostBuild
83+ let childValChangedSelector = fanMap $ updated vals
84+
85+ -- We keep track of changes to children values in the mkChild
86+ -- function we pass to listHoldWithKey The other changes we need
87+ -- to keep track of are child insertions and
88+ -- deletions. diffOnlyKeyChanges keeps track of insertions and
89+ -- deletions but ignores value changes, since they're already
90+ -- accounted for.
91+ diffOnlyKeyChanges olds news =
92+ flip Map.mapMaybe (align olds news) $ \case
93+ This _ -> Just Nothing
94+ These _ _ -> Nothing
95+ That new -> Just $ Just new
96+ rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
97+ let changeVals :: Event t (Map k (Maybe v))
98+ changeVals =
99+ attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
100+ [ updated vals
101+
102+ -- TODO: This should probably be added to the
103+ -- attachWith, not to the updated; if we were using
104+ -- diffMap instead of diffMapNoEq, I think it might not
105+ -- work
106+ , tag (current vals) postBuild
107+ ]
108+ listHoldWithKey Map.empty changeVals $ \k v ->
109+ mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
110+
111+-- | Display the given map of items (in key order) using the builder
112+-- function provided, and update it with the given event. 'Nothing'
113+-- update entries will delete the corresponding children, and 'Just'
114+-- entries will create them if they do not exist or send an update
115+-- event to them if they do.
116+listWithKeyShallowDiff
117+ :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m)
118+ => Map k v
119+ -> Event t (Map k (Maybe v))
120+ -> (k -> v -> Event t v -> m a)
121+ -> m (Dynamic t (Map k a))
122+listWithKeyShallowDiff initialVals valsChanged mkChild = do
123+ let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
124+ sentVals <- foldDyn applyMap (void initialVals) $ fmap (fmap void) valsChanged
125+ let relevantPatch patch _ = case patch of
126+
127+ -- Even if we let a Nothing through when the element doesn't
128+ -- already exist, this doesn't cause a problem because it is
129+ -- ignored
130+ Nothing -> Just Nothing
131+
132+ -- We don't want to let spurious re-creations of items through
133+ Just _ -> Nothing
134+ listHoldWithKey
135+ initialVals
136+ (attachWith (flip (Map.differenceWith relevantPatch))
137+ (current sentVals)
138+ valsChanged
139+ )
140+ $ \k v -> mkChild k v $ select childValChangedSelector $ Const2 k
141+
142+--TODO: Something better than Dynamic t (Map k v) - we want something
143+--where the Events carry diffs, not the whole value
144+-- | Create a dynamically-changing set of Event-valued widgets. This
145+-- is like 'listWithKey', specialized for widgets returning @/Event t a/@.
146+-- 'listWithKey' would return @/Dynamic t (Map k (Event t a))/@ in
147+-- this scenario, but 'listViewWithKey' flattens this to
148+-- @/Event t (Map k a)/@ via 'switch'.
149+listViewWithKey
150+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
151+ => Dynamic t (Map k v)
152+ -> (k -> Dynamic t v -> m (Event t a))
153+ -> m (Event t (Map k a))
154+listViewWithKey vals mkChild =
155+ switch . fmap mergeMap <$> listViewWithKey' vals mkChild
156+
157+listViewWithKey'
158+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
159+ => Dynamic t (Map k v)
160+ -> (k -> Dynamic t v -> m a)
161+ -> m (Behavior t (Map k a))
162+listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
163+
164+-- | Create a dynamically-changing set of widgets, one of which is
165+-- selected at any time.
166+selectViewListWithKey
167+ :: forall t m k v a
168+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
169+ => Dynamic t k
170+ -- ^ Current selection key
171+ -> Dynamic t (Map k v)
172+ -- ^ Dynamic key/value map
173+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
174+ -- ^ Function to create a widget for a given key from Dynamic value
175+ -- and Dynamic Bool indicating if this widget is currently selected
176+ -> m (Event t (k, a))
177+ -- ^ Event that fires when any child's return Event fires. Contains
178+ -- key of an arbitrary firing widget.
179+selectViewListWithKey selection vals mkChild = do
180+ -- For good performance, this value must be shared across all children
181+ let selectionDemux = demux selection
182+ selectChild <- listWithKey vals $ \k v -> do
183+ let selected = demuxed selectionDemux k
184+ selectSelf <- mkChild k v selected
185+ return $ fmap ((,) k) selectSelf
186+ return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
187+
188+-- | Like 'selectViewListWithKey' but discards the value of the list
189+-- item widget's output 'Event'.
190+selectViewListWithKey_
191+ :: forall t m k v a
192+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
193+ => Dynamic t k
194+ -- ^ Current selection key
195+ -> Dynamic t (Map k v)
196+ -- ^ Dynamic key/value map
197+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
198+ -- ^ Function to create a widget for a given key from Dynamic value
199+ -- and Dynamic Bool indicating if this widget is currently selected
200+ -> m (Event t k)
201+ -- ^ Event that fires when any child's return Event fires. Contains
202+ -- key of an arbitrary firing widget.
203+selectViewListWithKey_ selection vals mkChild =
204+ fmap fst <$> selectViewListWithKey selection vals mkChild
205+
206+-- | Create a dynamically-changing set of widgets from a Dynamic
207+-- key/value map. Unlike the 'withKey' variants, the child widgets
208+-- are insensitive to which key they're associated with.
209+list
210+ :: (Ord k, Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
211+ => Dynamic t (Map k v)
212+ -> (Dynamic t v -> m a)
213+ -> m (Dynamic t (Map k a))
214+list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
215+
216+-- | Create a dynamically-changing set of widgets from a Dynamic list.
217+simpleList
218+ :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
219+ => Dynamic t [v]
220+ -> (Dynamic t v -> m a)
221+ -> m (Dynamic t [a])
222+simpleList xs mkChild =
223+ fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap
224+ (Map.fromList . zip [(1 :: Int) ..])
225+ xs
src/Reflex/Dynamic.hs+92−234
@@ -17,17 +17,24 @@
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
2529 , current
2630 , updated
2731 , holdDyn
32+ , mapDynM
33+ , forDynM
2834 , constDyn
2935 , count
3036 , toggle
37+ , switchDyn
3138 , switchPromptlyDyn
3239 , tagPromptlyDyn
3340 , attachPromptlyDyn
@@ -46,15 +53,18 @@ module Reflex.Dynamic
4653 , foldDynMaybe
4754 , foldDynMaybeM
4855 , joinDynThroughMap
56+ , joinDynThroughIntMap
4957 , traceDyn
5058 , traceDynWith
5159 , splitDynPure
5260 , distributeMapOverDynPure
61+ , distributeIntMapOverDynPure
5362 , distributeDMapOverDynPure
5463 , distributeListOverDynPure
5564 , Demux
5665 , demux
5766 , demuxed
67+ -- * Miscellaneous
5868 -- Things that probably aren't very useful:
5969 , HList (..)
6070 , FHList (..)
@@ -64,36 +74,14 @@ module Reflex.Dynamic
6474 , AllAreFunctors (..)
6575 , HListPtr (..)
6676 , distributeFHListOverDynPure
67− -- Unsafe
77+ -- * Unsafe
6878 , unsafeDynamic
69− -- * Deprecated functions
70− , apDyn
71− , attachDyn
72− , attachDynWith
73− , attachDynWithMaybe
74− , collectDyn
75− , combineDyn
76− , distributeDMapOverDyn
77− , distributeFHListOverDyn
78− , forDyn
79− , forDynM
80− , getDemuxed
81− , joinDyn
82− , mapDyn
83− , mapDynM
84− , mconcatDyn
85− , nubDyn
86− , splitDyn
87− , tagDyn
88− , uniqDyn
89− , uniqDynBy
9079 ) where
9180
9281import Data.Functor.Compose
9382import Data.Functor.Misc
9483import Reflex.Class
9584
96−import Control.Applicative ((<*>))
9785import Control.Monad
9886import Control.Monad.Fix
9987import Control.Monad.Identity
@@ -101,14 +89,25 @@ import Data.Align
10189import Data.Dependent.Map (DMap)
10290import qualified Data.Dependent.Map as DMap
10391import Data.Dependent.Sum (DSum (..))
104−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
10595import Data.Map (Map)
10696import Data.Maybe
107−import Data.Monoid
97+import Data.Monoid ((<>))
10898import Data.These
99+import Data.Type.Equality ((:~:) (..))
109100
110101import Debug.Trace
111102
103+-- | Map a sampling function over a 'Dynamic'.
104+mapDynM :: forall t m a b. (Reflex t, MonadHold t m) => (forall m'. MonadSample t m' => a -> m' b) -> Dynamic t a -> m (Dynamic t b)
105+mapDynM f d = buildDynamic (f =<< sample (current d)) $ pushAlways f (updated d)
106+
107+-- | Flipped version of 'mapDynM'
108+forDynM :: forall t m a b. (Reflex t, MonadHold t m) => Dynamic t a -> (forall m'. MonadSample t m' => a -> m' b) -> m (Dynamic t b)
109+forDynM d f = mapDynM f d
110+
112111-- | Create a new 'Dynamic' that only signals changes if the values actually
113112-- changed.
114113holdUniqDyn :: (Reflex t, MonadHold t m, MonadFix m, Eq a) => Dynamic t a -> m (Dynamic t a)
@@ -120,7 +119,7 @@ holdUniqDyn = holdUniqDynBy (==)
120119holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
121120holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
122121
123−-- | 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/@)
124123improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
125124improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
126125
@@ -164,7 +163,7 @@ foldDynMaybe = accumMaybeDyn . flip
164163foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
165164foldDynMaybeM = accumMaybeMDyn . flip
166165
167−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
166+-- | Create a new 'Dynamic' that counts the occurrences of the 'Event'.
168167count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
169168count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
170169
@@ -173,10 +172,25 @@ count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
173172toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
174173toggle = foldDyn (const not)
175174
175+-- | Switches to the new 'Event' whenever it receives one. Only the old event is
176+-- considered the moment a new one is switched in; the output event will fire at
177+-- that moment if only if the old event does.
178+--
179+-- Prefer this to 'switchPromptlyDyn' where possible. The lack of doing double
180+-- work when the outer and (new) inner fires means this imposes fewer "timing
181+-- requirements" and thus is far more easy to use without introducing fresh
182+-- failure cases. 'switchDyn' is also more performant.
183+switchDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
184+switchDyn d = switch (current d)
185+
176186-- | Switches to the new 'Event' whenever it receives one. Switching occurs
177−-- *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
178188-- old and new inner Events fire simultaneously, the output will fire with the
179−-- value of the *new* 'Event'.
189+-- value of the __new__ 'Event'.
190+--
191+-- Prefer 'switchDyn' to this where possible. The timing requirements that
192+-- switching before imposes are likely to bring down your app unless you are
193+-- very careful. 'switchDyn' is also more performant.
180194switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
181195switchPromptlyDyn de =
182196 let eLag = switch $ current de
@@ -192,28 +206,30 @@ splitDynPure d = (fmap fst d, fmap snd d)
192206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
193207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
194208
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+
195214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
196215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
197217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
198−distributeListOverDynPure =
199− fmap (map fromDSum . DMap.toAscList) .
200− distributeDMapOverDynPure .
201− DMap.fromDistinctAscList .
202− zipWith toDSum [0..]
203− where
204− toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
205− toDSum k v = Const2 k :=> v
206− fromDSum :: DSum (Const2 Int a) Identity -> a
207− fromDSum (Const2 _ :=> Identity v) = v
218+distributeListOverDynPure = distributeListOverDyn
208219
209220--TODO: Generalize this to functors other than Maps
210221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
211222-- with the current values of the 'Dynamic's in a map.
212223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
213−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 =<<)
214230
215231-- | Print the value of the 'Dynamic' when it is first read and on each
216−-- subsequent change that is observed (as traceEvent), prefixed with the
232+-- subsequent change that is observed (as 'traceEvent'), prefixed with the
217233-- provided string. This should /only/ be used for debugging.
218234--
219235-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -223,7 +239,7 @@ traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
223239
224240-- | Print the result of applying the provided function to the value
225241-- of the 'Dynamic' when it is first read and on each subsequent change
226−-- that is observed (as traceEvent). This should /only/ be used for
242+-- that is observed (as 'traceEvent'). This should /only/ be used for
227243-- debugging.
228244--
229245-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -239,36 +255,35 @@ traceDynWith f d =
239255-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
240256-- each time the 'Event' occurs.
241257--
242−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
243−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
244−-- 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
245261-- will be used, since the 'Behavior' won't be updated until the end of the frame.
246262-- Additionally, this means that the output 'Event' may not be used to directly change
247−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
248−-- 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.__
249265tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
250266tagPromptlyDyn = attachPromptlyDynWith const
251267
252268-- | Attach the current value of the 'Dynamic' to the value of the
253269-- 'Event' each time it occurs.
254270--
255−-- 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.
256272attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
257273attachPromptlyDyn = attachPromptlyDynWith (,)
258274
259275-- | Combine the current value of the 'Dynamic' with the value of the
260276-- 'Event' each time it occurs.
261277--
262−-- 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.
263279attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
264280attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
265281
266−-- | 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
267283-- current value of the 'Dynamic' value and possibly filtering if the combining
268284-- function returns 'Nothing'.
269285--
270−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
271−-- (current d)`. See 'tagPromptlyDyn' for details.
286+-- Note: @/attachPromptlyDynWithMaybe f d/@ is not the same as @/attachWithMaybe f (current d)/@. See 'tagPromptlyDyn' for details.
272287attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
273288attachPromptlyDynWithMaybe f d e =
274289 let e' = attach (current d) e
@@ -277,8 +292,8 @@ attachPromptlyDynWithMaybe f d e =
277292 These (_, b) a -> f a b -- Both events are firing, so use the newer value
278293 That _ -> Nothing -- The tagging event isn't firing, so don't fire
279294
280−-- | Factor a @Dynamic t (Maybe a)@ into a @Dynamic t (Maybe (Dynamic t a))@,
281−-- 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
282297-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
283298-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
284299-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
@@ -293,6 +308,8 @@ maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
293308 Left _ -> Nothing
294309 Right a -> Just a
295310
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').
296313eitherDyn :: 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)))
297314eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
298315 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
@@ -300,26 +317,23 @@ eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
300317 LeftTag :=> Compose a -> Left $ coerceDynamic a
301318 RightTag :=> Compose b -> Right $ coerceDynamic b
302319
303−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)))
304−factorDyn d = do
305− let inner :: forall m' a. (MonadFix m', MonadHold t m') => k a -> v a -> m' (Dynamic t (v a))
306− inner k v0 = holdDyn v0 . fmapMaybe id =<< takeWhileE isJust newVal
307− where newVal = ffor (updated d) $ \(newK :=> newV) -> case newK `geq` k of
308− Just Refl -> Just newV
309− Nothing -> Nothing
310− getInitial = do
311− k0 :=> (v0 :: v a) <- sample $ current d
312− i0 <- inner k0 v0
313− return $ k0 :=> Compose i0
314− update = flip push (updated d) $ \(newKey :=> newVal) -> do
315− (oldKey :=> _) <- sample $ current d
316− case newKey `geq` oldKey of
317− Just Refl -> return Nothing
318− Nothing -> do
319− newInner <- inner newKey newVal
320− return $ Just $ newKey :=> Compose newInner
321− o0 <- getInitial --TODO: Figure out how to get this to run inside something like the first argument to buildDynamic
322− 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
323337
324338--------------------------------------------------------------------------------
325339-- Demux
@@ -334,7 +348,7 @@ factorDyn d = do
334348--
335349-- > demuxed (demux d) k === fmap (== k) d
336350--
337−-- However, the when getDemuxed is used multiple times, the complexity is only
351+-- However, when 'demuxed' is used multiple times, the complexity is only
338352-- /O(log(n))/, rather than /O(n)/ for fmap.
339353data Demux t k = Demux { demuxValue :: Behavior t k
340354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -404,21 +418,12 @@ data FHList f l where
404418 FHCons :: f e -> FHList f l -> FHList f (e ': l)
405419
406420instance GEq (HListPtr l) where
407−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
408− geqToEq _ = id
409− geqUnify HHeadPtr HHeadPtr _ same = same
410− geqUnify (HTailPtr a) (HTailPtr b) different same = geqUnify a b different same
411− geqUnify _ _ different _ = different
412−#endif
413421 HHeadPtr `geq` HHeadPtr = Just Refl
414422 HHeadPtr `geq` HTailPtr _ = Nothing
415423 HTailPtr _ `geq` HHeadPtr = Nothing
416424 HTailPtr a `geq` HTailPtr b = a `geq` b
417425
418426instance GCompare (HListPtr l) where -- Warning: This ordering can't change, dmapTo*HList will break
419−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
420− gcompareToOrd _ = id
421−#endif
422427 HHeadPtr `gcompare` HHeadPtr = GEQ
423428 HHeadPtr `gcompare` HTailPtr _ = GLT
424429 HTailPtr _ `gcompare` HHeadPtr = GGT
@@ -497,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
497502
498503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
499504-- single 'Dynamic' whose value represents all the current values of the input's
500−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
501506collectDynPure :: ( RebuildSortedHList (HListElems b)
502507 , IsHList a, IsHList b
503508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -538,150 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
538543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
539544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
540545#endif
541−
542−--------------------------------------------------------------------------------
543−-- Deprecated functions
544−--------------------------------------------------------------------------------
545−
546−-- | Map a function over a 'Dynamic'.
547−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
548−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
549−mapDyn f = return . fmap f
550−
551−-- | Map a sampling function over a 'Dynamic'. The sampling function will use the input 'Dynamic''s 'current' 'Behavior' until the first time its 'updated' 'Event' fires, at which point it will be invoked only once each time the 'Event' fires.
552−{-# DEPRECATED mapDynM "Consider using the Monad instance for Dynamic instead." #-}
553−mapDynM :: forall t m a b. (Reflex t, MonadHold t m) => (forall m'. MonadSample t m' => a -> m' b) -> Dynamic t a -> m (Dynamic t b)
554−mapDynM f d = do
555− let e' = push (fmap Just . f :: a -> PushM t (Maybe b)) $ updated d
556− eb' = fmap constant e'
557− v0 = pull $ f =<< sample (current d)
558− bb' :: Behavior t (Behavior t b) <- hold v0 eb'
559− let b' = pull $ sample =<< sample bb'
560− return $ unsafeDynamic b' e'
561−
562−-- | Flipped version of 'mapDyn'.
563−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
564−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
565−forDyn a = return . ffor a
566−
567−-- | Flipped version of 'mapDynM'
568−{-# DEPRECATED forDynM "Consider using the Monad instance for Dynamic instead." #-}
569−forDynM :: forall t m a b. (Reflex t, MonadHold t m) => Dynamic t a -> (forall m'. MonadSample t m' => a -> m' b) -> m (Dynamic t b)
570−forDynM d f = mapDynM f d
571−
572−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
573−-- of the tuple.
574−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
575−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
576−splitDyn = return . splitDynPure
577−
578−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
579−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
580−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
581−mconcatDyn = return . mconcat
582−
583−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
584−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
585−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
586−distributeDMapOverDyn = return . distributeDMapOverDynPure
587−
588−-- | Merge two 'Dynamic's into a new one using the provided function. The new
589−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
590−-- its value.
591−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
592−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
593−combineDyn f a b = return $ zipDynWith f a b
594−
595−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
596−--
597−-- > do
598−-- > person <- Person `mapDyn` dynFirstName
599−-- > `apDyn` dynListName
600−-- > `apDyn` dynAge
601−-- > `apDyn` dynAddress
602−{-# 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" #-}
603−#ifdef USE_TEMPLATE_HASKELL
604−{-# ANN apDyn "HLint: ignore Use fmap" #-}
605−#endif
606−apDyn :: forall t m a b. (Reflex t, Monad m)
607− => m (Dynamic t (a -> b))
608− -> Dynamic t a
609− -> m (Dynamic t b)
610−apDyn m a = fmap (<*> a) m
611−
612−--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
613−-- | This function no longer needs to be monadic, so it has been replaced by
614−-- 'demuxed', which is pure.
615−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
616−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
617−getDemuxed d = return . demuxed d
618−
619−-- | This function no longer needs to be monadic, so it has been replaced by
620−-- 'distributeFHListOverDynPure', which is pure.
621−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
622−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
623−distributeFHListOverDyn = return . distributeFHListOverDynPure
624−
625−-- | This function no longer needs to be monadic, so it has been replaced by
626−-- 'collectDynPure', which is pure.
627−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
628−collectDyn :: ( RebuildSortedHList (HListElems b)
629− , IsHList a, IsHList b
630− , AllAreFunctors (Dynamic t) (HListElems b)
631− , Reflex t, Monad m
632− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
633− ) => a -> m (Dynamic t b)
634−collectDyn = return . collectDynPure
635−
636−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
637−-- semantics.
638−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
639−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
640−tagDyn = tagPromptlyDyn
641−
642−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
643−-- semantics.
644−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
645−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
646−attachDyn = attachPromptlyDyn
647−
648−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
649−-- semantics.
650−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
651−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
652−attachDynWith = attachPromptlyDynWith
653−
654−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
655−-- its semantics.
656−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
657−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
658−attachDynWithMaybe = attachPromptlyDynWithMaybe
659−
660−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
661−-- current value will always be equal to the current value's current value, and
662−-- will change whenever either the inner or the outer (or both) values change.
663−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
664−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
665−joinDyn = join
666−
667−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
668−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
669−-- circumstances. Also, note that, unlike 'nub', this function does not prevent
670−-- all recurrences of a value, only consecutive recurrences.
671−{-# DEPRECATED nubDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
672−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
673−nubDyn = uniqDyn
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.
678−{-# DEPRECATED uniqDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
679−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
680−uniqDyn = uniqDynBy (==)
681−
682−-- | WARNING: This function is impure. Use 'holdUniqDynBy' instead.
683−{-# DEPRECATED uniqDynBy "Use 'holdUniqDynBy' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
684−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
685−uniqDynBy eq d =
686− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
687− 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/Dynamic/Uniq.hs+1−1
@@ -31,7 +31,7 @@ newtype UniqDynamic t a = UniqDynamic { unUniqDynamic :: Dynamic t a }
3131
3232-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
3333uniqDynamic :: Reflex t => Dynamic t a -> UniqDynamic t a
34−uniqDynamic d = UniqDynamic $ unsafeBuildDynamic (sample $ current d) $ flip push (updated d) $ \new -> do --TODO: It would be very nice if we had an uncached push here
34+uniqDynamic d = UniqDynamic $ unsafeBuildDynamic (sample $ current d) $ flip pushCheap (updated d) $ \new -> do
3535 old <- sample $ current d --TODO: Is it better to sample ourselves here?
3636 return $ unsafeJustChanged old new
3737
src/Reflex/DynamicWriter.hs+4−189
@@ -1,192 +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.Functor.Misc
34−import Data.Map (Map)
35−import qualified Data.Map as Map
36−import Data.Semigroup
37−import Data.Some (Some)
38−import Data.These
39−import Reflex.Class
40−import Reflex.Host.Class
41−import qualified Reflex.Patch.MapWithMove as MapWithMove
42−import Reflex.PerformEvent.Class
43−import Reflex.PostBuild.Class
44−import Reflex.Requester.Class
45−import Reflex.TriggerEvent.Class
46−
47−instance MonadTrans (DynamicWriterT t w) where
48− lift = DynamicWriterT . lift
49−
50−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')
51−mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
52−
53−mergeDynIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Dynamic t v)) -> Incremental t (PatchMap k v)
54−mergeDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
55− where changedValues = fmap (PatchMap . fmap Just) $ mergeMapIncremental $ mapIncrementalMapValues updated a
56− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchMap m) -> PatchMap <$> mapM (mapM (sample . current)) m
57−
58−mergeDynIncrementalWithMove :: forall t k v. (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Dynamic t v)) -> Incremental t (PatchMapWithMove k v)
59−mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ alignWith f addedAndRemovedValues changedValues
60− where changedValues = mergeMapIncrementalWithMove $ mapIncrementalMapValues updated a
61− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ fmap unsafePatchMapWithMove . mapM (mapM (sample . current)) . unPatchMapWithMove
62− f :: These (PatchMapWithMove k v) (Map k v) -> PatchMapWithMove k v
63− f x = unsafePatchMapWithMove $
64− let (p, changed) = case x of
65− This p_ -> (unPatchMapWithMove p_, mempty)
66− That c -> (mempty, c)
67− These p_ c -> (unPatchMapWithMove p_, c)
68− (pWithNewVals, noLongerMoved) = flip runState [] $ forM p $ MapWithMove.nodeInfoMapMFrom $ \case
69− MapWithMove.From_Insert v -> return $ MapWithMove.From_Insert v
70− MapWithMove.From_Delete -> return $ MapWithMove.From_Delete
71− MapWithMove.From_Move k -> case Map.lookup k changed of
72− Nothing -> return $ MapWithMove.From_Move k
73− Just v -> do
74− modify (k:)
75− return $ MapWithMove.From_Insert v
76− noLongerMovedMap = Map.fromList $ fmap (\k -> (k, ())) noLongerMoved
77− in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
78−
79−-- | A basic implementation of 'MonadDynamicWriter'.
80−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
81−
82−instance MonadRef m => MonadRef (DynamicWriterT t w m) where
83− type Ref (DynamicWriterT t w m) = Ref m
84− newRef = lift . newRef
85− readRef = lift . readRef
86− writeRef r = lift . writeRef r
87−
88−instance MonadAtomicRef m => MonadAtomicRef (DynamicWriterT t w m) where
89− atomicModifyRef r = lift . atomicModifyRef r
90−
91−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DynamicWriterT t w m) where
92− newEventWithTrigger = lift . newEventWithTrigger
93− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
94−
95−-- | Run a 'DynamicWriterT' action. The dynamic writer output will be provided
96−-- along with the result of the action.
97−runDynamicWriterT :: (MonadFix m, Reflex t, Monoid w) => DynamicWriterT t w m a -> m (a, Dynamic t w)
98−runDynamicWriterT (DynamicWriterT a) = do
99− (result, ws) <- runStateT a []
100− return (result, mconcat $ reverse ws)
101−
102−-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
103−-- and combines them monoidally to provide a 'Dynamic' result.
104−class (Monad m, Monoid w) => MonadDynamicWriter t w m | m -> t w where
105− tellDyn :: Dynamic t w -> m ()
106−
107−instance (Monad m, Monoid w, Reflex t) => MonadDynamicWriter t w (DynamicWriterT t w m) where
108− tellDyn w = DynamicWriterT $ modify (w :)
109−
110−instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
111− ask = lift ask
112− local f (DynamicWriterT a) = DynamicWriterT $ mapStateT (local f) a
113− reader = lift . reader
114−
115−instance PerformEvent t m => PerformEvent t (DynamicWriterT t w m) where
116− type Performable (DynamicWriterT t w m) = Performable m
117− performEvent_ = lift . performEvent_
118− performEvent = lift . performEvent
119−
120−instance TriggerEvent t m => TriggerEvent t (DynamicWriterT t w m) where
121− newTriggerEvent = lift newTriggerEvent
122− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
123− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
124−
125−instance PostBuild t m => PostBuild t (DynamicWriterT t w m) where
126− getPostBuild = lift getPostBuild
127−
128−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (ReaderT r m) where
129− tellDyn = lift . tellDyn
130−
131−instance MonadState s m => MonadState s (DynamicWriterT t w m) where
132− get = lift get
133− put = lift . put
134−
135−newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
136−
137−-- | When the execution of a 'DynamicWriterT' action is adjusted using
138−-- 'MonadAdjust', the 'Dynamic' output of that action will also be updated to
139−-- match.
140−instance (MonadAdjust t m, MonadFix m, Monoid w, MonadHold t m, Reflex t) => MonadAdjust t (DynamicWriterT t w m) where
141− runWithReplace a0 a' = do
142− (result0, result') <- lift $ runWithReplace (runDynamicWriterT a0) $ runDynamicWriterT <$> a'
143− tellDyn . join =<< holdDyn (snd result0) (snd <$> result')
144− return (fst result0, fst <$> result')
145− traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap weakenPatchDMapWith mergeDynIncremental
146− traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeDynIncrementalWithMove
147−
148−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)
149− => ( (forall a. k a -> v a -> m (DynamicWriterTLoweredResult t w v' a))
150− -> DMap k v
151− -> Event t (p k v)
152− -> m (DMap k (DynamicWriterTLoweredResult t w v'), Event t (p k (DynamicWriterTLoweredResult t w v')))
153− )
154− -> ((forall a. DynamicWriterTLoweredResult t w v' a -> v' a) -> p k (DynamicWriterTLoweredResult t w v') -> p k v')
155− -> ((forall a. DynamicWriterTLoweredResult t w v' a -> Dynamic t w) -> p k (DynamicWriterTLoweredResult t w v') -> p' (Some k) (Dynamic t w))
156− -> (Incremental t (p' (Some k) (Dynamic t w)) -> Incremental t (p' (Some k) w))
157− -> (forall a. k a -> v a -> DynamicWriterT t w m (v' a))
158− -> DMap k v
159− -> Event t (p k v)
160− -> DynamicWriterT t w m (DMap k v', Event t (p k v'))
161−traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith mergeMyDynIncremental f (dm0 :: DMap k v) dm' = do
162− (result0, result') <- lift $ base (\k v -> fmap DynamicWriterTLoweredResult $ runDynamicWriterT $ f k v) dm0 dm'
163− let getValue (DynamicWriterTLoweredResult (v, _)) = v
164− getWritten (DynamicWriterTLoweredResult (_, w)) = w
165− liftedResult0 = DMap.map getValue result0
166− liftedResult' = ffor result' $ mapPatch getValue
167− liftedWritten0 :: Map (Some k) (Dynamic t w)
168− liftedWritten0 = weakenDMapWith getWritten result0
169− liftedWritten' = ffor result' $ weakenPatchWith getWritten
170− --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
171− i <- holdIncremental liftedWritten0 liftedWritten'
172− tellDyn $ fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
173− return (liftedResult0, liftedResult')
174−
175−-- | Map a function over the output of a 'DynamicWriterT'.
176−withDynamicWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m, MonadFix m)
177− => (w -> w')
178− -> DynamicWriterT t w m a
179− -> DynamicWriterT t w' m a
180−withDynamicWriterT f dw = do
181− (r, d) <- lift $ do
182− (r, d) <- runDynamicWriterT dw
183− let d' = fmap f d
184− return (r, d')
185− tellDyn d
186− return r
187−
188−instance Requester t m => Requester t (DynamicWriterT t w m) where
189− type Request (DynamicWriterT t w m) = Request m
190− type Response (DynamicWriterT t w m) = Response m
191− requesting = lift . requesting
192− 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−266
@@ -1,269 +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
2+ {-# DEPRECATED "Use 'Reflex.EventWriter.Class' and 'Reflex.EventWriter.Base' instead, or just import 'Reflex'" #-}
3+ ( module X
234 ) where
245
25−import Reflex.Class
26−import Reflex.Host.Class
27−import Reflex.PerformEvent.Class
28−import Reflex.PostBuild.Class
29−import Reflex.Query.Class
30−import Reflex.Requester.Class
31−import Reflex.TriggerEvent.Class
32−
33−import Control.Monad.Exception
34−import Control.Monad.Identity
35−import Control.Monad.Reader
36−import Control.Monad.Ref
37−import Control.Monad.State.Strict
38−import Data.Dependent.Map (DMap, DSum (..))
39−import qualified Data.Dependent.Map as DMap
40−import Data.FastMutableIntMap
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, MonadAdjust t m, MonadHold t m, Semigroup w) => MonadAdjust 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 'MonadAdjust' instance or to override the default
157−-- 'MonadAdjust' 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
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+83−16
@@ -1,10 +1,23 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE LambdaCase #-}
33{-# LANGUAGE ScopedTypeVariables #-}
4−#ifdef ghcjs_HOST_OS
4+#if GHCJS_FAST_WEAK
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
@@ -14,7 +27,7 @@ module Reflex.FastWeak
1427 , getFastWeakValue
1528 , getFastWeakTicket
1629 , emptyFastWeak
17−#ifdef ghcjs_HOST_OS
30+#ifdef GHCJS_FAST_WEAK
1831 --TODO: Move these elsewhere
1932 , unsafeFromRawJSVal
2033 , unsafeToRawJSVal
@@ -25,7 +38,7 @@ module Reflex.FastWeak
2538import GHC.Exts (Any)
2639import Unsafe.Coerce
2740
28−#ifdef ghcjs_HOST_OS
41+#ifdef GHCJS_FAST_WEAK
2942import GHCJS.Types
3043#else
3144import Control.Exception (evaluate)
@@ -34,32 +47,60 @@ import System.Mem.Weak
3447#endif
3548
3649
37−#ifdef ghcjs_HOST_OS
50+#ifdef GHCJS_FAST_WEAK
51+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
52+-- can be used to get the referred to value without fear of @Nothing,
53+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
54+--
55+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeakTicket@.
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
62−#ifdef ghcjs_HOST_OS
103+#ifdef GHCJS_FAST_WEAK
63104getFastWeakTicketValue t = do
64105 v <- js_ticketVal t
65106 return $ unsafeFromRawJSVal v
@@ -69,8 +110,10 @@ 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)
73−#ifdef ghcjs_HOST_OS
116+#ifdef GHCJS_FAST_WEAK
74117getFastWeakValue w = do
75118 r <- js_weakVal w
76119 case js_isNull r of
@@ -84,8 +127,11 @@ 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))
88−#ifdef ghcjs_HOST_OS
134+#ifdef GHCJS_FAST_WEAK
89135getFastWeakTicket w = do
90136 r <- js_weakTicket w
91137 case js_isNull r of
@@ -103,9 +149,22 @@ 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)
108−#ifdef ghcjs_HOST_OS
165+-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the
166+-- associated FastWeak to actually be weak
167+#ifdef GHCJS_FAST_WEAK
109168mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
110169
111170foreign import javascript unsafe "$r = new h$FastWeakTicket($1);" js_fastWeakTicket :: JSVal -> IO (FastWeakTicket a)
@@ -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
123−#ifdef ghcjs_HOST_OS
124−foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
186+#ifdef GHCJS_FAST_WEAK
187+foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak' :: FastWeakTicket a -> IO (FastWeak a)
188+{-# INLINE getFastWeakTicketWeak #-}
189+getFastWeakTicketWeak = getFastWeakTicketWeak'
125190#else
126−getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
127191getFastWeakTicketWeak = return . _fastWeakTicket_weak
128192#endif
129193
@@ -131,9 +195,8 @@ getFastWeakTicketWeak = return . _fastWeakTicket_weak
131195emptyFastWeak :: FastWeak a
132196emptyFastWeak = unsafeCoerce w
133197 where w :: FastWeak Any
134−#ifdef ghcjs_HOST_OS
198+#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+34−16
@@ -1,29 +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 f = catMaybes . fmap f@
33+instance FunctorMaybe Maybe where
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
39+
2840instance FunctorMaybe [] where
29− fmapMaybe f = catMaybes . fmap f
41+ fmapMaybe = mapMaybe
42+
43+instance FunctorMaybe (Map k) where
44+ fmapMaybe = mapMaybe
45+
46+instance FunctorMaybe IntMap where
47+ fmapMaybe = mapMaybe
src/Reflex/Host/Class.hs+6−26
@@ -4,7 +4,6 @@
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.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE MultiParamTypeClasses #-}
3+#ifdef USE_REFLEX_OPTIMIZER
4+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
5+#endif
6+-- |
7+-- Module:
8+-- Reflex.Network
9+-- Description:
10+-- This module provides combinators for building FRP graphs/networks and modifying them dynamically.
11+module Reflex.Network
12+ ( networkView
13+ , networkHold
14+ , untilReady
15+ ) where
16+
17+import Reflex.Class
18+import Reflex.Adjustable.Class
19+import Reflex.NotReady.Class
20+import Reflex.PostBuild.Class
21+
22+-- | A 'Dynamic' "network": Takes a 'Dynamic' of network-creating actions and replaces the network whenever the 'Dynamic' updates.
23+-- The returned Event of network results fires at post-build time and when the 'Dynamic' updates.
24+-- Note: Often, the type 'a' is an Event, in which case the return value is an Event-of-Events, where the outer 'Event' fires
25+-- when switching networks. Such an 'Event' would typically be flattened (via 'switchPromptly').
26+networkView :: (NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
27+networkView child = do
28+ postBuild <- getPostBuild
29+ let newChild = leftmost [updated child, tagCheap (current child) postBuild]
30+ snd <$> runWithReplace notReady newChild
31+
32+-- | Given an initial "network" and an 'Event' of network-creating actions, create a network that is recreated whenever the Event fires.
33+-- The returned Dynamic of network results occurs when the Event does.
34+-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
35+networkHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
36+networkHold child0 newChild = do
37+ (result0, newResult) <- runWithReplace child0 newChild
38+ holdDyn result0 newResult
39+
40+-- | Render a placeholder network to be shown while another network is not yet
41+-- done building
42+untilReady :: (Adjustable t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
43+untilReady a b = do
44+ postBuild <- getPostBuild
45+ runWithReplace a $ b <$ postBuild
src/Reflex/NotReady/Class.hsnew file+77
@@ -0,0 +1,77 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DefaultSignatures #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FunctionalDependencies #-}
6+{-# LANGUAGE TypeFamilies #-}
7+{-# LANGUAGE UndecidableInstances #-}
8+#ifdef USE_REFLEX_OPTIMIZER
9+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
10+#endif
11+module Reflex.NotReady.Class
12+ ( NotReady(..)
13+ ) where
14+
15+import Control.Monad.Reader (ReaderT)
16+import Control.Monad.Trans
17+import Control.Monad.Trans.Writer (WriterT)
18+
19+import Reflex.BehaviorWriter.Base (BehaviorWriterT)
20+import Reflex.Class
21+import Reflex.DynamicWriter.Base (DynamicWriterT)
22+import Reflex.EventWriter.Base (EventWriterT)
23+import Reflex.Host.Class
24+import Reflex.PerformEvent.Base (PerformEventT (..))
25+import Reflex.PostBuild.Base (PostBuildT)
26+import Reflex.Query.Base (QueryT)
27+import Reflex.Requester.Base (RequesterT)
28+import Reflex.TriggerEvent.Base (TriggerEventT)
29+
30+class Monad m => NotReady t m | m -> t where
31+ notReadyUntil :: Event t a -> m ()
32+ default notReadyUntil :: (MonadTrans f, m ~ f m', NotReady t m') => Event t a -> m ()
33+ notReadyUntil = lift . notReadyUntil
34+
35+ notReady :: m ()
36+ default notReady :: (MonadTrans f, m ~ f m', NotReady t m') => m ()
37+ notReady = lift notReady
38+
39+instance NotReady t m => NotReady t (ReaderT r m) where
40+ notReadyUntil = lift . notReadyUntil
41+ notReady = lift notReady
42+
43+instance (NotReady t m, Monoid w) => NotReady t (WriterT w m) where
44+ notReadyUntil = lift . notReadyUntil
45+ notReady = lift notReady
46+
47+instance NotReady t m => NotReady t (PostBuildT t m) where
48+ notReadyUntil = lift . notReadyUntil
49+ notReady = lift notReady
50+
51+instance NotReady t m => NotReady t (EventWriterT t w m) where
52+ notReadyUntil = lift . notReadyUntil
53+ notReady = lift notReady
54+
55+instance NotReady t m => NotReady t (DynamicWriterT t w m) where
56+ notReadyUntil = lift . notReadyUntil
57+ notReady = lift notReady
58+
59+instance NotReady t m => NotReady t (BehaviorWriterT t w m) where
60+ notReadyUntil = lift . notReadyUntil
61+ notReady = lift notReady
62+
63+instance NotReady t m => NotReady t (QueryT t q m) where
64+ notReadyUntil = lift . notReadyUntil
65+ notReady = lift notReady
66+
67+instance (ReflexHost t, NotReady t (HostFrame t)) => NotReady t (PerformEventT t m) where
68+ notReadyUntil = PerformEventT . notReadyUntil
69+ notReady = PerformEventT notReady
70+
71+instance NotReady t m => NotReady t (RequesterT t request response m) where
72+ notReadyUntil = lift . notReadyUntil
73+ notReady = lift notReady
74+
75+instance NotReady t m => NotReady t (TriggerEventT t m) where
76+ notReadyUntil = lift . notReadyUntil
77+ notReady = lift notReady
src/Reflex/Optimizer.hs+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−33
@@ -1,33 +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
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−
15−import Data.Semigroup (Semigroup (..), (<>))
16−
17−---- Patches based on commutative groups
18−
19−-- | A 'Group' is a 'Monoid' where every element has an inverse.
20−class (Semigroup q, Monoid q) => Group q where
21− negateG :: q -> q
22− (~~) :: q -> q -> q
23− r ~~ s = r <> negateG s
24−
25−-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
26−class Semigroup q => Additive q where
27−
28−-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
29−newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
30−
31−instance Additive p => Patch (AdditivePatch p) where
32− type PatchTarget (AdditivePatch p) = p
33− apply (AdditivePatch p) q = Just $ p <> q
src/Reflex/Patch/Class.hsdeleted−20
@@ -1,20 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−module Reflex.Patch.Class where
3−
4−import Control.Monad.Identity
5−import Data.Maybe
6−
7−-- | A 'Patch' type represents a kind of change made to a datastructure.
8−class Patch p where
9− type PatchTarget p :: *
10− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
11− -- 'Nothing'.
12− apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
13−
14−applyAlways :: Patch p => p -> PatchTarget p -> PatchTarget p
15−applyAlways p t = fromMaybe t $ apply p t
16−
17−instance Patch (Identity a) where
18− type PatchTarget (Identity a) = a
19− apply (Identity a) _ = Just a
20−
src/Reflex/Patch/DMap.hsdeleted−61
@@ -1,61 +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.Map
12−
13−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
14−import qualified Data.Dependent.Map as DMap
15−import Data.Functor.Constant
16−import Data.Functor.Misc
17−import qualified Data.Map as Map
18−import Data.Semigroup (Semigroup (..))
19−import Data.Some (Some)
20−
21−-- | A set of changes to a 'DMap'. Any element may be inserted/updated or
22−-- deleted.
23−newtype PatchDMap k v = PatchDMap { unPatchDMap :: DMap k (ComposeMaybe v) }
24−
25−deriving instance GCompare k => Semigroup (PatchDMap k v)
26−
27−deriving instance GCompare k => Monoid (PatchDMap k v)
28−
29−instance GCompare k => Patch (PatchDMap k v) where
30− type PatchTarget (PatchDMap k v) = DMap k v
31− 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?
32− where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
33− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
34− nothingToJust = \case
35− Nothing -> Just $ Constant ()
36− Just _ -> Nothing
37−
38−mapPatchDMap :: (forall a. v a -> v' a) -> PatchDMap k v -> PatchDMap k v'
39−mapPatchDMap f (PatchDMap p) = PatchDMap $ DMap.map (ComposeMaybe . fmap f . getComposeMaybe) p
40−
41−traversePatchDMap :: Applicative m => (forall a. v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
42−traversePatchDMap f = traversePatchDMapWithKey $ const f
43−
44−traversePatchDMapWithKey :: Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
45−traversePatchDMapWithKey f (PatchDMap p) = PatchDMap <$> DMap.traverseWithKey (\k (ComposeMaybe v) -> ComposeMaybe <$> traverse (f k) v) p
46−
47−weakenPatchDMapWith :: (forall a. v a -> v') -> PatchDMap k v -> PatchMap (Some k) v'
48−weakenPatchDMapWith f (PatchDMap p) = PatchMap $ weakenDMapWith (fmap f . getComposeMaybe) p
49−
50−patchDMapToPatchMapWith :: (f v -> v') -> PatchDMap (Const2 k v) f -> PatchMap k v'
51−patchDMapToPatchMapWith f (PatchDMap p) = PatchMap $ dmapToMapWith (fmap f . getComposeMaybe) p
52−
53−const2PatchDMapWith :: forall k v f a. (v -> f a) -> PatchMap k v -> PatchDMap (Const2 k a) f
54−const2PatchDMapWith f (PatchMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
55− where g :: (k, Maybe v) -> DSum (Const2 k a) (ComposeMaybe f)
56− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
57−
58−-- | Get the values that will be deleted if the given patch is applied to the
59−-- given 'DMap'. Includes values that will be replaced.
60−getDeletions :: GCompare k => PatchDMap k v -> DMap k v' -> DMap k v'
61−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/Map.hsdeleted−52
@@ -1,52 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE TypeFamilies #-}
4−module Reflex.Patch.Map where
5−
6−import Reflex.Patch.Class
7−
8−import Data.Semigroup
9−import Data.Map (Map)
10−import qualified Data.Map as Map
11−import Data.Maybe
12−
13−-- | A set of changes to a 'Map'. Any element may be inserted/updated or
14−-- deleted.
15−newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
16−
17−instance Ord k => Patch (PatchMap k v) where
18− type PatchTarget (PatchMap k v) = Map k v
19− {-# INLINABLE apply #-}
20− 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?
21− where insertions = Map.mapMaybeWithKey (const id) p
22− deletions = Map.mapMaybeWithKey (const nothingToJust) p
23− nothingToJust = \case
24− Nothing -> Just ()
25− Just _ -> Nothing
26−
27−instance Ord k => Semigroup (PatchMap k v) where
28− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
29− -- PatchMap is idempotent, so stimes n is id for every n
30−#if MIN_VERSION_semigroups(0,17,0)
31− stimes = stimesIdempotentMonoid
32−#else
33− times1p n x = case compare n 0 of
34− LT -> error "stimesIdempotentMonoid: negative multiplier"
35− EQ -> mempty
36− GT -> x
37−#endif
38−
39−instance Ord k => Monoid (PatchMap k v) where
40− mempty = PatchMap mempty
41− mappend = (<>)
42−
43−instance Functor (PatchMap k) where
44− fmap f = PatchMap . fmap (fmap f) . unPatchMap
45−
46−-- | Returns all the new elements that will be added to the 'Map'
47−patchMapNewElements :: PatchMap k v -> [v]
48−patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
49−
50−-- | Returns all the new elements that will be added to the 'Map'
51−patchMapNewElementsMap :: PatchMap k v -> Map k v
52−patchMapNewElementsMap (PatchMap p) = Map.mapMaybe id p
src/Reflex/Patch/MapWithMove.hsdeleted−159
@@ -1,159 +0,0 @@
1−{-# LANGUAGE DeriveFoldable #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveTraversable #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TypeFamilies #-}
8−module Reflex.Patch.MapWithMove where
9−
10−import Reflex.Patch.Class
11−
12−import Control.Arrow
13−import Control.Monad.State
14−import Data.Foldable
15−import Data.Function
16−import Data.List
17−import Data.Map (Map)
18−import qualified Data.Map as Map
19−import Data.Maybe
20−import qualified Data.Set as Set
21−import Data.Tuple
22−
23−-- | Patch a DMap with additions, deletions, and moves.
24−-- Invariants:
25−-- * The same source key may not be moved to two destination keys.
26−-- * Any key that is the source of a Move must also be edited
27−-- (otherwise, the Move would duplicate it)
28−newtype PatchMapWithMove k v = PatchMapWithMove (Map k (NodeInfo k v)) deriving (Show, Eq, Ord, Functor, Foldable, Traversable)
29−
30−data NodeInfo k v = NodeInfo
31− { _nodeInfo_from :: !(From k v)
32− , _nodeInfo_to :: !(To k)
33− }
34− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
35−
36−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
37−unPatchMapWithMove (PatchMapWithMove p) = p
38−
39−-- | Warning: when using this function, you must ensure that the invariants of
40−-- 'PatchMapWithMove' are preserved; they will not be checked.
41−unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
42−unsafePatchMapWithMove = PatchMapWithMove
43−
44−data From k v
45− = From_Insert v -- ^ Insert the given value here
46− | From_Delete -- ^ Delete the existing value, if any, from here
47− | From_Move !k -- ^ Move the value here from the given key
48− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
49−
50−type To = Maybe
51−
52−instance Ord k => Patch (PatchMapWithMove k v) where
53− type PatchTarget (PatchMapWithMove k v) = Map k v
54− 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?
55− where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
56− From_Insert v -> Just v
57− From_Move k -> Map.lookup k old
58− From_Delete -> Nothing
59− deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
60− From_Delete -> Just ()
61− _ -> Nothing
62−
63−-- | Returns all the new elements that will be added to the 'Map'
64−patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
65−patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
66−
67−patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
68−patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
69− where f ni = case _nodeInfo_from ni of
70− From_Insert v -> Just v
71− From_Move _ -> Nothing
72− From_Delete -> Nothing
73−
74−validPatchMapWithMove :: Ord k => PatchMapWithMove k v -> Bool
75−validPatchMapWithMove (PatchMapWithMove p) =
76− let f ni = case _nodeInfo_from ni of
77− From_Move k -> Just k
78− _ -> Nothing
79− moveSources = catMaybes $ f <$> Map.elems p
80− in and
81− [ -- All Moves must have unique source keys - a single source key can't be moved to two destinations
82− all (==1) $ Map.fromListWith (+) $ fmap (\k -> (k, 1 :: Integer )) moveSources
83− , -- All Move source keys must also be patched - since the value's being moved elsewhere, the original must either be Deleted or replaced (with Insert or Move)
84− all (isJust . flip Map.lookup p) moveSources
85− ]
86−
87−knownValidPatchMapWithMove :: [PatchMapWithMove Int Int]
88−knownValidPatchMapWithMove =
89− [ PatchMapWithMove mempty
90− , PatchMapWithMove $ Map.fromList
91− [ (1, NodeInfo (From_Move 2) $ Just 1)
92− , (2, NodeInfo (From_Move 1) $ Just 2)
93− ]
94− ]
95−
96−knownInvalidPatchMapWithMove :: [PatchMapWithMove Int Int]
97−knownInvalidPatchMapWithMove =
98− [ -- Invalid because we move 2 to 1, but don't specify what to do with 2
99− PatchMapWithMove $ Map.singleton 1 $ NodeInfo (From_Move 2) Nothing
100− , -- Invalid because we have multiple moves from 3
101− PatchMapWithMove $ Map.fromList
102− [ (1, NodeInfo (From_Move 3) Nothing)
103− , (2, NodeInfo (From_Move 3) Nothing)
104− , (3, NodeInfo From_Delete (Just 1))
105− ]
106− ]
107−
108−patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
109−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
110− where unsorted = Map.toList m
111− sorted = sortBy (cmp `on` snd) unsorted
112− f (to, _) (from, _) = if to == from then Nothing else
113− Just (from, to)
114− reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
115− g (to, _) (from, _) = if to == from then Nothing else
116− let Just movingTo = Map.lookup from reverseMapping
117− in Just (to, NodeInfo (From_Move from) $ Just movingTo)
118−
119−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
120−patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patch
121− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
122− newList = Map.toList newByIndexUnsorted
123− newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
124− insertsAndMoves :: Map k (NodeInfo k v)
125− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
126− let f k v = do
127− remainingValues <- get
128− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
129− then Map.delete v remainingValues
130− else Map.insert v remainingKeys remainingValues
131− case Map.lookup v remainingValues of
132− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
133− Just fromKs ->
134− if k `Set.member` fromKs
135− then do
136− putRemainingKeys $ Set.delete k fromKs
137− return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
138− else do
139− Just (fromK, remainingKeys) <- return $ Set.minView fromKs -- There's an existing value, but it's not here; move it here
140− putRemainingKeys remainingKeys
141− return $ NodeInfo (From_Move fromK) $ Just undefined
142− Map.traverseWithKey f newByIndex
143− unusedOldKeys = fold unusedValuesByValue
144− pointlessMove k = \case
145− From_Move k' | k == k' -> True
146− _ -> False
147− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
148− then Just undefined
149− else Nothing
150− 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
151−
152−nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
153−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
154−
155−nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
156−nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
157−
158−nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
159−nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
src/Reflex/PerformEvent/Base.hs+9−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
@@ -40,9 +41,9 @@ import Data.Coerce
4041import Data.Dependent.Map (DMap)
4142import qualified Data.Dependent.Map as DMap
4243import Data.Dependent.Sum
43−import Data.FastMutableIntMap
4444import Data.IntMap.Strict (IntMap)
4545import qualified Data.IntMap.Strict as IntMap
46+import qualified Data.Semigroup as S
4647
4748-- | A function that fires events for the given 'EventTrigger's and then runs
4849-- any followup actions provided via 'PerformEvent'. The given 'ReadPhase'
@@ -60,19 +61,21 @@ 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)
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)
6366
6467instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
6568 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
6669 primitive = PerformEventT . lift . primitive
6770
68−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
6972 type Performable (PerformEventT t m) = HostFrame t
7073 {-# INLINABLE performEvent_ #-}
7174 performEvent_ = PerformEventT . requesting_
7275 {-# INLINABLE performEvent #-}
7376 performEvent = PerformEventT . requestingIdentity
7477
75−instance (ReflexHost t, PrimMonad (HostFrame t)) => MonadAdjust t (PerformEventT t m) where
78+instance (ReflexHost t, PrimMonad (HostFrame t)) => Adjustable t (PerformEventT t m) where
7679 runWithReplace outerA0 outerA' = PerformEventT $ runWithReplaceRequesterTWith f (coerce outerA0) (coerceEvent outerA')
7780 where f :: HostFrame t a -> Event t (HostFrame t b) -> RequesterT t (HostFrame t) Identity (HostFrame t) (a, Event t b)
7881 f a0 a' = do
@@ -138,7 +141,7 @@ hostPerformEventT a = do
138141 case mToPerform of
139142 Nothing -> return [result']
140143 Just toPerform -> do
141− responses <- runHostFrame $ traverseRequesterData (\v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
142145 mrt <- readRef responseTrigger
143146 let followupEventTriggers = case mrt of
144147 Just rt -> [rt :=> Identity responses]
@@ -161,6 +164,8 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
161164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
162165 {-# INLINABLE headE #-}
163166 headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
164169
165170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
166171 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+15−3
@@ -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,11 +22,13 @@ 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
2929import Reflex.TriggerEvent.Class
3030
31+import Control.Applicative (liftA2)
3132import Control.Monad.Exception
3233import Control.Monad.Identity
3334import Control.Monad.Primitive
@@ -39,6 +40,7 @@ import qualified Data.Dependent.Map as DMap
3940import Data.Functor.Compose
4041import Data.IntMap.Strict (IntMap)
4142import qualified Data.IntMap.Strict as IntMap
43+import qualified Data.Semigroup as S
4244
4345-- | Provides a basic implementation of 'PostBuild'.
4446newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans, MonadException, MonadAsyncException)
@@ -50,6 +52,14 @@ newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a
5052runPostBuildT :: PostBuildT t m a -> Event t () -> m a
5153runPostBuildT (PostBuildT a) = runReaderT a
5254
55+-- TODO: Monoid and Semigroup can likely be derived once ReaderT has them.
56+instance (Monoid a, Applicative m) => Monoid (PostBuildT t m a) where
57+ mempty = pure mempty
58+ mappend = liftA2 mappend
59+
60+instance (S.Semigroup a, Applicative m) => S.Semigroup (PostBuildT t m a) where
61+ (<>) = liftA2 (S.<>)
62+
5363instance PrimMonad m => PrimMonad (PostBuildT x m) where
5464 type PrimState (PostBuildT x m) = PrimState m
5565 primitive = lift . primitive
@@ -73,6 +83,8 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
7383 buildDynamic a0 = lift . buildDynamic a0
7484 {-# INLINABLE headE #-}
7585 headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
7688
7789instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
7890 type Performable (PostBuildT t m) = Performable m
@@ -107,7 +119,7 @@ instance MonadAtomicRef m => MonadAtomicRef (PostBuildT t m) where
107119 {-# INLINABLE atomicModifyRef #-}
108120 atomicModifyRef r = lift . atomicModifyRef r
109121
110−instance (Reflex t, MonadHold t m, MonadFix m, MonadAdjust t m, PerformEvent t m) => MonadAdjust t (PostBuildT t m) where
122+instance (Reflex t, MonadHold t m, MonadFix m, Adjustable t m, PerformEvent t m) => Adjustable t (PostBuildT t m) where
111123 runWithReplace a0 a' = do
112124 postBuild <- getPostBuild
113125 lift $ do
@@ -141,7 +153,7 @@ mapIntMapWithAdjustImpl base f dm0 dm' = do
141153 rec (result0, result') <- base f' loweredDm0 loweredDm'
142154 cohortDone <- numberOccurrencesFrom_ 1 result'
143155 numberedDm' <- numberOccurrencesFrom 1 dm'
144− let postBuild' = fanInt $ fmapCheap (\n -> IntMap.singleton n ()) cohortDone
156+ let postBuild' = fanInt $ fmapCheap (`IntMap.singleton` ()) cohortDone
145157 loweredDm' = flip pushAlways numberedDm' $ \(n, p) -> do
146158 return $ fmap ((,) (selectInt postBuild' n)) p
147159 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+122−51
@@ -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,38 +16,52 @@ module Reflex.Query.Base
1416 , mapQueryResult
1517 , dynWithQueryT
1618 , withQueryT
19+ , mapQueryT
1720 ) where
1821
22+import Control.Applicative (liftA2)
1923import Control.Monad.Exception
2024import Control.Monad.Fix
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
2127import Control.Monad.Reader
2228import Control.Monad.Ref
2329import Control.Monad.State.Strict
2430import Data.Align
25−import Data.Dependent.Map (DMap, DSum (..))
31+import Data.Dependent.Map (DMap)
2632import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
2734import Data.Foldable
2835import Data.Functor.Compose
2936import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
38+import Data.IntMap (IntMap)
39+import qualified Data.IntMap as IntMap
3040import Data.Map (Map)
3141import qualified Data.Map as Map
32−import Data.Monoid
33−import Data.Some (Some)
34−import qualified Data.Some as Some
42+import Data.Monoid ((<>))
43+import qualified Data.Semigroup as S
44+import Data.Some (Some(Some))
3545import Data.These
3646
3747import Reflex.Class
38−import Reflex.EventWriter
48+import Reflex.Adjustable.Class
49+import Reflex.DynamicWriter.Class
50+import Reflex.EventWriter.Base
51+import Reflex.EventWriter.Class
3952import Reflex.Host.Class
53+import qualified Data.Patch.MapWithMove as MapWithMove
4054import Reflex.PerformEvent.Class
4155import Reflex.PostBuild.Class
4256import Reflex.Query.Class
4357import Reflex.Requester.Class
4458import Reflex.TriggerEvent.Class
45−import qualified Reflex.Patch.MapWithMove as MapWithMove
4659
4760newtype QueryT t q m a = QueryT { unQueryT :: StateT [Behavior t q] (EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m)) a }
48− 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)
4965
5066runQueryT :: (MonadFix m, Additive q, Group q, Reflex t) => QueryT t q m a -> Dynamic t (QueryResult q) -> m (a, Incremental t (AdditivePatch q))
5167runQueryT (QueryT a) qr = do
@@ -60,30 +76,69 @@ getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
6076getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
6177getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
6278
63−{-
64−let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
65− sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
66− bs' = fmapCheap snd $ r'
67− patches = unsafeBuildIncremental (sampleBs bs0) $
68− flip pushCheap bs' $ \bs -> do
69− p <- (~~) <$> sampleBs bs <*> sample (currentIncremental patches)
70− return (Just (AdditivePatch p))
71−-}
72−
73−instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, MonadAdjust t m) => MonadAdjust 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
7483 runWithReplace (QueryT a0) a' = do
7584 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
7685 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
7786 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
7887 bs' = fmapCheap snd $ r'
7988 bbs <- hold bs0 bs'
80− let patches = flip pushAlwaysCheap bs' $ \newBs -> do
89+ let patches = flip pushCheap bs' $ \newBs -> do
8190 oldBs <- sample bbs
82− (~~) <$> sampleBs newBs <*> sampleBs oldBs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
8392 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
8493 QueryT $ lift $ tellEvent patches
8594 return (r0, fmapCheap fst r')
86− 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'))
87142 traverseDMapWithKeyWithAdjust f dm0 dm' = do
88143 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
89144 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -92,10 +147,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
92147 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
93148 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
94149 liftedBs0 :: Map (Some k) [Behavior t q]
95− 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
96151 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
97152 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
98− 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
99154 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
100155 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
101156 accumBehaviors :: forall m'. MonadHold t m'
@@ -111,23 +166,24 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
111166 let p k bs = case Map.lookup k bs0 of
112167 Nothing -> case bs of
113168 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
114− Nothing -> return mempty
169+ Nothing -> return Nothing
115170 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
116− Just newBs -> sampleBs newBs
171+ Just newBs -> maskMempty <$> sampleBs newBs
117172 Just oldBs -> case bs of
118173 -- 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
119− Nothing -> negateG <$> sampleBs oldBs
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
120175 -- 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
121176 -- composed with the sampling the child's new state.
122− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
123178 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
124179 -- child patches and wrap them in AdditivePatch.
125− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
126− return (apply pbs bs0, Just patch)
180+ patch <- fold <$> Map.traverseWithKey p bs'
181+ return (apply pbs bs0, AdditivePatch <$> patch)
127182 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
128183 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
129184 return (liftedResult0, liftedResult')
130− 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'))
131187 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
132188 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
133189 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -135,10 +191,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
135191 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
136192 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
137193 liftedBs0 :: Map (Some k) [Behavior t q]
138− 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
139195 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
140196 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
141− 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 -}
142198 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
143199 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
144200 accumBehaviors' :: forall m'. MonadHold t m'
@@ -155,28 +211,28 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
155211 p k bs = case Map.lookup k bs0 of
156212 Nothing -> case MapWithMove._nodeInfo_from bs of
157213 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
158− MapWithMove.From_Delete -> return mempty
214+ MapWithMove.From_Delete -> return Nothing
159215 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
160− MapWithMove.From_Insert newBs -> sampleBs newBs
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
161217 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
162− Nothing -> return mempty
163− Just newBs -> sampleBs newBs
218+ Nothing -> return Nothing
219+ Just newBs -> maskMempty <$> sampleBs newBs
164220 Just oldBs -> case MapWithMove._nodeInfo_from bs of
165221 -- 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
166− MapWithMove.From_Delete -> negateG <$> sampleBs oldBs
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
167223 -- 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
168224 -- composed with the sampling the child's new state.
169− MapWithMove.From_Insert newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
225+ MapWithMove.From_Insert newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
170226 MapWithMove.From_Move k'
171− | k' == k -> return mempty
227+ | k' == k -> return Nothing
172228 | otherwise -> case Map.lookup k' bs0 of
173229 -- If we are moving from a non-existent key, that is a delete
174− Nothing -> negateG <$> sampleBs oldBs
175− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
176232 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
177233 -- child patches and wrap them in AdditivePatch.
178− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
179− return (apply pbs bs0, Just patch)
234+ patch <- fold <$> Map.traverseWithKey p bs'
235+ return (apply pbs bs0, AdditivePatch <$> patch)
180236 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
181237 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
182238 return (liftedResult0, liftedResult')
@@ -184,6 +240,13 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
184240instance MonadTrans (QueryT t q) where
185241 lift = QueryT . lift . lift . lift
186242
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+
187250instance PostBuild t m => PostBuild t (QueryT t q m) where
188251 getPostBuild = lift getPostBuild
189252
@@ -210,11 +273,13 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (QueryT t q
210273 newEventWithTrigger = QueryT . newEventWithTrigger
211274 newFanEventWithTrigger a = QueryT . lift $ newFanEventWithTrigger a
212275
213−mapQuery :: QueryMorphism q q' -> q -> q'
214−mapQuery = _queryMorphism_mapQuery
276+-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
277+instance (Monoid a, Monad m) => Monoid (QueryT t q m a) where
278+ mempty = pure mempty
279+ mappend = (<>)
215280
216−mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
217−mapQueryResult = _queryMorphism_mapQueryResult
281+instance (S.Semigroup a, Monad m) => S.Semigroup (QueryT t q m a) where
282+ (<>) = liftA2 (S.<>)
218283
219284-- | withQueryT's QueryMorphism argument needs to be a group homomorphism in order to behave correctly
220285withQueryT :: (MonadFix m, PostBuild t m, Group q, Group q', Additive q, Additive q', Query q')
@@ -229,6 +294,10 @@ withQueryT f a = do
229294 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
230295 return result
231296
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+
232301-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
233302dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
234303 => Dynamic t (QueryMorphism q q')
@@ -241,7 +310,7 @@ dynWithQueryT f q = do
241310 return result
242311 where zipDynIncrementalWith g da ib =
243312 let eab = align (updated da) (updatedIncremental ib)
244− ec = flip push eab $ \o -> case o of
313+ ec = flip push eab $ \case
245314 This a -> do
246315 aOld <- sample $ current da
247316 b <- sample $ currentIncremental ib
@@ -262,8 +331,7 @@ instance (Monad m, Group q, Additive q, Query q, Reflex t) => MonadQuery t q (Qu
262331 askQueryResult = QueryT ask
263332 queryIncremental q = do
264333 tellQueryIncremental q
265− r <- askQueryResult
266− return $ zipDynWith crop (incrementalToDynamic q) r
334+ zipDynWith crop (incrementalToDynamic q) <$> askQueryResult
267335
268336instance Requester t m => Requester t (QueryT t q m) where
269337 type Request (QueryT t q m) = Request m
@@ -273,3 +341,6 @@ instance Requester t m => Requester t (QueryT t q m) where
273341
274342instance EventWriter t w m => EventWriter t w (QueryT t q m) where
275343 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+215−27
@@ -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
@@ -40,17 +48,20 @@ import Reflex.PostBuild.Class
4048import Reflex.Requester.Class
4149import Reflex.TriggerEvent.Class
4250
51+import Control.Applicative (liftA2)
4352import Control.Monad.Exception
4453import Control.Monad.Identity
54+import Control.Monad.Morph
55+import Control.Monad.Primitive
4556import Control.Monad.Reader
4657import Control.Monad.Ref
4758import Control.Monad.State.Strict
4859import Data.Bits
4960import Data.Coerce
50−import Data.Dependent.Map (DMap, DSum (..))
61+import Data.Constraint
62+import Data.Dependent.Map (DMap)
5163import qualified Data.Dependent.Map as DMap
52−import qualified Data.Some as Some
53−import Data.FastMutableIntMap
64+import Data.Dependent.Sum (DSum (..))
5465import Data.Functor.Compose
5566import Data.Functor.Misc
5667import Data.IntMap.Strict (IntMap)
@@ -58,10 +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
62−import Data.Some (Some)
63−import Data.Type.Equality
6472import Data.Proxy
73+import qualified Data.Semigroup as S
74+import Data.Some (Some(Some))
75+import Data.Type.Equality
76+import Data.Unique.Tag
6577
6678import GHC.Exts (Any)
6779import Unsafe.Coerce
@@ -72,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
7284
7385newtype RequesterData f = RequesterData (TagMap (Entry f))
7486
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
7590data RequesterDataKey a where
7691 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
7792 RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
78− RequesterDataKey_Multi2 :: {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
93+ RequesterDataKey_Multi2 :: GCompare k => {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
7994 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
8095
8196singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
8297singletonRequesterData rdk v = case rdk of
8398 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
8499 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
85− RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Map.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
100+ RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Multi2Contents
101+ { _multi2Contents_values = Map.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
102+ , _multi2Contents_dict = Dict
103+ }
86104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
87105
106+mergeRequesterData :: RequesterData f -> RequesterData f -> RequesterData f
107+mergeRequesterData (RequesterData a) (RequesterData b) = RequesterData $ mergeTagMap a b
108+
109+mergeTagMap :: forall f. TagMap (Entry f) -> TagMap (Entry f) -> TagMap (Entry f)
110+mergeTagMap (TagMap m) (TagMap n) =
111+ TagMap $ IntMap.unionWithKey (g' combiner) m n
112+ where
113+ combiner :: forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a
114+ combiner k (Entry a) (Entry b) = Entry $ case myKeyType k of
115+ MyTagType_Single -> a
116+ MyTagType_Multi -> IntMap.unionWith mergeRequesterData a b
117+ MyTagType_Multi2 -> case _multi2Contents_dict a of
118+ Dict -> Multi2Contents
119+ { _multi2Contents_values = Map.unionWith (IntMap.unionWith mergeRequesterData) (_multi2Contents_values a) (_multi2Contents_values b)
120+ , _multi2Contents_dict = Dict
121+ }
122+ MyTagType_Multi3 -> IntMap.unionWith (IntMap.unionWith mergeRequesterData) a b
123+ g' :: (forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a) -> Int -> Any -> Any -> Any
124+ g' f rawKey a b =
125+ let k = MyTag rawKey :: MyTag a
126+ fromAny :: Any -> Entry f a
127+ fromAny = unsafeCoerce
128+ toAny :: Entry f a -> Any
129+ toAny = unsafeCoerce
130+ in toAny $ f k (fromAny a) (fromAny b)
131+
88132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
89133requesterDataToList (RequesterData m) = do
90134 k :=> Entry e <- tagMapToList m
@@ -94,11 +138,12 @@ requesterDataToList (RequesterData m) = do
94138 (k', e') <- IntMap.toList e
95139 k'' :=> e'' <- requesterDataToList e'
96140 return $ RequesterDataKey_Multi k k' k'' :=> e''
97− MyTagType_Multi2 -> do
98− (k', e') <- Map.toList e
99− (k'', e'') <- IntMap.toList e'
100− k''' :=> e''' <- requesterDataToList e''
101− return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
141+ MyTagType_Multi2 -> case _multi2Contents_dict e of
142+ Dict -> do
143+ (k', e') <- Map.toList $ _multi2Contents_values e
144+ (k'', e'') <- IntMap.toList e'
145+ k''' :=> e''' <- requesterDataToList e''
146+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
102147 MyTagType_Multi3 -> do
103148 (k', e') <- IntMap.toList e
104149 (k'', e'') <- IntMap.toList e'
@@ -109,9 +154,9 @@ singletonTagMap :: forall f a. MyTag a -> f a -> TagMap f
109154singletonTagMap (MyTag k) v = TagMap $ IntMap.singleton k $ (unsafeCoerce :: f a -> Any) v
110155
111156tagMapToList :: forall f. TagMap f -> [DSum MyTag f]
112−tagMapToList (TagMap m) = fmap f $ IntMap.toList m
157+tagMapToList (TagMap m) = f <$> IntMap.toList m
113158 where f :: (Int, Any) -> DSum MyTag f
114− f (k, v) = MyTag k :=> ((unsafeCoerce :: Any -> f a) v)
159+ f (k, v) = MyTag k :=> (unsafeCoerce :: Any -> f a) v
115160
116161traverseTagMapWithKey :: forall t f g. Applicative t => (forall a. MyTag a -> f a -> t (g a)) -> TagMap f -> t (TagMap g)
117162traverseTagMapWithKey f (TagMap m) = TagMap <$> IntMap.traverseWithKey g m
@@ -126,9 +171,19 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
126171 go k (Entry request) = Entry <$> case myKeyType k of
127172 MyTagType_Single -> f request
128173 MyTagType_Multi -> traverse (traverseRequesterData f) request
129− MyTagType_Multi2 -> traverse (traverse (traverseRequesterData f)) request
174+ MyTagType_Multi2 -> case request of
175+ Multi2Contents { _multi2Contents_values = request', _multi2Contents_dict = Dict } -> do
176+ v <- traverse (traverse (traverseRequesterData f)) request'
177+ pure $ Multi2Contents
178+ { _multi2Contents_values = v
179+ , _multi2Contents_dict = Dict
180+ }
130181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
131182
183+-- | 'traverseRequesterData' with its arguments flipped
184+forRequesterData :: forall request response m. Applicative m => RequesterData request -> (forall a. request a -> m (response a)) -> m (RequesterData response)
185+forRequesterData r f = traverseRequesterData f r
186+
132187data MyTagType :: * -> * where
133188 MyTagType_Single :: MyTagType (Single a)
134189 MyTagType_Multi :: MyTagType Multi
@@ -166,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
166221type family EntryContents request a where
167222 EntryContents request (Single a) = request a
168223 EntryContents request Multi = IntMap (RequesterData request)
169− EntryContents request (Multi2 k) = Map (Some k) (IntMap (RequesterData request))
224+ EntryContents request (Multi2 k) = Multi2Contents k request
170225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
171226
227+data Multi2Contents k request = Multi2Contents
228+ { _multi2Contents_dict :: {-# UNPACK #-} !(Dict (GCompare k)) -- This is a Dict instead of an existential context because we only want to use it in certain circumstances
229+ , _multi2Contents_values :: {-# UNPACK #-} !(Map (Some k) (IntMap (RequesterData request)))
230+ }
231+
172232newtype Entry request x = Entry { unEntry :: EntryContents request x }
173233
174234{-# INLINE singleEntry #-}
@@ -238,11 +298,23 @@ deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
238298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
239299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
240300
301+instance PrimMonad m => PrimMonad (RequesterT t request response m) where
302+ type PrimState (RequesterT t request response m) = PrimState m
303+ primitive = lift . primitive
304+
305+-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
306+instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
307+ mempty = pure mempty
308+ mappend = liftA2 mappend
309+
310+instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response m a) where
311+ (<>) = liftA2 (S.<>)
312+
313+
241314-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
242315-- requests are made, and responses should be provided in the input 'Event'.
243316-- The 'Tag' keys will be used to return the responses to the same place the
244317-- requests were issued.
245−
246318runRequesterT :: (Reflex t, Monad m)
247319 => RequesterT t request response m a
248320 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
@@ -252,6 +324,20 @@ runRequesterT (RequesterT a) responses = do
252324 coerceEvent responses
253325 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
254326
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+
255341instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
256342 type Request (RequesterT t request response m) = request
257343 type Response (RequesterT t request response m) = response
@@ -271,7 +357,7 @@ tagRequest req = do
271357 return t
272358
273359{-# INLINE responseFromTag #-}
274−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))
275361responseFromTag (MyTagWrap t) = do
276362 responses :: EventSelectorInt t Any <- RequesterT ask
277363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -279,6 +365,9 @@ responseFromTag (MyTagWrap t) = do
279365instance MonadTrans (RequesterT t request response) where
280366 lift = RequesterT . lift . lift
281367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
282371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
283372 type Performable (RequesterT t request response m) = Performable m
284373 performEvent_ = lift . performEvent_
@@ -299,14 +388,14 @@ instance MonadReader r m => MonadReader r (RequesterT t request response m) wher
299388 local f (RequesterT a) = RequesterT $ mapStateT (mapReaderT $ local f) a
300389 reader = lift . reader
301390
302−instance (Reflex t, MonadAdjust t m, MonadHold t m, MonadFix m) => MonadAdjust t (RequesterT t request response m) where
391+instance (Reflex t, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (RequesterT t request response m) where
303392 runWithReplace = runWithReplaceRequesterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
304393 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElementsMap mergeIntIncremental
305394 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
306395 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
307396 traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
308397
309−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))
310399requesting' = responseFromTag . castMyTagWrap <=< tagRequest
311400
312401{-# INLINABLE runWithReplaceRequesterTWith #-}
@@ -355,10 +444,10 @@ traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIn
355444 pack = Entry
356445 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
357446 f' k (n, v) = do
358− (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?
359448 return (fmapCheap (IntMap.singleton n) myRequests, result)
360449 ndm' <- numberOccurrencesFrom 1 dm'
361− (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 MonadAdjust
450+ (children0, children') <- base f' (fmap ((,) 0) dm0) $ fmap (\(n, dm) -> fmap ((,) n) dm) ndm' --TODO: Avoid this somehow, probably by adding some sort of per-cohort information passing to Adjustable
362451 let result0 = fmap snd children0
363452 result' = fforCheap children' $ fmap snd
364453 requests0 :: IntMap (Event t (IntMap (RequesterData request)))
@@ -398,12 +487,12 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
398487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
399488 responses = fanMap $ fmapCheap unpack response
400489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
401− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
402491 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
403− pack = Entry
492+ pack m = Entry $ Multi2Contents { _multi2Contents_values = m, _multi2Contents_dict = Dict }
404493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
405494 f' k (Compose (n, v)) = do
406− (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))
407496 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
408497 ndm' <- numberOccurrencesFrom 1 dm'
409498 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
@@ -417,3 +506,102 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
417506 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
418507 requests <- holdIncremental requests0 requests'
419508 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+977−506
@@ -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,62 +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
92−import Reflex.Patch
93−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
94−
95−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
96−import Prelude hiding (any, concat, mapM, mapM_, sequence)
108+import Reflex.NotReady.Class
109+import Data.Patch
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111+import Reflex.PerformEvent.Base (PerformEventT)
97112
98113#ifdef DEBUG_TRACE_EVENTS
99−import System.IO (stderr)
100114import qualified Data.ByteString.Char8 as BS8
115+import System.IO (stderr)
116+import Data.List (isPrefixOf)
101117#endif
102118
103−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
104122
123+#ifdef DEBUG_TRACE_EVENTS
105124withStackOneLine :: (BS8.ByteString -> a) -> a
106125withStackOneLine expr = unsafePerformIO $ do
107126 stack <- currentCallStack
108− return (expr (BS8.pack (unwords (reverse stack))))
127+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128+ where dropInternal = filterStack "Reflex.Spider.Internal"
109129
110130#endif
111131
@@ -116,28 +136,42 @@ debugInvalidateHeight :: Bool
116136debugInvalidate :: Bool
117137
118138#ifdef DEBUG
119−
120139#define DEBUG_NODEIDS
121140
141+#ifdef DEBUG_TRACE_PROPAGATION
122142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
123146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
124150debugInvalidateHeight = False
151+#endif
125152
153+#ifdef DEBUG_TRACE_INVALIDATION
126154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
127158
128159class HasNodeId a where
129160 getNodeId :: a -> Int
130161
131−instance HasNodeId (Hold x p a) where
132− getNodeId = holdNodeId
162+instance HasNodeId (CacheSubscribed x a) where
163+ getNodeId = _cacheSubscribed_nodeId
133164
134−instance HasNodeId (PushSubscribed x a b) where
135− getNodeId = pushSubscribedNodeId
165+instance HasNodeId (FanInt x a) where
166+ getNodeId = _fanInt_nodeId
167+
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
136170
137171instance HasNodeId (SwitchSubscribed x a) where
138172 getNodeId = switchSubscribedNodeId
139173
140−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
141175 getNodeId = fanSubscribedNodeId
142176
143177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -151,41 +185,16 @@ instance HasNodeId (Pull x a) where
151185
152186{-# INLINE showNodeId #-}
153187showNodeId :: HasNodeId a => a -> String
154−showNodeId = ("#"<>) . show . getNodeId
155−
156−showSubscriberType :: Subscriber x a -> String
157−showSubscriberType = \case
158− SubscriberPush _ _ -> "SubscriberPush"
159− SubscriberMerge _ _ -> "SubscriberMerge"
160− SubscriberFan _ -> "SubscriberFan"
161− SubscriberMergeChange _ -> "SubscriberMergeChange"
162− SubscriberHold _ -> "SubscriberHold"
163− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
164− SubscriberSwitch _ -> "SubscriberSwitch"
165− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
166− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
167− SubscriberHandle -> "SubscriberHandle"
168−
169−showEventType :: Event x a -> String
170−showEventType = \case
171− EventRoot _ _ -> "EventRoot"
172− EventNever -> "EventNever"
173− EventPush _ -> "EventPush"
174− EventMerge _ -> "EventMerge"
175− EventFan _ _ -> "EventFan"
176− EventSwitch _ -> "EventSwitch"
177− EventCoincidence _ -> "EventCoincidence"
178− EventHold _ -> "EventHold"
179− EventDyn _ -> "EventDyn"
180− EventHoldIdentity _ -> "EventHoldIdentity"
181− EventDynIdentity _ -> "EventDynIdentity"
188+showNodeId = showNodeId' . getNodeId
189+
190+showNodeId' :: Int -> String
191+showNodeId' = ("#"<>) . show
192+
182193
183194#else
184195
185196debugPropagate = False
186−
187197debugInvalidateHeight = False
188−
189198debugInvalidate = False
190199
191200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -193,6 +202,10 @@ debugInvalidate = False
193202showNodeId :: a -> String
194203showNodeId _ = ""
195204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
196209#endif
197210
198211#ifdef DEBUG_NODEIDS
@@ -202,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
202215
203216newNodeId :: IO Int
204217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
205−
206−{-# NOINLINE unsafeNodeId #-}
207−unsafeNodeId :: a -> Int
208−unsafeNodeId a = unsafePerformIO $ do
209− touch a
210− newNodeId
211218#endif
212219
213220--------------------------------------------------------------------------------
@@ -246,7 +253,7 @@ subscribeAndRead = unEvent
246253{-# INLINE [1] pushCheap #-}
247254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
248255pushCheap !f e = Event $ \sub -> do
249− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
250257 { subscriberPropagate = \a -> do
251258 mb <- f a
252259 mapM_ (subscriberPropagate sub) mb
@@ -265,10 +272,10 @@ terminalSubscriber p = Subscriber
265272
266273-- | Subscribe to an Event only for the duration of one occurrence
267274{-# INLINE subscribeAndReadHead #-}
268−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)
269276subscribeAndReadHead e sub = do
270277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
271− (subscription, occ) <- subscribeAndRead e $ sub
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
272279 { subscriberPropagate = \a -> do
273280 liftIO $ unsubscribe =<< readIORef subscriptionRef
274281 subscriberPropagate sub a
@@ -279,24 +286,42 @@ subscribeAndReadHead e sub = do
279286 return (subscription, occ)
280287
281288--TODO: Make this lazy in its input event
282−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)
283290headE originalE = do
284291 parent <- liftIO $ newIORef $ Just originalE
285292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
286293 let clearParent = liftIO $ writeIORef parent Nothing
287− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
288295 when (isJust occ) clearParent
289− return $ Event $ \sub -> do
296+ return $ Event $ \sub ->
290297 liftIO (readIORef parent) >>= \case
291− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
298+ Nothing -> subscribeAndReadNever
292299 Just e -> subscribeAndReadHead e sub
293300
294301data CacheSubscribed x a
295302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
296303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
297304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
298308 }
299309
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+
300325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
301326-- repeatedly
302327--
@@ -311,27 +336,33 @@ cacheEvent e =
311336#else
312337 Event $
313338#endif
314− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
315− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
316− in \sub -> {-# SCC "cacheEvent" #-} do
339+ unsafePerformIO $ do
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341+ <- newIORef emptyFastWeak
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
317343#ifdef DEBUG_TRACE_EVENTS
318344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
319345#endif
320346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
321347 Just subscribedTicket -> return subscribedTicket
322348 Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
323352 subscribers <- liftIO FastWeakBag.empty
324353 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
325357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
326− { subscriberPropagate = \a -> do
327− liftIO $ writeIORef occRef $ Just a
328− scheduleClear occRef
329− propagateFast a subscribers
330− , subscriberInvalidateHeight = \old -> do
331− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
332− , subscriberRecalculateHeight = \new -> do
333− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
334− }
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+ }
335366 when (isJust occ) $ do
336367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
337368 scheduleClear occRef
@@ -339,29 +370,45 @@ cacheEvent e =
339370 { _cacheSubscribed_subscribers = subscribers
340371 , _cacheSubscribed_parent = parentSub
341372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
342376 }
343377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
344378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
345379 return subscribedTicket
346− liftIO $ do
347− subscribed <- getFastWeakTicketValue subscribedTicket
348− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
349− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
350− let es = EventSubscription
351− { _eventSubscription_unsubscribe = do
352− FastWeakBag.remove ticket
353− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
354− when isEmpty $ do
355− writeIORef mSubscribedRef emptyFastWeak
356− unsubscribe $ _cacheSubscribed_parent subscribed
357− touch ticket
358− touch subscribedTicket
359− , _eventSubscription_subscribed = EventSubscribed
360− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
361− , eventSubscribedRetained = toAny subscribedTicket
362− }
363− }
364− 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+
365412
366413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
367414subscribe e s = fst <$> subscribeAndRead e s
@@ -373,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
373420 let es = tag subd
374421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
375422
376−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
377424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
378425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
379429eventNever :: Event x a
380−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
381431
382−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)
383433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
384434
385435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -388,7 +438,7 @@ eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
388438eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
389439eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
390440
391−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
441+eventHold :: Hold x p -> Event x p
392442eventHold !h = Event $ subscribeHoldEvent h
393443
394444eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
@@ -414,16 +464,6 @@ data Subscriber x a = Subscriber
414464 , subscriberRecalculateHeight :: !(Height -> IO ())
415465 }
416466
417−--TODO: Move this comment to WeakBag
418−-- These function are constructor functions that are marked NOINLINE so they are
419−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
420−-- so any weak references that are attached to the constructors will have their
421−-- finalizer run. Using the opaque constructor, does not see the
422−-- constructor application, so it behaves like an IORef and cannot be fused away.
423−--
424−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
425−-- the weak pointer to it in some cases.
426−
427467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
428468newSubscriberHold h = return $ Subscriber
429469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -431,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
431471 , subscriberRecalculateHeight = \_ -> return ()
432472 }
433473
434−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
435−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
436476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
437477 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
438− 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"
439479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
440480 scheduleClear $ fanSubscribedOccurrence subscribed
441− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
442482 propagate v $ _fanSubscribedChildren_list subsubs
443483 return $ Constant ()
444484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
445485 return ()
446486 , subscriberInvalidateHeight = \old -> do
447− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
448487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
449− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
450− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
451489 , subscriberRecalculateHeight = \new -> do
452− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
453490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
454− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
455− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
456492 }
457493
458494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
459−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
460496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
461− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
462497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
463498 scheduleClear $ switchSubscribedOccurrence subscribed
464499 propagate a $ switchSubscribedSubscribers subscribed
465500 , subscriberInvalidateHeight = \_ -> do
466− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
467501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
468502 when (oldHeight /= invalidHeight) $ do
469503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
470− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
471− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
472− , subscriberRecalculateHeight = \new -> do
473− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
474− updateSwitchHeight new subscribed
475− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
476− }
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
506+ }
477507
478508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
479−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
480510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
481− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
482511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
483512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
484513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
485514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
486515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
487517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
488518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
489519 case occ of
490− Nothing -> do
520+ Nothing ->
491521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
492522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
493− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
494− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
495525 Just o -> do -- Since it's already firing, no need to adjust height
496526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
497527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
498528 propagate o $ coincidenceSubscribedSubscribers subscribed
499− , subscriberInvalidateHeight = \_ -> do
500− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
501− invalidateCoincidenceHeight subscribed
502− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
503− , subscriberRecalculateHeight = \_ -> do
504− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
505− recalculateCoincidenceHeight subscribed
506− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
529+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
507531 }
508532
509533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
510−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
511535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
512− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
513536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
514537 case occ of
515538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -517,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
517540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
518541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
519542 propagate a $ coincidenceSubscribedSubscribers subscribed
520− , subscriberInvalidateHeight = \_ -> do
521− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
522− invalidateCoincidenceHeight subscribed
523− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
524− , subscriberRecalculateHeight = \_ -> do
525− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
526− recalculateCoincidenceHeight subscribed
527− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
543+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
528545 }
529546
530547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -534,18 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
534551recalculateSubscriberHeight = flip subscriberRecalculateHeight
535552
536553-- | Propagate everything at the current height
537−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
538−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) $
539556 -- 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
540557 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
541− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
542559
543560-- | Propagate everything at the current height
544−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
545−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) $
546563 -- 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
547564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
548− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
549566
550567--------------------------------------------------------------------------------
551568-- EventSubscribed
@@ -554,11 +571,16 @@ propagateFast a subscribers = withIncreasedDepth $ do
554571toAny :: a -> Any
555572toAny = unsafeCoerce
556573
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.
557579data EventSubscribed x = EventSubscribed
558580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
559581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
560582#ifdef DEBUG_CYCLES
561− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
562584 , eventSubscribedHasOwnHeightRef :: !Bool
563585 , eventSubscribedWhoCreated :: !(IO [String])
564586#endif
@@ -585,13 +607,23 @@ eventSubscribedNever = EventSubscribed
585607 , eventSubscribedWhoCreated = return ["never"]
586608#endif
587609 }
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+ }
588620
589−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
590622eventSubscribedFan !subscribed = EventSubscribed
591623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
592624 , eventSubscribedRetained = toAny subscribed
593625#ifdef DEBUG_CYCLES
594− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
595627 , eventSubscribedHasOwnHeightRef = False
596628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
597629#endif
@@ -604,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
604636#ifdef DEBUG_CYCLES
605637 , eventSubscribedGetParents = do
606638 s <- readIORef $ switchSubscribedCurrentParent subscribed
607− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
608640 , eventSubscribedHasOwnHeightRef = True
609641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
610642#endif
@@ -617,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
617649#ifdef DEBUG_CYCLES
618650 , eventSubscribedGetParents = do
619651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
620− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
621− innerParents = maybeToList $ fmap Some.This innerSubscription
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
653+ innerParents = maybeToList $ innerSubscription
622654 return $ outerParent : innerParents
623655 , eventSubscribedHasOwnHeightRef = True
624656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -632,20 +664,20 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
632664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
633665whoCreatedEventSubscribed = eventSubscribedWhoCreated
634666
635−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
636668walkInvalidHeightParents s0 = do
637− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
669+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
638670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
639671 when (h == invalidHeight) $ do
640672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
641− modify (Some.This s :)
673+ modify (s :)
642674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
643− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
644676 return subscribers
645677#endif
646678
647679{-# INLINE subscribeHoldEvent #-}
648−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)
649681subscribeHoldEvent = subscribeAndRead . holdEvent
650682
651683--------------------------------------------------------------------------------
@@ -668,7 +700,7 @@ behaviorPull !p = Behavior $ do
668700 val <- liftIO $ readIORef $ pullValue p
669701 case val of
670702 Just subscribed -> do
671− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
672704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
673705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
674706 return $ pullSubscribedValue subscribed
@@ -677,7 +709,7 @@ behaviorPull !p = Behavior $ do
677709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
678710 parentsRef <- liftIO $ newIORef []
679711 holdInits <- askBehaviorHoldInits
680− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
681713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
682714 parents <- liftIO $ readIORef parentsRef
683715 let subscribed = PullSubscribed
@@ -687,7 +719,7 @@ behaviorPull !p = Behavior $ do
687719 , pullSubscribedParents = parents
688720 }
689721 liftIO $ writeIORef (pullValue p) $ Just subscribed
690− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
722+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
691723 return a
692724
693725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -698,7 +730,8 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
698730readHoldTracked h = do
699731 result <- liftIO $ readIORef $ holdValue h
700732 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
701− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
733+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
734+ liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
702735 return result
703736
704737{-# INLINABLE readBehaviorUntracked #-}
@@ -711,42 +744,46 @@ readBehaviorUntracked b = do
711744-- Dynamic
712745--------------------------------------------------------------------------------
713746
714−data Dynamic x p = Dynamic
715− { dynamicCurrent :: !(Behavior x (PatchTarget p))
716− , 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`?
717752 }
718753
719−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
720760dynamicHold !h = Dynamic
721761 { dynamicCurrent = behaviorHold h
722762 , dynamicUpdated = eventHold h
723763 }
724764
725−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
726766dynamicHoldIdentity = dynamicHold
727767
728−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
729769dynamicConst !a = Dynamic
730770 { dynamicCurrent = behaviorConst a
731771 , dynamicUpdated = eventNever
732772 }
733773
734−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
735775dynamicDyn !d = Dynamic
736776 { dynamicCurrent = behaviorDyn d
737777 , dynamicUpdated = eventDyn d
738778 }
739779
740−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
741781dynamicDynIdentity = dynamicDyn
742782
743783--------------------------------------------------------------------------------
744784-- Combinators
745785--------------------------------------------------------------------------------
746786
747−--TODO: Figure out why certain things are not 'representational', then make them
748−--representational so we can use coerce
749−
750787--type role Hold representational
751788data Hold x p
752789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -758,9 +795,7 @@ data Hold x p
758795#endif
759796 }
760797
761−-- | A statically allocated 'SpiderTimeline'; this is the only instance of
762−-- 'SpiderTimeline' that can used when using
763−-- -fspecialize-to-spidertimeline-global.
798+-- | A statically allocated 'SpiderTimeline'
764799data Global
765800
766801{-# NOINLINE globalSpiderTimelineEnv #-}
@@ -769,30 +804,27 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
769804
770805-- | Stores all global data relevant to a particular Spider timeline; only one
771806-- value should exist for each type @x@
772−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
773813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
774814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
775815#ifdef DEBUG
776816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
777817#endif
778818 }
779−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
780820
781821instance Eq (SpiderTimelineEnv x) where
782822 _ == _ = True -- Since only one exists of each type
783823
784824instance GEq SpiderTimelineEnv where
785−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
786− geqToEq _ = id
787− geqUnify (a :: SpiderTimelineEnv a) (b :: SpiderTimelineEnv b) different same = if _spiderTimeline_lock a == _spiderTimeline_lock b
788− then case unsafeCoerce Refl :: a :~: b of
789− Refl -> same -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
790− else different
791−#else
792− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
825+ a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
793826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
794827 else Nothing
795−#endif
796828
797829data EventEnv x
798830 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
@@ -800,9 +832,9 @@ data EventEnv x
800832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
801833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
802834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
803− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
804− , eventEnvIntClears :: !(IORef [SomeIntClear])
805− , eventEnvRootClears :: !(IORef [SomeRootClear])
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
806838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
807839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
808840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -813,7 +845,7 @@ runEventM :: EventM x a -> IO a
813845runEventM = unEventM
814846
815847asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
816−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
848+asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
817849
818850class MonadIO m => Defer a m where
819851 getDeferralQueue :: m (IORef [a])
@@ -862,11 +894,7 @@ instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
862894 delayedRef <- asksEventEnv eventEnvDelayedMerges
863895 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
864896
865−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
866−class x ~ Global => HasSpiderTimeline x where
867−#else
868897class HasSpiderTimeline x where
869−#endif
870898 -- | Retrieve the current SpiderTimelineEnv
871899 spiderTimeline :: SpiderTimelineEnv x
872900
@@ -878,29 +906,29 @@ putCurrentHeight h = do
878906 heightRef <- asksEventEnv eventEnvCurrentHeight
879907 liftIO $ writeIORef heightRef $! h
880908
881−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
882910 {-# INLINE getDeferralQueue #-}
883911 getDeferralQueue = asksEventEnv eventEnvClears
884912
885913{-# INLINE scheduleClear #-}
886−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
887−scheduleClear r = defer $ SomeClear r
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
915+scheduleClear r = defer $ Some $ Clear r
888916
889−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
890918 {-# INLINE getDeferralQueue #-}
891919 getDeferralQueue = asksEventEnv eventEnvIntClears
892920
893921{-# INLINE scheduleIntClear #-}
894−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
895−scheduleIntClear r = defer $ SomeIntClear r
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923+scheduleIntClear r = defer $ Some $ IntClear r
896924
897−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
898926 {-# INLINE getDeferralQueue #-}
899927 getDeferralQueue = asksEventEnv eventEnvRootClears
900928
901929{-# INLINE scheduleRootClear #-}
902−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
903−scheduleRootClear r = defer $ SomeRootClear r
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
931+scheduleRootClear r = defer $ Some $ RootClear r
904932
905933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
906934 {-# INLINE getDeferralQueue #-}
@@ -955,9 +983,9 @@ getHoldEventSubscription h = do
955983
956984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
957985
958−--type role BehaviorM representational
959986-- BehaviorM can sample behaviors
960−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))
961989
962990instance Monad (BehaviorM x) where
963991 {-# INLINE (>>=) #-}
@@ -966,14 +994,16 @@ instance Monad (BehaviorM x) where
966994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
967995 {-# INLINE return #-}
968996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
969998 {-# INLINE fail #-}
970999 fail s = BehaviorM $ fail s
1000+#endif
9711001
9721002data BehaviorSubscribed x a
9731003 = forall p. BehaviorSubscribedHold (Hold x p)
9741004 | BehaviorSubscribedPull (PullSubscribed x a)
9751005
976−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
9771007
9781008--type role PullSubscribed representational
9791009data PullSubscribed x a
@@ -1008,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
10081038#endif
10091039 }
10101040
1011−data Root x (k :: * -> *)
1041+data Root x k
10121042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
10131043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
10141044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -1027,7 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
10271057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
10281058
10291059-- EventM can do everything BehaviorM can, plus create holds
1030−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)
10311061
10321062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
10331063
@@ -1052,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
10521082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
10531083
10541084heightBagAdd :: Height -> HeightBag -> HeightBag
1055−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
10561087
10571088heightBagRemove :: Height -> HeightBag -> HeightBag
10581089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1061,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
10611092 0 -> IntMap.delete h c
10621093 _ -> IntMap.insert h (pred old) c
10631094
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+
10641102heightBagMax :: HeightBag -> Height
10651103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
10661104 Just ((h, _), _) -> Height h
@@ -1078,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
10781116heightBagVerify = id
10791117#endif
10801118
1081−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1082− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1083− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1084− , _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)))
10851123 }
10861124
1087−data FanSubscribed (x :: *) k
1088− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1089− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1090− , 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
10911129 , fanSubscribedParent :: !(EventSubscription x)
10921130#ifdef DEBUG_NODEIDS
10931131 , fanSubscribedNodeId :: Int
10941132#endif
10951133 }
10961134
1097−data Fan x k
1098− = Fan { fanParent :: !(Event x (DMap k Identity))
1099− , 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)))
11001138 }
11011139
11021140data SwitchSubscribed x a
@@ -1150,20 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
11501188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
11511189newInvalidatorPull p = return $! InvalidatorPull p
11521190
1153−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1154− fmapMaybe f = push $ return . f
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1192+ mapMaybe f = push $ return . f
11551193
11561194instance HasSpiderTimeline x => Align (Event x) where
11571195 nil = eventNever
1158− 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)
11591212
1160−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) }
11611214
1162−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)
11631216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
11641217
11651218--TODO: Avoid the duplication between this and R.zipDynWith
1166−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)
11671220zipDynWith f da db =
11681221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
11691222 ec = flip push eab $ \o -> do
@@ -1178,26 +1231,20 @@ zipDynWith f da db =
11781231 return $ Just $ Identity $ f a b
11791232 in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
11801233
1181−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)
11821235buildDynamic readV0 v' = do
1183− result <- liftIO $ newIORef $ Left (readV0, v')
1236+ result <- liftIO $ newIORef $ BuildDyn (readV0, v')
11841237 let !d = Dyn result
11851238 defer $ SomeDynInit d
11861239 return d
11871240
11881241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1189−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1190− where x = (readV0, v')
1242+unsafeBuildDynamic readV0 v' =
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
11911244
11921245-- ResultM can read behaviors and events
11931246type ResultM = EventM
11941247
1195−{-# NOINLINE unsafeNewIORef #-}
1196−unsafeNewIORef :: a -> b -> IORef b
1197−unsafeNewIORef a b = unsafePerformIO $ do
1198− touch a
1199− newIORef b
1200−
12011248instance HasSpiderTimeline x => Functor (Event x) where
12021249 fmap f = push $ return . Just . f
12031250
@@ -1210,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
12101257
12111258{-# INLINABLE pull #-}
12121259pull :: BehaviorM x a -> Behavior x a
1213−pull a = behaviorPull $ Pull
1214− { pullCompute = a
1215− , pullValue = unsafeNewIORef a Nothing
1260+pull a = unsafePerformIO $ do
1261+ ref <- newIORef Nothing
12161262#ifdef DEBUG_NODEIDS
1217− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
12181264#endif
1219− }
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1271+ }
12201272
12211273{-# INLINABLE switch #-}
12221274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1223−switch a = eventSwitch $ Switch
1224− { switchParent = a
1225− , switchSubscribed = unsafeNewIORef a Nothing
1226− }
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1277+ pure $ eventSwitch $ Switch
1278+ { switchParent = a
1279+ , switchSubscribed = ref
1280+ }
12271281
12281282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1229−coincidence a = eventCoincidence $ Coincidence
1230− { coincidenceParent = a
1231− , coincidenceSubscribed = unsafeNewIORef a Nothing
1232− }
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1285+ pure $ eventCoincidence $ Coincidence
1286+ { coincidenceParent = a
1287+ , coincidenceSubscribed = ref
1288+ }
12331289
12341290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
12351291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
12361292run roots after = do
12371293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1238− t <- SpiderHost ask
1239− 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
12401296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
12411297 occBefore <- liftIO $ do
12421298 occBefore <- readIORef occRef
@@ -1274,11 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
12741330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
12751331 EQ -> a
12761332
1277−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
12781334
1279−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
12801336
1281−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
12821338
12831339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
12841340
@@ -1290,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
12901346 x' <- evaluate x
12911347 mkWeakPtr x' $
12921348 if debugFinalize
1293− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
12941350 else Nothing
12951351
12961352type WeakList a = [Weak a]
12971353
1298−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
12991359#ifdef DEBUG
1300−withIncreasedDepth :: CanTrace x m => m a -> m a
1301−withIncreasedDepth a = do
1302− spiderTimeline <- askSpiderTimelineEnv
1303− 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
13041385 result <- a
1305− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
13061387 return result
1307−#else
1308−withIncreasedDepth :: m a -> m a
1309−withIncreasedDepth = id
1310−#endif
1311−
1312−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
13131388
13141389{-# INLINE tracePropagate #-}
13151390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1316−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
13171392
13181393{-# INLINE traceInvalidate #-}
13191394traceInvalidate :: String -> IO ()
1320−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1395+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
13211396
1322−{-# INLINE traceWhen #-}
1323−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1324−traceWhen p b message = traceMWhen p b $ return message
1397+{-# INLINE traceInvalidateHeight #-}
1398+traceInvalidateHeight :: String -> IO ()
1399+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
13251400
1326−{-# INLINE traceMWhen #-}
1327−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1328−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
13291408 message <- getMessage
1330−#ifdef DEBUG
1331− spiderTimeline <- askSpiderTimelineEnv
1332− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1409+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
1411+
13331412#else
1334− 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+
13351448#endif
1336− liftIO $ putStrLn $ replicate d ' ' <> message
13371449
13381450whoCreatedIORef :: IORef a -> IO [String]
13391451whoCreatedIORef (IORef a) = whoCreated $! a
13401452
1341−#ifdef DEBUG_CYCLES
13421453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
13431454groupByHead = \case
13441455 [] -> []
@@ -1349,20 +1460,54 @@ groupByHead = \case
13491460 | otherwise -> (x, xs :| []) : l
13501461
13511462listsToForest :: Eq a => [[a]] -> Forest a
1352−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+
13531495#endif
13541496
1497+
13551498{-# INLINE propagateSubscriberHold #-}
13561499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
13571500propagateSubscriberHold h a = do
1358− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
13591502 invalidators <- liftIO $ readIORef $ holdInvalidators h
13601503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
13611505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
13621506 case {-# SCC "apply" #-} apply a v of
13631507 Nothing -> return ()
13641508 Just v' -> do
1365− {-# 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)
13661511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
13671512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
13681513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1370,25 +1515,25 @@ propagateSubscriberHold h a = do
13701515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
13711516
13721517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1373−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
13741519
13751520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
13761521askInvalidator = do
1377− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
13781523 case m of
13791524 Nothing -> return Nothing
13801525 Just (!wi, _) -> return $ Just wi
13811526
13821527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
13831528askParentsRef = do
1384− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
13851530 case m of
13861531 Nothing -> return Nothing
13871532 Just (_, !p) -> return $ Just p
13881533
13891534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
13901535askBehaviorHoldInits = do
1391− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
13921537 return his
13931538
13941539{-# INLINE getDynHold #-}
@@ -1396,20 +1541,27 @@ getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
13961541getDynHold d = do
13971542 mh <- liftIO $ readIORef $ unDyn d
13981543 case mh of
1399− Right h -> return h
1400− Left (readV0, v') -> do
1544+ HoldDyn h -> return h
1545+ UnsafeDyn (readV0, v') -> do
14011546 holdInits <- getDeferralQueue
14021547 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
14031554 h <- hold v0 v'
1404− liftIO $ writeIORef (unDyn d) $ Right h
1555+ liftIO $ writeIORef (unDyn d) $ HoldDyn h
14051556 return h
14061557
1558+
14071559-- Always refers to 0
14081560{-# NOINLINE zeroRef #-}
14091561zeroRef :: IORef Height
14101562zeroRef = unsafePerformIO $ newIORef zeroHeight
14111563
1412−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)
14131565getRootSubscribed k r sub = do
14141566 mSubscribed <- readIORef $ rootSubscribed r
14151567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1423,9 +1575,14 @@ getRootSubscribed k r sub = do
14231575 let !cached = rootSubscribed r
14241576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
14251577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1426− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1578+
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
14271581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
14281582 writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
14291586 let !subscribed = RootSubscribed
14301587 { rootSubscribedKey = k
14311588 , rootSubscribedCachedSubscribed = cached
@@ -1434,7 +1591,7 @@ getRootSubscribed k r sub = do
14341591 , rootSubscribedUninit = uninit
14351592 , rootSubscribedWeakSelf = weakSelf
14361593#ifdef DEBUG_NODEIDS
1437− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
14381595#endif
14391596 }
14401597 -- If we die at the same moment that all our children die, they will
@@ -1470,6 +1627,9 @@ data FanInt x a = FanInt
14701627 { _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
14711628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
14721629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
14731633 }
14741634
14751635newFanInt :: IO (FanInt x a)
@@ -1477,38 +1637,39 @@ newFanInt = do
14771637 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
14781638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
14791639 occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
14801643 return $ FanInt
14811644 { _fanInt_subscribers = subscribers
14821645 , _fanInt_subscriptionRef = subscriptionRef
14831646 , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
14841650 }
14851651
1486−{-# NOINLINE unsafeNewFanInt #-}
1487−unsafeNewFanInt :: b -> FanInt x a
1488−unsafeNewFanInt b = unsafePerformIO $ do
1489− touch b
1490− newFanInt
1491−
14921652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1493−fanInt p =
1494− let self = unsafeNewFanInt p
1495− in EventSelectorInt $ \k -> Event $ \sub -> do
1653+fanInt p = unsafePerformIO $ do
1654+ self <- newFanInt
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
14961656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
14971657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1498− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
14991660 { subscriberPropagate = \m -> do
15001661 liftIO $ writeIORef (_fanInt_occRef self) m
15011662 scheduleIntClear $ _fanInt_occRef self
1502− FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> do --TODO: Do we need to know that no subscribers are being added as we traverse?
1503− 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 ->
15041665 subscriberPropagate s v
1505− , subscriberInvalidateHeight = \old -> do
1506− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1507− FastWeakBag.traverse b $ \s -> do
1666+ , subscriberInvalidateHeight = \old ->
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668+ FastWeakBag.traverse_ b $ \s ->
15081669 subscriberInvalidateHeight s old
1509− , subscriberRecalculateHeight = \new -> do
1510− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1511− FastWeakBag.traverse b $ \s -> do
1670+ , subscriberRecalculateHeight = \new ->
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672+ FastWeakBag.traverse_ b $ \s ->
15121673 subscriberRecalculateHeight s new
15131674 }
15141675 liftIO $ do
@@ -1522,13 +1683,28 @@ fanInt p =
15221683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
15231684 return b
15241685 Just b -> return b
1525− t <- liftIO $ FastWeakBag.insert sub b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
15261687 currentOcc <- readIORef (_fanInt_occRef self)
1527− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1528− 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+
15291705
15301706{-# INLINABLE getFanSubscribed #-}
1531−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))
15321708getFanSubscribed k f sub = do
15331709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
15341710 case mSubscribed of
@@ -1546,13 +1722,16 @@ getFanSubscribed k f sub = do
15461722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
15471723 occRef <- liftIO $ newIORef parentOcc
15481724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
15491728 let subscribed = FanSubscribed
15501729 { fanSubscribedCachedSubscribed = fanSubscribed f
15511730 , fanSubscribedOccurrence = occRef
15521731 , fanSubscribedParent = subscription
15531732 , fanSubscribedSubscribers = subscribersRef
15541733#ifdef DEBUG_NODEIDS
1555− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
15561735#endif
15571736 }
15581737 let !self = (k, subscribed)
@@ -1562,7 +1741,7 @@ getFanSubscribed k f sub = do
15621741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
15631742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
15641743
1565−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
15661745cleanupFanSubscribed (k, subscribed) = do
15671746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15681747 let reducedSubscribers = DMap.delete k subscribers
@@ -1574,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
15741753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
15751754
15761755{-# INLINE subscribeFanSubscribed #-}
1577−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
15781757subscribeFanSubscribed k subscribed sub = do
15791758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15801759 case DMap.lookup k subscribers of
@@ -1612,6 +1791,9 @@ getSwitchSubscribed s sub = do
16121791 when (isJust parentOcc) $ scheduleClear occRef
16131792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
16141793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
16151797 let !subscribed = SwitchSubscribed
16161798 { switchSubscribedCachedSubscribed = switchSubscribed s
16171799 , switchSubscribedOccurrence = occRef
@@ -1624,7 +1806,7 @@ getSwitchSubscribed s sub = do
16241806 , switchSubscribedCurrentParent = subscriptionRef
16251807 , switchSubscribedWeakSelf = weakSelf
16261808#ifdef DEBUG_NODEIDS
1627− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
16281810#endif
16291811 }
16301812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1669,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
16691851 scheduleClear innerSubdRef
16701852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
16711853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
16721857 let subscribed = CoincidenceSubscribed
16731858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
16741859 , coincidenceSubscribedOccurrence = occRef
@@ -1679,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
16791864 , coincidenceSubscribedInnerParent = innerSubdRef
16801865 , coincidenceSubscribedWeakSelf = weakSelf
16811866#ifdef DEBUG_NODEIDS
1682− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
16831868#endif
16841869 }
16851870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1696,57 +1881,72 @@ cleanupCoincidenceSubscribed subscribed = do
16961881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
16971882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
16981883
1699−{-# INLINE merge #-}
1700−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1701−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)
17021889
17031890{-# INLINE mergeWithMove #-}
1704−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1705−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)
17061895
17071896{-# INLINE [1] mergeCheap #-}
1708−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1709−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
17101903 where
1711− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
17121905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
17131906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
17141907 (mOldSubd, newPs) <- case me of
17151908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
17161909 Just e -> do
17171910 let s = subscriber $ return k
1718− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
17191912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
17201913 let newParent = MergeSubscribedParent subscription
17211914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17221915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
17231916 forM_ mOldSubd $ \oldSubd -> do
1724− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
17251920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17261921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
17271922 foldM f ([], oldParents) $ DMap.toList p
1728− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1923+
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
17291925 getInitialSubscribers initialParents subscriber = do
17301926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17311927 let s = subscriber $ return k
1732− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17331929 height <- liftIO $ getEventSubscribedHeight parentSubd
1734− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1930+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
17351931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17361932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17371933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17381934 )
1935+
17391936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
17401937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
17411938
17421939{-# INLINE [1] mergeCheapWithMove #-}
1743−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1744−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
17451945 where
1746− updateMe :: MergeUpdateFunc k x (PatchDMapWithMove k (Event x)) (MergeSubscribedParentWithMove x k)
1946+ updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
17471947 updateMe subscriber heightBagRef oldParents p = do
17481948 -- Prepare new parents for insertion
1749− 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)
17501950 subscribeParent k e = do
17511951 keyRef <- liftIO $ newIORef k
17521952 let s = subscriber $ liftIO $ readIORef keyRef
@@ -1755,73 +1955,82 @@ mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
17551955 newParentHeight <- getEventSubscribedHeight subd
17561956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17571957 return $ MergeSubscribedParentWithMove subscription keyRef
1758− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
17591959 -- Collect old parents for deletion and update the keys of moved parents
1760− 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
17611961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
17621962 Nothing -> do
1763− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
17641966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17651967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
17661968 Just toKey -> do
17671969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
17681970 return Nothing
1769− 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+
17701974 return (toDelete, applyAlways p' oldParents)
1771− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
17721976 getInitialSubscribers initialParents subscriber = do
17731977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17741978 keyRef <- liftIO $ newIORef k
17751979 let s = subscriber $ liftIO $ readIORef keyRef
1776− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17771981 height <- liftIO $ getEventSubscribedHeight parentSubd
1778− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1982+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
17791983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17801984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17811985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17821986 )
1987+
17831988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
17841989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
17851990
1786−type MergeUpdateFunc k x p s
1787− = (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))
17881993 -> IORef HeightBag
17891994 -> DMap k s
17901995 -> p
17911996 -> EventM x ([EventSubscription x], DMap k s)
17921997
1793−type MergeInitFunc k x s
1794− = DMap k (Event x)
1795− -> (forall a. EventM x (k a) -> Subscriber x a)
1796− -> 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)
17972004
17982005type MergeDestroyFunc k s
17992006 = DMap k s
18002007 -> IO ()
18012008
1802−data Merge x k s = Merge
2009+data Merge x k v s = Merge
18032010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
18042011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
18052012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1806− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
1807− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
18082015 }
18092016
1810−invalidateMergeHeight :: Merge x k s -> IO ()
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
18112018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
18122019
18132020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
18142021invalidateMergeHeight' heightRef sub = do
18152022 oldHeight <- readIORef heightRef
1816− 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
18172025 writeIORef heightRef $! invalidHeight
18182026 subscriberInvalidateHeight sub oldHeight
18192027
1820−
1821−revalidateMergeHeight :: Merge x k s -> IO ()
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
18222029revalidateMergeHeight m = do
18232030 currentHeight <- readIORef $ _merge_heightRef m
1824− 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
18252034 heights <- readIORef $ _merge_heightBagRef m
18262035 parents <- readIORef $ _merge_parentsRef m
18272036 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
@@ -1829,44 +2038,53 @@ revalidateMergeHeight m = do
18292038 LT -> return ()
18302039 EQ -> do
18312040 let height = succHeight $ heightBagMax heights
1832− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
18332042 writeIORef (_merge_heightRef m) $! height
18342043 subscriberRecalculateHeight (_merge_sub m) height
18352044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
18362045
1837−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
18382047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
18392048 vals <- liftIO $ readIORef $ _merge_accumRef m
1840− 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
18412052 --TODO: Assert that m is not empty
18422053 subscriberPropagate (_merge_sub m) vals
18432054
1844−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
1845−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
18462078 { subscriberPropagate = \a -> do
18472079 oldM <- liftIO $ readIORef $ _merge_accumRef m
18482080 k <- getKey
1849− 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
18502082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
18512083 liftIO $ writeIORef (_merge_accumRef m) $! newM
18522084 when (DMap.null oldM) $ do -- Only schedule the firing once
18532085 height <- liftIO $ readIORef $ _merge_heightRef m
1854− --TODO: assertions about height
1855− currentHeight <- getCurrentHeight
1856− when (height <= currentHeight) $ do
1857− if height /= invalidHeight
1858− then do
1859− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1860− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1861− else liftIO $ do
1862−#ifdef DEBUG_CYCLES
1863− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1864− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
1865− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1866−#else
1867− let cycleInfo = ""
1868−#endif
1869− error $ "Causality loop found" <> cycleInfo
2086+ checkCycle subscribed
2087+
18702088 scheduleMergeSelf m height
18712089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
18722090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1877,30 +2095,45 @@ mergeSubscriber m getKey = Subscriber
18772095 }
18782096
18792097--TODO: Be able to run as much of this as possible promptly
1880−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k s -> MergeUpdateFunc k x p s -> p -> SomeMergeUpdate x
1881−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)
18822100 where updateMe = do
18832101 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
1884− (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber m) (_merge_heightBagRef m) oldParents p
2102+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
18852103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
18862104 return subscriptionsToKill
18872105
1888−{-# INLINE mergeCheap' #-}
1889−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)
1890−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
18912110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
18922111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
18932112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
18942113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
18952114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1896− 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
18972130 { _merge_parentsRef = parentsRef
18982131 , _merge_heightBagRef = heightBagRef
18992132 , _merge_heightRef = heightRef
19002133 , _merge_sub = sub
19012134 , _merge_accumRef = accumRef
19022135 }
1903− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
19042137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
19052138 myHeight = if invalidHeight `elem` heights
19062139 then invalidHeight
@@ -1909,50 +2142,57 @@ mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
19092142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
19102143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
19112144 else (Nothing, dm)
1912− unless (DMap.null accum) $ do
1913− scheduleMergeSelf m myHeight
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
19142146 liftIO $ writeIORef accumRef $! accum
19152147 liftIO $ writeIORef heightRef $! myHeight
19162148 liftIO $ writeIORef heightBagRef $! myHeightBag
1917− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19182149 liftIO $ writeIORef parentsRef $! initialParentState
19192150 defer $ SomeMergeInit $ do
1920− let s = Subscriber
2151+ let changeSubscriber = Subscriber
19212152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1922− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1923− defer $ updateMerge m updateFunc a
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2154+ defer $ updateMerge subscribed m updateFunc a
19242155 , subscriberInvalidateHeight = \_ -> return ()
19252156 , subscriberRecalculateHeight = \_ -> return ()
19262157 }
1927− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
1928− 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
19292160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
19302161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
19312162 -- its subscription.
1932− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
19332164 let unsubscribeAll = destroy =<< readIORef parentsRef
1934− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1935− , occ
1936− )
19372165
1938−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)
19392170mergeInt = cacheEvent . mergeIntCheap
19402171
19412172{-# INLINABLE mergeIntCheap #-}
1942−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)
19432174mergeIntCheap d = Event $ \sub -> do
19442175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
19452176 accum <- liftIO $ FastMutableIntMap.newEmpty
19462177 heightRef <- liftIO $ newIORef zeroHeight
19472178 heightBagRef <- liftIO $ newIORef heightBagEmpty
19482179 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+ }
19492190 let scheduleSelf = do
19502191 height <- liftIO $ readIORef $ heightRef
19512192 scheduleMerge' height heightRef $ do
19522193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
19532194 subscriberPropagate sub vals
1954− invalidateMyHeight = do
1955− invalidateMergeHeight' heightRef sub
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
19562196 recalculateMyHeight = do
19572197 currentHeight <- readIORef heightRef
19582198 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?
@@ -1962,12 +2202,14 @@ mergeIntCheap d = Event $ \sub -> do
19622202 LT -> return ()
19632203 EQ -> do
19642204 let height = succHeight $ heightBagMax heights
1965− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
19662206 writeIORef heightRef $! height
19672207 subscriberRecalculateHeight sub height
19682208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
19692209 mySubscriber k = Subscriber
19702210 { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
19712213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
19722214 liftIO $ FastMutableIntMap.insert accum k a
19732215 when wasEmpty scheduleSelf
@@ -2001,7 +2243,6 @@ mergeIntCheap d = Event $ \sub -> do
20012243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
20022244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
20032245 return Nothing
2004− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
20052246 defer $ SomeMergeInit $ do
20062247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
20072248 where
@@ -2015,35 +2256,39 @@ mergeIntCheap d = Event $ \sub -> do
20152256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
20162257 liftIO $ for_ oldParents $ \oldParent -> do
20172258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
20182261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
20192262 return $ IntMap.elems oldParents
2020− let s = Subscriber
2263+ let changeSubscriber = Subscriber
20212264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
20222265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
20232266 defer $ updateMe a
20242267 , subscriberInvalidateHeight = \_ -> return ()
20252268 , subscriberRecalculateHeight = \_ -> return ()
20262269 }
2027− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
20282271 forM_ change $ \c -> defer $ updateMe c
20292272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
20302273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
20312274 -- its subscription.
2032− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
20332276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2034− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2035− , occ
2036− )
2277+
2278+
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
20372280
20382281newtype 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) }
20392283
2040−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2041−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
20422287 let f = Fan
20432288 { fanParent = e
2044− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
20452290 }
2046− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
20472292
20482293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
20492294runHoldInits holdInitRef dynInitRef mergeInitRef = do
@@ -2096,37 +2341,37 @@ clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeI
20962341
20972342-- | Run an event action outside of a frame
20982343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2099−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2100− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2344+runFrame a = SpiderHost $ do
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
21012346 let go = do
21022347 result <- a
21032348 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
21042349 return result
21052350 result <- runEventM go
21062351 toClear <- readIORef $ eventEnvClears env
2107− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
2352+ forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
21082353 toClearInt <- readIORef $ eventEnvIntClears env
2109− forM_ toClearInt $ \(SomeIntClear ref) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2354+ forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
21102355 toClearRoot <- readIORef $ eventEnvRootClears env
2111− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2356+ forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
21122357 toAssign <- readIORef $ eventEnvAssignments env
21132358 toReconnectRef <- newIORef []
21142359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
21152360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
21162361 writeIORef vRef v
2117− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
21182363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
21192364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
21202365 writeIORef (eventEnvMergeUpdates env) []
2121− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
21222367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2123− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
21242369 toReconnect <- readIORef toReconnectRef
21252370 clearEventEnv env
21262371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
21272372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
21282373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2129− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
21302375 finalize wi
21312376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
21322377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2137,10 +2382,10 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
21372382 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
21382383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
21392384 sub <- newSubscriberSwitch subscribed
2140− 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
21412386 {-
21422387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2143− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
21442389 EventRoot _ -> "EventRoot"
21452390 EventNever -> "EventNever"
21462391 _ -> "something else"
@@ -2155,7 +2400,7 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
21552400 myHeight <- readIORef $ switchSubscribedHeight subscribed
21562401 when (parentHeight /= myHeight) $ do
21572402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2158− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
21592404 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
21602405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
21612406 unsubscribe subscription
@@ -2196,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
21962441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
21972442 when (oldHeight /= invalidHeight) $ do
21982443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2199− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
22002445
22012446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
22022447updateSwitchHeight new subscribed = do
@@ -2204,7 +2449,7 @@ updateSwitchHeight new subscribed = do
22042449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
22052450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
22062451 writeIORef (switchSubscribedHeight subscribed) $! new
2207− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
22082453
22092454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
22102455recalculateCoincidenceHeight subscribed = do
@@ -2213,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
22132458 height <- calculateCoincidenceHeight subscribed
22142459 when (height /= invalidHeight) $ do
22152460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2216− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
22172462
22182463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
22192464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -2252,14 +2497,219 @@ invalidate toReconnectRef wis = do
22522497-- Reflex integration
22532498--------------------------------------------------------------------------------
22542499
2255−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2256−-- When we're specializing, we include this from Reflex.Class instead, because
2257−-- it needs access to these types; when we're not, we want them here, so our
2258−-- instance isn't an orphan instance.
2259−#include "SpiderTimeline.include.hs"
2260−#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'"
22612560#endif
22622561
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)
2584+#endif
2585+ SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
2586+ a *> b = R.unsafeBuildDynamic (R.sample $ R.current b) $ R.leftmost [R.updated b, R.tag (R.current b) $ R.updated a]
2587+ (<*) = flip (*>) -- There are no effects, so order doesn't matter
2588+
2589+holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
2590+holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2591+
2592+holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2593+holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2594+
2595+holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
2596+holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2597+
2598+buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPushM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2599+buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2600+
2601+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
2602+ {-# INLINABLE hold #-}
2603+ hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
2604+ {-# INLINABLE holdDyn #-}
2605+ holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
2606+ {-# INLINABLE holdIncremental #-}
2607+ holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
2608+ {-# INLINABLE buildDynamic #-}
2609+ buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2610+ {-# INLINABLE headE #-}
2611+ headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
2615+
2616+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2617+ sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2618+
2619+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
2620+ {-# INLINABLE hold #-}
2621+ hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2622+ {-# INLINABLE holdDyn #-}
2623+ holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2624+ {-# INLINABLE holdIncremental #-}
2625+ holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2626+ {-# INLINABLE buildDynamic #-}
2627+ buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2628+ {-# INLINABLE headE #-}
2629+ headE = R.slowHeadE
2630+-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
2633+
2634+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2635+ {-# INLINABLE sample #-}
2636+ sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2637+
2638+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2639+ {-# INLINABLE sample #-}
2640+ sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
2641+
2642+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2643+ {-# INLINABLE hold #-}
2644+ hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
2645+ {-# INLINABLE holdDyn #-}
2646+ holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
2647+ {-# INLINABLE holdIncremental #-}
2648+ holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
2649+ {-# INLINABLE buildDynamic #-}
2650+ buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2651+ {-# INLINABLE headE #-}
2652+ headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
2655+
2656+--------------------------------------------------------------------------------
2657+-- Deprecated items
2658+--------------------------------------------------------------------------------
2659+
2660+-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
2661+{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
2662+type SpiderEnv = SpiderTimeline
2663+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2664+ {-# INLINABLE subscribeEvent #-}
2665+ subscribeEvent e = SpiderHostFrame $ do
2666+ --TODO: Unsubscribe eventually (manually and/or with weak ref)
2667+ val <- liftIO $ newIORef Nothing
2668+ subscription <- subscribe (unSpiderEvent e) $ Subscriber
2669+ { subscriberPropagate = \a -> do
2670+ liftIO $ writeIORef val $ Just a
2671+ scheduleClear val
2672+ , subscriberInvalidateHeight = \_ -> return ()
2673+ , subscriberRecalculateHeight = \_ -> return ()
2674+ }
2675+ return $ SpiderEventHandle
2676+ { spiderEventHandleSubscription = subscription
2677+ , spiderEventHandleValue = val
2678+ }
2679+
2680+instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
2681+ type EventTrigger (SpiderTimeline x) = RootTrigger x
2682+ type EventHandle (SpiderTimeline x) = SpiderEventHandle x
2683+ type HostFrame (SpiderTimeline x) = SpiderHostFrame x
2684+
2685+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2686+ {-# NOINLINE readEvent #-}
2687+ readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
2688+ result <- readIORef $ spiderEventHandleValue h
2689+ touch h
2690+ return result
2691+
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2693+ newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2694+ newFanEventWithTrigger f = SpiderHost $ do
2695+ es <- newFanEventWithTriggerIO f
2696+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2697+
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2699+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2700+ newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2701+ es <- newFanEventWithTriggerIO f
2702+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2703+
2704+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
2705+ {-# INLINABLE subscribeEvent #-}
2706+ subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
2707+
2708+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
2709+ type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
2710+ fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
2711+ runHostFrame = runFrame . runSpiderHostFrame
2712+
22632713unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
22642714unsafeNewSpiderTimelineEnv = do
22652715 lock <- newMVar ()
@@ -2267,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
22672717#ifdef DEBUG
22682718 depthRef <- newIORef 0
22692719#endif
2270− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
22712721 { _spiderTimeline_lock = lock
22722722 , _spiderTimeline_eventEnv = env
22732723#ifdef DEBUG
@@ -2275,43 +2725,40 @@ unsafeNewSpiderTimelineEnv = do
22752725#endif
22762726 }
22772727
2278−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
22792728-- | Create a new SpiderTimelineEnv
22802729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2281−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
22822731
2283−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
22842733
22852734instance Reifies s (SpiderTimelineEnv x) =>
22862735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2287− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
22882737
22892738localSpiderTimeline
2290− :: Proxy s
2739+ :: proxy s
22912740 -> SpiderTimelineEnv x
22922741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2293−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
22942743
22952744-- | Pass a new timeline to the given function.
22962745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
22972746withSpiderTimeline k = do
22982747 env <- unsafeNewSpiderTimelineEnv
22992748 reify env $ \s -> k $ localSpiderTimeline s env
2300−#endif
23012749
2302−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)
23032751
23042752type ComputeM = EventM
23052753
2306−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)
23072755
2308−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
23092756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23102757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
23112758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
23122759 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2313− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
2314− 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 }
23152762 type PullM (SpiderTimeline x) = SpiderPullM x
23162763 type PushM (SpiderTimeline x) = SpiderPushM x
23172764 {-# INLINABLE never #-}
@@ -2324,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23242771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
23252772 {-# INLINABLE pull #-}
23262773 pull = SpiderBehavior . pull . coerce
2327− {-# INLINABLE merge #-}
2328− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
2329− {-# INLINABLE fan #-}
2330− 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
23312783 {-# INLINABLE switch #-}
23322784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
23332785 {-# INLINABLE coincidence #-}
@@ -2335,15 +2787,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23352787 {-# INLINABLE current #-}
23362788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
23372789 {-# INLINABLE updated #-}
2338− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
23392791 {-# INLINABLE unsafeBuildDynamic #-}
23402792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
23412793 {-# INLINABLE unsafeBuildIncremental #-}
23422794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2343− {-# INLINABLE mergeIncremental #-}
2344− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2345− {-# INLINABLE mergeIncrementalWithMove #-}
2346− 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
23472799 {-# INLINABLE currentIncremental #-}
23482800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
23492801 {-# INLINABLE updatedIncremental #-}
@@ -2354,12 +2806,12 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
23542806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
23552807 eventCoercion Coercion = Coercion
23562808 behaviorCoercion Coercion = Coercion
2357− 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
23582811 {-# INLINABLE mergeIntIncremental #-}
2359− mergeIntIncremental = SpiderEvent . mergeInt . (unsafeCoerce :: Dynamic x (PatchIntMap (R.Event (SpiderTimeline x) a)) -> Dynamic x (PatchIntMap (Event x a))) . unSpiderIncremental
2812+ mergeIntIncremental = SpiderEvent . mergeInt . coerce
23602813 {-# INLINABLE fanInt #-}
23612814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2362−#endif
23632815
23642816data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
23652817
@@ -2382,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
23822834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
23832835
23842836-- | The monad for actions that manipulate a Spider timeline identified by @x@
2385−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)
23862838
23872839instance Monad (SpiderHost x) where
23882840 {-# INLINABLE (>>=) #-}
@@ -2391,22 +2843,27 @@ instance Monad (SpiderHost x) where
23912843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
23922844 {-# INLINABLE return #-}
23932845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
23942847 {-# INLINABLE fail #-}
2395− 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
23962854
23972855-- | Run an action affecting the global Spider timeline; this will be guarded by
23982856-- a mutex for that timeline
23992857runSpiderHost :: SpiderHost Global a -> IO a
2400−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimelineEnv
2858+runSpiderHost (SpiderHost a) = a
24012859
2402−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
24032860-- | Run an action affecting a given Spider timeline; this will be guarded by a
24042861-- mutex for that timeline
24052862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2406−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2407−#endif
2863+runSpiderHostForTimeline (SpiderHost a) _ = a
24082864
2409−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)
24102867
24112868instance Monad (SpiderHostFrame x) where
24122869 {-# INLINABLE (>>=) #-}
@@ -2415,15 +2872,21 @@ instance Monad (SpiderHostFrame x) where
24152872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
24162873 {-# INLINABLE return #-}
24172874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
24182876 {-# INLINABLE fail #-}
24192877 fail s = SpiderHostFrame $ fail s
2878+#endif
24202879
2421−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2880+instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2881+ notReadyUntil _ = pure ()
2882+ notReady = pure ()
2883+
2884+newEventWithTriggerIO :: forall x a. HasSpiderTimeline x => (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
24222885newEventWithTriggerIO f = do
24232886 es <- newFanEventWithTriggerIO $ \Refl -> f
24242887 return $ select es Refl
24252888
2426−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)
24272890newFanEventWithTriggerIO f = do
24282891 occRef <- newIORef DMap.empty
24292892 subscribedRef <- newIORef DMap.empty
@@ -2457,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
24572920instance PrimMonad (SpiderHostFrame x) where
24582921 type PrimState (SpiderHostFrame x) = PrimState IO
24592922 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− _ >> y = y
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 <$ _ = pure x
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− _ *> b = b
87− a <* _ = a --TODO: The semantics of *>, <*, and <$ might not be quite right - they drop changes
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.hsnew file+384
@@ -0,0 +1,384 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveGeneric #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE FlexibleContexts #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE RecursiveDo #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
11+#ifdef USE_TEMPLATE_HASKELL
12+{-# LANGUAGE TemplateHaskell #-}
13+#endif
14+-- |
15+-- Module:
16+-- Reflex.Time
17+-- Description:
18+-- Clocks, timers, and other time-related functions.
19+module Reflex.Time where
20+
21+import Reflex.Class
22+import Reflex.Dynamic
23+import Reflex.PerformEvent.Class
24+import Reflex.PostBuild.Class
25+import Reflex.TriggerEvent.Class
26+
27+import Control.Concurrent
28+import qualified Control.Concurrent.Thread.Delay as Concurrent
29+import Control.Lens hiding ((|>))
30+import Control.Monad
31+import Control.Monad.Fix
32+import Control.Monad.IO.Class
33+import Data.Align
34+import Data.Data (Data)
35+import Data.Fixed
36+import Data.Semigroup (Semigroup(..))
37+import Data.Sequence (Seq, (|>))
38+import qualified Data.Sequence as Seq
39+import Data.These
40+import Data.Time.Clock
41+import Data.Typeable
42+import GHC.Generics (Generic)
43+import System.Random
44+
45+-- | Metadata associated with a timer "tick"
46+data TickInfo
47+ = TickInfo { _tickInfo_lastUTC :: UTCTime
48+ -- ^ UTC time immediately after the last tick.
49+ , _tickInfo_n :: Integer
50+ -- ^ Number of time periods or ticks since the start of the timer
51+ , _tickInfo_alreadyElapsed :: NominalDiffTime
52+ -- ^ Amount of time that has elapsed in the current tick period.
53+ }
54+ deriving (Eq, Ord, Show, Typeable)
55+
56+-- | Fires an 'Event' once every time provided interval elapses, approximately.
57+-- The provided 'UTCTime' is used bootstrap the determination of how much time has elapsed with each tick.
58+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread.
59+tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
60+tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
61+
62+-- | Fires an 'Event' once every time provided interval elapses, approximately.
63+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread and the time of the post-build as the tick basis time.
64+tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
65+tickLossyFromPostBuildTime dt = do
66+ postBuild <- getPostBuild
67+ postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
68+ tickLossyFrom' $ (dt,) <$> postBuildTime
69+
70+-- | Fires an 'Event' approximately each time the provided interval elapses. If the system starts running behind, occurrences will be dropped rather than buffered.
71+-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the provided initial time.
72+tickLossyFrom
73+ :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
74+ => NominalDiffTime
75+ -- ^ The length of a tick interval
76+ -> UTCTime
77+ -- ^ The basis time from which intervals count and with which the initial calculation of elapsed time will be made.
78+ -> Event t a
79+ -- ^ Event that starts a tick generation thread. Usually you want this to
80+ -- be something like the result of getPostBuild that only fires once. But
81+ -- there could be uses for starting multiple timer threads.
82+ -> m (Event t TickInfo)
83+tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
84+
85+-- | Generalization of tickLossyFrom that takes the delay and initial time as an 'Event'.
86+tickLossyFrom'
87+ :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
88+ => Event t (NominalDiffTime, UTCTime)
89+ -- ^ Event that starts a tick generation thread. Usually you want this to
90+ -- be something like the result of 'getPostBuild' that only fires once. But
91+ -- there could be uses for starting multiple timer threads.
92+ -> m (Event t TickInfo)
93+tickLossyFrom' e = do
94+ rec result <- performEventAsync $ callAtNextInterval <$> leftmost [e, snd <$> result]
95+ return $ fst <$> result
96+ where callAtNextInterval pair cb = void $ liftIO $ forkIO $ do
97+ tick <- uncurry getCurrentTick pair
98+ Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
99+ cb (tick, pair)
100+
101+-- | Like 'tickLossy', but immediately calculates the first tick and provides a 'Dynamic' that is updated as ticks fire.
102+clockLossy :: (MonadIO m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), PostBuild t m, MonadHold t m, MonadFix m) => NominalDiffTime -> UTCTime -> m (Dynamic t TickInfo)
103+clockLossy dt t0 = do
104+ initial <- liftIO $ getCurrentTick dt t0
105+ e <- tickLossy dt t0
106+ holdDyn initial e
107+
108+-- | Generates a 'TickInfo', given the specified interval and timestamp. The 'TickInfo' will include the
109+-- current time, the number of ticks that have elapsed since the timestamp, and the amount of time that
110+-- has elapsed since the start time of this tick.
111+getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
112+getCurrentTick dt t0 = do
113+ t <- getCurrentTime
114+ let offset = t `diffUTCTime` t0
115+ (n, alreadyElapsed) = offset `divMod'` dt
116+ return $ TickInfo t n alreadyElapsed
117+
118+-- | Delay an Event's occurrences by a given amount in seconds.
119+delay :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
120+delay dt e = performEventAsync $ ffor e $ \a cb -> liftIO $ void $ forkIO $ do
121+ Concurrent.delay $ ceiling $ dt * 1000000
122+ cb a
123+
124+-- | Send events with Poisson timing with the given basis and rate
125+-- Each occurrence of the resulting event will contain the index of
126+-- the current interval, with 0 representing the basis time
127+poissonLossyFrom
128+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
129+ => g
130+ -> Double
131+ -- ^ Poisson event rate (Hz)
132+ -> UTCTime
133+ -- ^ Baseline time for events
134+ -> Event t a
135+ -- ^ Event that starts a tick generation thread. Usually you want this to
136+ -- be something like the result of getPostBuild that only fires once. But
137+ -- there could be uses for starting multiple timer threads.
138+ -- Start sending events in response to the event parameter.
139+ -> m (Event t TickInfo)
140+poissonLossyFrom rnd rate = inhomogeneousPoissonFrom rnd (constant rate) rate
141+
142+
143+-- | Send events with Poisson timing with the given basis and rate
144+-- Each occurrence of the resulting event will contain the index of
145+-- the current interval, with 0 representing the basis time.
146+-- Automatically begin sending events when the DOM is built
147+poissonLossy
148+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, PostBuild t m)
149+ => g
150+ -> Double
151+ -- ^ Poisson event rate (Hz)
152+ -> UTCTime
153+ -- ^ Baseline time for events
154+ -> m (Event t TickInfo)
155+poissonLossy rnd rate t0 = poissonLossyFrom rnd rate t0 =<< getPostBuild
156+
157+-- | Send events with inhomogeneous Poisson timing with the given basis
158+-- and variable rate. Provide a maxRate that you expect to support.
159+inhomogeneousPoissonFrom
160+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
161+ => g
162+ -> Behavior t Double
163+ -> Double
164+ -> UTCTime
165+ -> Event t a
166+ -> m (Event t TickInfo)
167+inhomogeneousPoissonFrom rnd rate maxRate t0 e = do
168+
169+ -- Create a thread for producing homogeneous poisson events
170+ -- along with random Doubles (usage of Double's explained below)
171+ ticksWithRateRand <- performEventAsync $
172+ fmap callAtNextInterval e
173+
174+ -- Filter homogeneous events according to associated
175+ -- random values and the current rate parameter
176+ return $ attachWithMaybe filterFun rate ticksWithRateRand
177+
178+ where
179+
180+ -- Inhomogeneous poisson processes are built from faster
181+ -- homogeneous ones by randomly dropping events from the
182+ -- fast process. For each fast homogeneous event, choose
183+ -- a uniform random sample from (0, rMax). If the
184+ -- inhomogeneous rate at this moment is greater than the
185+ -- random sample, then keep this event, otherwise drop it
186+ filterFun :: Double -> (TickInfo, Double) -> Maybe TickInfo
187+ filterFun r (tInfo, p)
188+ | r >= p = Just tInfo
189+ | otherwise = Nothing
190+
191+ callAtNextInterval _ cb = void $ liftIO $ forkIO $ go t0 rnd cb 0
192+
193+ go tTargetLast lastGen cb lastN = do
194+ t <- getCurrentTime
195+
196+ -- Generate random numbers for this poisson interval (u)
197+ -- and sample-retention likelihood (p)
198+ let (u, nextGen) = randomR (0,1) lastGen
199+ (p :: Double, nextGen') = randomR (0,maxRate) nextGen
200+
201+ -- Inter-event interval is drawn from exponential
202+ -- distribution accourding to u
203+ let dt = realToFrac $ (-1) * log u / maxRate :: NominalDiffTime
204+ nEvents = lastN + 1
205+ alreadyElapsed = diffUTCTime t tTargetLast
206+ tTarget = addUTCTime dt tTargetLast
207+ thisDelay = realToFrac $ diffUTCTime tTarget t :: Double
208+ Concurrent.delay $ ceiling $ thisDelay * 1000000
209+ _ <- cb (TickInfo t nEvents alreadyElapsed, p)
210+ go tTarget nextGen' cb nEvents
211+
212+-- | Send events with inhomogeneous Poisson timing with the given basis
213+-- and variable rate. Provide a maxRate that you expect to support
214+inhomogeneousPoisson
215+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, PostBuild t m)
216+ => g
217+ -> Behavior t Double
218+ -> Double
219+ -> UTCTime
220+ -> m (Event t TickInfo)
221+inhomogeneousPoisson rnd rate maxRate t0 =
222+ inhomogeneousPoissonFrom rnd rate maxRate t0 =<< getPostBuild
223+
224+-- | Block occurrences of an Event until the given number of seconds elapses without
225+-- the Event firing, at which point the last occurrence of the Event will fire.
226+debounce :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
227+debounce dt e = do
228+ n :: Dynamic t Integer <- count e
229+ let tagged = attachPromptlyDynWith (,) n e
230+ delayed <- delay dt tagged
231+ return $ attachWithMaybe (\n' (t, v) -> if n' == t then Just v else Nothing) (current n) delayed
232+
233+-- | When the given 'Event' occurs, wait the given amount of time and collect
234+-- all occurrences during that time. Then, fire the output 'Event' with the
235+-- collected output.
236+batchOccurrences :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t (Seq a))
237+batchOccurrences t newValues = do
238+ let f s x = (Just newState, out)
239+ where newState = case x of
240+ This a -> s |> a
241+ That _ -> mempty
242+ These a _ -> Seq.singleton a
243+ out = case x of
244+ This _ -> if Seq.null s then Just () else Nothing
245+ That _ -> Nothing
246+ These _ _ -> Just ()
247+ rec (buffer, toDelay) <- mapAccumMaybe f mempty $ align newValues delayed
248+ delayed <- delay t toDelay
249+ return $ tag buffer delayed
250+
251+-- | Throttle an input event, ensuring that at least a given amount of time passes between occurrences of the output event. If the input event occurs too
252+-- frequently, the output event occurs with the most recently seen input value after the given delay passes since the last occurrence of the output.
253+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
254+throttle :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
255+throttle t e = do
256+ let f (immediate, buffer) x = case x of -- (Just newState, out)
257+ This a -- If only the input event fires
258+ | immediate -> -- and we're in immediate mode
259+ -- Immediate mode turns off, and the buffer is empty.
260+ -- We fire the output event with the input event value immediately.
261+ (Just (False, Nothing), Just a)
262+ | otherwise -> -- and we're not in immediate mode
263+ -- Immediate mode remains off, and we replace the contents of the buffer (if any) with the input value.
264+ -- We don't fire the output event.
265+ (Just (False, Just a), Nothing)
266+ That _ -> -- If only the delayed output event fires,
267+ case buffer of
268+ Nothing -> -- and the buffer is empty:
269+ -- Immediate mode turns back on, and the buffer remains empty.
270+ -- We don't fire.
271+ (Just (True, Nothing), Nothing)
272+ Just b -> -- and the buffer is full:
273+ -- Immediate mode remains off, and the buffer is cleared.
274+ -- We fire with the buffered value.
275+ (Just (False, Nothing), Just b)
276+ These a _ -> -- If both the input and delayed output event fire simultaneously:
277+ -- Immediate mode turns off, and the buffer is empty.
278+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
279+ (Just (False, Nothing), Just a)
280+ rec (_, outE) <- mapAccumMaybeDyn f (True, Nothing) $ align e delayed -- We start in immediate mode with an empty buffer.
281+ delayed <- delay t outE
282+ return outE
283+
284+data ThrottleState b
285+ = ThrottleState_Immediate
286+ | ThrottleState_Buffered (ThrottleBuffer b)
287+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
288+
289+data ThrottleBuffer b
290+ = ThrottleBuffer_Empty -- Empty conflicts with lens, and hiding it would require turning
291+ -- on PatternSynonyms
292+ | ThrottleBuffer_Full b
293+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
294+
295+instance Semigroup b => Semigroup (ThrottleBuffer b) where
296+ x <> y = case x of
297+ ThrottleBuffer_Empty -> y
298+ ThrottleBuffer_Full b1 -> case y of
299+ ThrottleBuffer_Empty -> x
300+ ThrottleBuffer_Full b2 -> ThrottleBuffer_Full $ b1 <> b2
301+ {-# INLINE (<>) #-}
302+
303+instance Semigroup b => Monoid (ThrottleBuffer b) where
304+ mempty = ThrottleBuffer_Empty
305+ {-# INLINE mempty #-}
306+ mappend = (<>)
307+ {-# INLINE mappend #-}
308+
309+-- | Throttle an input event, ensuring that the output event doesn't occur more often than you are ready for it. If the input event occurs too
310+-- frequently, the output event will contain semigroup-based summaries of the input firings that happened since the last output firing.
311+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
312+-- The first parameter is a function that receives access to the output event, and should construct an event that fires when the receiver is
313+-- ready for more input. For example, using @delay 20@ would give a simple time-based throttle.
314+--
315+-- NB: The provided lag function must *actually* delay the event.
316+throttleBatchWithLag :: (MonadFix m, MonadHold t m, PerformEvent t m, Semigroup a) => (Event t () -> m (Event t ())) -> Event t a -> m (Event t a)
317+-- Invariants:
318+-- * Immediate mode must turn off whenever output is produced.
319+-- * Output must be produced whenever immediate mode turns from on to off.
320+-- * Immediate mode can only go from off to on when the delayed event fires.
321+-- * Every input firing must go into either an immediate output firing or the
322+-- buffer, but not both.
323+-- * An existing full buffer must either stay in the buffer or go to output,
324+-- but not both.
325+throttleBatchWithLag lag e = do
326+ let f state x = case x of -- (Just $ newState, out)
327+ This a -> -- If only the input event fires
328+ case state of
329+ ThrottleState_Immediate -> -- and we're in immediate mode
330+ -- Immediate mode turns off, and the buffer is empty.
331+ -- We fire the output event with the input event value immediately.
332+ (Just $ ThrottleState_Buffered $ ThrottleBuffer_Empty, Just a)
333+ ThrottleState_Buffered b -> -- and we're not in immediate mode
334+ -- Immediate mode remains off, and we accumulate the input value.
335+ -- We don't fire the output event.
336+ (Just $ ThrottleState_Buffered $ b <> ThrottleBuffer_Full a, Nothing)
337+ That _ -> -- If only the delayed output event fires,
338+ case state of
339+ ThrottleState_Immediate -> -- and we're in immediate mode
340+ -- Nothing happens.
341+ (Nothing, Nothing)
342+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
343+ -- Immediate mode turns back on, and the buffer remains empty.
344+ -- We don't fire.
345+ (Just ThrottleState_Immediate, Nothing)
346+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
347+ -- Immediate mode remains off, and the buffer is cleared.
348+ -- We fire with the buffered value.
349+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just b)
350+ These a _ -> -- If both the input and delayed output event fire simultaneously:
351+ case state of
352+ ThrottleState_Immediate -> -- and we're in immediate mode
353+ -- Immediate mode turns off, and the buffer is empty.
354+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
355+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
356+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
357+ -- Immediate mode stays off, and the buffer remains empty.
358+ -- We fire with the input event's value.
359+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
360+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
361+ -- Immediate mode remains off, and the buffer is cleared.
362+ -- We fire with everything including the buffered value.
363+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just (b <> a))
364+ rec (_stateDyn, outE) <- mapAccumMaybeDyn f
365+ ThrottleState_Immediate -- We start in immediate mode with an empty buffer.
366+ (align e delayed)
367+ delayed <- lag (void outE)
368+ return outE
369+
370+#ifdef USE_TEMPLATE_HASKELL
371+makeLensesWith (lensRules & simpleLenses .~ True) ''TickInfo
372+#else
373+tickInfo_lastUTC :: Lens' TickInfo UTCTime
374+tickInfo_lastUTC f (TickInfo x1 x2 x3) = (\y -> TickInfo y x2 x3) <$> f x1
375+{-# INLINE tickInfo_lastUTC #-}
376+
377+tickInfo_n :: Lens' TickInfo Integer
378+tickInfo_n f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 y x3) <$> f x2
379+{-# INLINE tickInfo_n #-}
380+
381+tickInfo_alreadyElapsed :: Lens' TickInfo NominalDiffTime
382+tickInfo_alreadyElapsed f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 x2 y) <$> f x3
383+{-# INLINE tickInfo_alreadyElapsed #-}
384+#endif
src/Reflex/TriggerEvent/Base.hs+16−1
@@ -13,6 +13,7 @@ module Reflex.TriggerEvent.Base
1313 , EventTriggerRef (..)
1414 ) where
1515
16+import Control.Applicative (liftA2)
1617import Control.Concurrent
1718import Control.Monad.Exception
1819import Control.Monad.Primitive
@@ -21,7 +22,10 @@ import Control.Monad.Ref
2122import Data.Coerce
2223import Data.Dependent.Sum
2324import Data.IORef
25+import Data.Monoid ((<>))
26+import qualified Data.Semigroup as S
2427import Reflex.Class
28+import Reflex.Adjustable.Class
2529import Reflex.Host.Class
2630import Reflex.PerformEvent.Class
2731import Reflex.PostBuild.Class
@@ -118,8 +122,10 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
118122 buildDynamic a0 = lift . buildDynamic a0
119123 {-# INLINABLE headE #-}
120124 headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
121127
122−instance MonadAdjust t m => MonadAdjust t (TriggerEventT t m) where
128+instance Adjustable t m => Adjustable t (TriggerEventT t m) where
123129 {-# INLINABLE runWithReplace #-}
124130 runWithReplace (TriggerEventT a0) a' = TriggerEventT $ runWithReplace a0 (coerceEvent a')
125131 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
@@ -129,6 +135,15 @@ instance MonadAdjust t m => MonadAdjust t (TriggerEventT t m) where
129135 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
130136 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = TriggerEventT $ traverseDMapWithKeyWithAdjustWithMove (coerce . f) dm0 dm'
131137
138+-- TODO: Monoid and Semigroup can likely be derived once ReaderT has them.
139+instance (Monoid a, Applicative m) => Monoid (TriggerEventT t m a) where
140+ mempty = pure mempty
141+ mappend = (<>)
142+
143+instance (S.Semigroup a, Applicative m) => S.Semigroup (TriggerEventT t m a) where
144+ (<>) = liftA2 (S.<>)
145+
146+
132147-- | Retrieve the current 'Chan'; event trigger invocations pushed into it will
133148-- be fired.
134149askEvents :: Monad m => TriggerEventT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
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+4−2
@@ -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
@@ -30,7 +32,7 @@ import Reflex.Patch.MapWithMove
3032-- > (\k v -> text $ "\n" ++ show k ++ " " ++ v) -- show each element on a new line
3133-- > (Map.fromList $ zip [0..] [(3, "a"), (2, "b"), (1, "c")])
3234-- > sortEvent
33−sortableList :: forall t m k v a. (MonadHold t m, MonadFix m, MonadAdjust t m, Ord k)
35+sortableList :: forall t m k v a. (MonadHold t m, MonadFix m, Adjustable t m, Ord k)
3436 => (k -> v -> m a) -- ^ Function to render the content for each key/value pair
3537 -> Map k v -- ^ The sortable list with an initial ordering determined by the @Map@ keys in ascending order
3638 -> Event t (v -> v -> Ordering) -- ^ An event carrying a sort function for the list
src/Reflex/Workflow.hsnew file+50
@@ -0,0 +1,50 @@
1+{-# LANGUAGE RecursiveDo #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
3+-- |
4+-- Module:
5+-- Reflex.Workflow
6+-- Description:
7+-- Provides a convenient way to describe a series of interrelated widgets that
8+-- can send data to, invoke, and replace one another. Useful for modeling user interface
9+-- "workflows."
10+module Reflex.Workflow (
11+ Workflow (..)
12+ , workflow
13+ , workflowView
14+ , mapWorkflow
15+ , mapWorkflowCheap
16+ ) where
17+
18+import Control.Arrow ((***))
19+import Control.Monad.Fix (MonadFix)
20+
21+import Reflex.Class
22+import Reflex.Adjustable.Class
23+import Reflex.Network
24+import Reflex.NotReady.Class
25+import Reflex.PostBuild.Class
26+
27+-- | A widget in a workflow
28+-- When the 'Event' returned by a 'Workflow' fires, the current 'Workflow' is replaced by the one inside the firing 'Event'. A series of 'Workflow's must share the same return type.
29+newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
30+
31+-- | Runs a 'Workflow' and returns the 'Dynamic' result of the 'Workflow' (i.e., a 'Dynamic' of the value produced by the current 'Workflow' node, and whose update 'Event' fires whenever one 'Workflow' is replaced by another).
32+workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
33+workflow w0 = do
34+ rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
35+ return $ fmap fst eResult
36+
37+-- | Similar to 'workflow', but outputs an 'Event' that fires at post-build time and whenever the current 'Workflow' is replaced by the next 'Workflow'.
38+workflowView :: forall t m a. (Reflex t, NotReady t m, Adjustable t m, MonadFix m, MonadHold t m, PostBuild t m) => Workflow t m a -> m (Event t a)
39+workflowView w0 = do
40+ rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
41+ eReplace <- fmap switch $ hold never $ fmap snd eResult
42+ return $ fmap fst eResult
43+
44+-- | Map a function over a 'Workflow', possibly changing the return type.
45+mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
46+mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
47+
48+-- | Map a "cheap" function over a 'Workflow'. Refer to the documentation for 'pushCheap' for more information and performance considerations.
49+mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
50+mapWorkflowCheap f (Workflow x) = Workflow (fmap (f *** fmapCheap (mapWorkflowCheap f)) x)
stylizenew file+4
@@ -0,0 +1,4 @@
1+#!/usr/bin/env bash
2+set -euo pipefail
3+
4+for x in **/*.hs ; do stylish-haskell -i "$x" ; done
test/Adjustable.hsnew file+62
@@ -0,0 +1,62 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE RecursiveDo #-}
5+
6+module Main where
7+
8+import Control.Monad.Fix
9+import Data.Maybe
10+import qualified Data.Map as Map
11+
12+import Reflex
13+import Reflex.EventWriter.Base
14+import Reflex.Network
15+import Reflex.Patch.MapWithMove
16+import Test.Run
17+
18+main :: IO ()
19+main = do
20+ let actions = [ Increment, Update0th, Increment, Swap, Increment, Increment ]
21+ os <- runAppB testPatchMapWithMove $ map Just actions
22+ -- If the final counter value in the adjusted widgets corresponds to the number of times it has
23+ -- been incremented, we know that the networks haven't broken.
24+ let expectedCount = length $ ffilter (== Increment) actions
25+ -- let !True = last (last os) == [expectedCount,expectedCount] -- TODO re-enable this test after issue #369 has been resolved
26+ return ()
27+
28+data PatchMapTestAction
29+ = Increment
30+ | Swap
31+ | Update0th
32+ deriving Eq
33+
34+-- See https://github.com/reflex-frp/reflex/issues/369 for the bug that this is testing.
35+testPatchMapWithMove
36+ :: forall t m
37+ . ( Reflex t
38+ , Adjustable t m
39+ , MonadHold t m
40+ , MonadFix m
41+ )
42+ => Event t PatchMapTestAction
43+ -> m (Behavior t [Int])
44+testPatchMapWithMove pulse = do
45+ let pulseAction = ffor pulse $ \case
46+ Increment -> Nothing
47+ Swap -> patchMapWithMove $ Map.fromList
48+ [ (0, NodeInfo (From_Move 1) (Just 1))
49+ , (1, NodeInfo (From_Move 0) (Just 0))
50+ ]
51+ Update0th -> patchMapWithMove $ Map.fromList
52+ [ (0, NodeInfo (From_Insert 'z') Nothing) ]
53+ (_, result) <- runBehaviorWriterT $ mdo
54+ counter <- foldDyn (+) 1 $ fmapMaybe (\e -> if isNothing e then Just 1 else Nothing) pulseAction
55+ _ <- mapMapWithAdjustWithMove
56+ (\_ _ -> networkHold
57+ (tellBehavior $ constant [])
58+ ((\t -> tellBehavior $ constant [t]) <$> updated counter))
59+ (Map.fromList $ zip [0..] "ab")
60+ (fmapMaybe id pulseAction)
61+ return ()
62+ return result
test/DebugCycles.hsnew file+171
@@ -0,0 +1,171 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE PatternSynonyms #-}
8+{-# LANGUAGE RankNTypes #-}
9+
10+module Main where
11+
12+import Data.Foldable
13+import Control.Lens
14+import Control.Applicative
15+import Control.Monad
16+import Control.Monad.Fix
17+import Control.Exception
18+import System.Timeout
19+import Data.Maybe (isJust)
20+import Data.Functor.Misc
21+import qualified Data.Map as Map
22+import Data.Map (Map)
23+import qualified Data.IntMap as IntMap
24+import Data.IntMap (IntMap)
25+import Data.These
26+import Data.Align
27+import Reflex
28+import Reflex.EventWriter.Base
29+import Test.Run
30+import Test.Hspec
31+import Reflex.Spider.Internal (EventLoopException)
32+import Data.Witherable (Filterable)
33+
34+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
35+import Data.These.Lens
36+#endif
37+
38+type Widget t m = (MonadHold t m, Reflex t, MonadFix m)
39+
40+connectDyn :: Widget t m => Event t () -> (Dynamic t a, Dynamic t a) -> m (Dynamic t a)
41+connectDyn e (d, d') = do
42+ dd <- holdDyn d (d' <$ e)
43+ return $ join dd
44+
45+dynLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
46+dynLoop (e1, e2) = do
47+ -- "heightBagRemove: Height 2 not present in bag HeightBag {_heightBag_size = 2, _heightBag_contents = fromList [(0,1)]}"
48+ rec
49+ d <- count e1
50+ d' <- connectDyn e2 (d, liftA2 (+) d d')
51+ return $ updated d'
52+
53+connectOnCoincidence :: Widget t m => Event t () -> Event t a -> m (Event t a)
54+connectOnCoincidence click e = do
55+ d <- holdDyn never (e <$ click)
56+ return $ coincidence (updated d)
57+
58+coincidenceLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
59+coincidenceLoop (e1, e2) = do
60+-- "heightBagRemove: Height 1 not present in bag HeightBag {_heightBag_size = 1, _heightBag_contents = fromList [(0,0)]}"
61+-- (simpler version of dynLoop)
62+ rec
63+ e' <- connectOnCoincidence e2 (updated d)
64+ d <- count (align e' e1)
65+ return $ updated d
66+
67+addHeight :: Reflex t => Event t a -> Event t a
68+addHeight e = leftmost [e4, e4] where
69+ e1 = leftmost [e, e]
70+ e2 = leftmost [e1, e1]
71+ e3 = leftmost [e2, e2]
72+ e4 = leftmost [e3, e3]
73+
74+-- Take an existing test and build it inside a
75+buildLoop :: Widget t m => (forall t m. Widget t m => (Event t Int, Event t ()) -> m (Event t Int)) -> (Event t Int, Event t ()) -> m (Event t Int)
76+buildLoop test (e1, e2) = switchHold never buildLoop
77+ where buildLoop = pushAlways (const $ test (e1, e2)) e2
78+
79+connectButtonPromptly :: Widget t m => Event t () -> Event t a -> m (Event t a)
80+connectButtonPromptly click e = do
81+ d <- holdDyn never (e <$ click)
82+ return (switchDyn d)
83+
84+connectButton :: Widget t m => Event t () -> Event t a -> m (Event t a)
85+connectButton click e = do
86+ d <- hold never (e <$ click)
87+ return (switch d)
88+
89+switchLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
90+switchLoop01 (e1, e2) = do
91+ rec
92+ e' <- connectButton e2 (updated d)
93+ d <- count (align e' e1)
94+ return $ updated d
95+
96+mergeLoop :: forall t m. (Adjustable t m, Widget t m) => (Event t Int, Event t ()) -> m (Event t Int)
97+mergeLoop (e1, e2) = do
98+ rec
99+ (_, e) <- runEventWriterT $
100+ runWithReplace w (leftmost [w <$ e1])
101+ return (sum <$> e)
102+ where
103+ w = do
104+ c <- count e1
105+ tellEvent (updated ((pure <$> c) :: Dynamic t [Int]))
106+
107+switchLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
108+switchLoop02 (e1, e2) = do
109+ rec
110+ e' <- connectButton e2 (updated d)
111+ d <- count (leftmost [e', e1])
112+ return $ updated d
113+
114+switchLoop03 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
115+switchLoop03 (e1, e2) = do
116+ rec
117+ e' <- connectButton e2 (addHeight $ updated d)
118+ d <- count (align e' e1)
119+ return $ updated d
120+
121+staticLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
122+staticLoop01 (e1, e2) = do
123+ rec
124+ d <- foldDyn (+) (0 :: Int) (1 <$ align e1 (updated d))
125+ return $ updated d
126+
127+staticLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
128+staticLoop02 (e1, e2) = do
129+ rec
130+ d <- foldDyn (+) (0 :: Int) (leftmost [e1, updated d])
131+ return $ updated d
132+
133+buildStaticLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
134+buildStaticLoop (e1, e2) = switchHold never buildLoop
135+ where buildLoop = pushAlways (const $ staticLoop01 (e1, e2)) e2
136+
137+splitThese :: Filterable f => f (These a b) -> (f a, f b)
138+splitThese f = (mapMaybe (preview here) f, mapMaybe (preview there) f)
139+
140+main :: IO ()
141+main = hspec $ do
142+ describe "DebugCycles" $ do
143+ it "throws EventLoopException on switchLoop01" $ do
144+ check switchLoop01
145+ it "throws EventLoopException on switchLoop02" $ do
146+ check switchLoop02
147+ it "throws EventLoopException on switchLoop03" $ do
148+ check switchLoop03
149+ it "throws EventLoopException on buildSwitchLoop" $ do
150+ check $ buildLoop switchLoop01
151+ xit "throws EventLoopException on mergeLoop" $ do
152+ check mergeLoop
153+ xit "throws EventLoopException on staticLoop01" $ do
154+ check staticLoop01
155+ xit "throws EventLoopException on staticLoop02" $ do
156+ check staticLoop02
157+ xit "throws EventLoopException on buildStaticLoop" $ do
158+ check buildStaticLoop
159+ xit "throws EventLoopException on coincidenceLoop" $ do
160+ check coincidenceLoop
161+ xit "throws EventLoopException on dynLoop" $ do
162+ check dynLoop
163+ xit "throws EventLoopException on buildCoincidenceLoop" $ do
164+ check $ buildLoop coincidenceLoop
165+ where
166+ milliseconds = (*1000)
167+ occs = [ This 1, This 2, That (), This 3, That (), This 1 ]
168+ check test = do
169+ let action = timeout (milliseconds 50) $ do
170+ runApp' (test . splitThese) (Just <$> occs)
171+ action `shouldThrow` (const True :: Selector EventLoopException)
test/EventWriterT.hs+96−6
@@ -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
38−testSimultaneous :: (Reflex t, MonadAdjust t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
58+testSimultaneous :: (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+24−22
@@ -1,24 +1,30 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveFunctor #-}
23{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE TypeFamilies #-}
44{-# LANGUAGE GeneralizedNewtypeDeriving #-}
55{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE OverloadedStrings #-}
76{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
810
911import Control.Lens
1012import Control.Monad.Fix
1113import Data.Align
12−import Data.AppendMap (AppendMap)
1314import qualified Data.AppendMap as AMap
1415import Data.Functor.Misc
1516import Data.Map (Map)
1617import qualified Data.Map as Map
18+import Data.Map.Monoidal (MonoidalMap)
1719import Data.Semigroup
1820import Data.These
1921
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+
2026import Reflex
21−import Reflex.Patch.MapWithMove
27+import Data.Patch.MapWithMove
2228import Test.Run
2329
2430newtype MyQuery = MyQuery SelectedCount
@@ -28,14 +34,18 @@ instance Query MyQuery where
2834 type QueryResult MyQuery = ()
2935 crop _ _ = ()
3036
31−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
3238 type QueryResult (Selector k a) = Selector k (QueryResult a)
3339 crop q r = undefined
3440
35−newtype Selector k a = Selector { unSelector :: AppendMap k a }
41+newtype Selector k a = Selector { unSelector :: MonoidalMap k a }
3642 deriving (Show, Read, Eq, Ord, Functor)
3743
38−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
3949 (Selector a) <> (Selector b) = Selector $ fmapMaybe id $ f a b
4050 where
4151 f = alignWith $ \case
@@ -45,14 +55,14 @@ instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
4555 let z = x `mappend` y
4656 in if z == mempty then Nothing else Just z
4757
48−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
4959 mempty = Selector AMap.empty
5060 mappend = (<>)
5161
52−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
5363 negateG = fmap negateG
5464
55−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)
5666
5767main :: IO ()
5868main = do
@@ -82,7 +92,7 @@ testQueryT w (AppIn _ pulse) = do
8292 }
8393
8494testRunWithReplace :: ( Reflex t
85− , MonadAdjust t m
95+ , Adjustable t m
8696 , MonadHold t m
8797 , MonadFix m
8898 , MonadQuery t (Selector Int MyQuery) m)
@@ -97,7 +107,7 @@ testRunWithReplace replace increment = do
97107 return ()
98108
99109testSequenceDMapWithAdjust :: ( Reflex t
100− , MonadAdjust t m
110+ , Adjustable t m
101111 , MonadHold t m
102112 , MonadFix m
103113 , MonadQuery t (Selector Int MyQuery) m)
@@ -111,7 +121,7 @@ testSequenceDMapWithAdjust replace increment = do
111121 return ()
112122
113123testSequenceDMapWithAdjustWithMove :: ( Reflex t
114− , MonadAdjust t m
124+ , Adjustable t m
115125 , MonadHold t m
116126 , MonadFix m
117127 , MonadQuery t (Selector Int MyQuery) m)
@@ -124,16 +134,8 @@ testSequenceDMapWithAdjustWithMove replace increment = do
124134 queryDyn $ zipDynWith (\x y -> Selector (AMap.singleton (x :: Int) y)) n $ pure $ MyQuery $ SelectedCount 1
125135 return ()
126136
127−listHoldWithKey :: forall t m k v a. (Ord k, MonadHold t m, MonadAdjust t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
128−listHoldWithKey m0 m' f = do
129− let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
130− dm' = fmap (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey (\k v -> ComposeMaybe $ fmap (f k) v)) m'
131− (a0, a') <- sequenceDMapWithAdjust dm0 dm'
132− fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a'
133−
134−
135137-- scam it out to test traverseDMapWithAdjustWithMove
136−listHoldWithKeyWithMove :: forall t m k v a. (Ord k, MonadHold t m, MonadAdjust t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
138+listHoldWithKeyWithMove :: forall t m k v a. (Ord k, MonadHold t m, Adjustable t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
137139listHoldWithKeyWithMove m0 m' f = do
138140 (n0, n') <- mapMapWithAdjustWithMove f m0 $ ffor m' $ PatchMapWithMove . Map.map (\v -> NodeInfo (maybe From_Delete From_Insert v) Nothing)
139141 incrementalToDynamic <$> holdIncremental n0 n'
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+37−28
@@ -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))
@@ -155,35 +156,35 @@ testCases =
155156 let e' = leftmost [e, e]
156157 e'' <- switch <$> hold e' (fmap (const e) e)
157158 return (b, e'')
158− , (,) "switchPromptly-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
159+ , (,) "switchHoldPromptly-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
159160 let e' = fmap (const e) e
160− e'' <- switchPromptly never e'
161+ e'' <- switchHoldPromptly never e'
161162 return (b, e'')
162− , (,) "switchPromptly-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
163+ , (,) "switchHoldPromptly-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
163164 let e' = fmap (const e) e
164− e'' <- switchPromptly never $ leftmost [e', e']
165+ e'' <- switchHoldPromptly never $ leftmost [e', e']
165166 return (b, e'')
166− , (,) "switchPromptly-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
167+ , (,) "switchHoldPromptly-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
167168 let e' = leftmost [e, e]
168− e'' <- switchPromptly never (fmap (const e) e')
169+ e'' <- switchHoldPromptly never (fmap (const e) e')
169170 return (b, e'')
170− , (,) "switchPromptly-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
171+ , (,) "switchHoldPromptly-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
171172 let e' = leftmost [e, e]
172− e'' <- switchPromptly never (fmap (const e') e)
173+ e'' <- switchHoldPromptly never (fmap (const e') e)
173174 return (b, e'')
174175 , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175176 let e' = leftmost [e, e]
176177 e'' <- switch <$> hold never (fmap (const e') e)
177178 return (b, e'')
178− , (,) "switchPromptly-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
179+ , (,) "switchHoldPromptly-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
179180 let e' = flip push e $ \_ -> do
180181 Just <$> headE e
181− e'' <- switchPromptly never e'
182+ e'' <- switchHoldPromptly never e'
182183 return (b, e'')
183− , (,) "switchPromptly-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
184+ , (,) "switchHoldPromptly-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
184185 let e' = flip pushAlways e $ \_ -> do
185− switchPromptly e never
186− e'' <- switchPromptly never e'
186+ switchHoldPromptly e never
187+ e'' <- switchHoldPromptly never e'
187188 return (b, e'')
188189 , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
189190 let e' = flip pushAlways e $ \_ -> return e
@@ -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+84−17
@@ -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 =
@@ -128,36 +147,36 @@ testCases =
128147 return $ coincidence $ flip pushAlways e $ const $ do
129148 switch <$> hold ("x" <$ e) (e <$ e)
130149
131− , testE "switchPromptly-1" $ do
150+ , testE "switchHoldPromptly-1" $ do
132151 e <- events1
133152 let e' = e <$ e
134− switchPromptly never $ e <$ e'
153+ switchHoldPromptly never $ e <$ e'
135154
136− , testE "switchPromptly-2" $ do
155+ , testE "switchHoldPromptly-2" $ do
137156 e <- events1
138− switchPromptly never $ deep (e <$ e)
157+ switchHoldPromptly never $ deep (e <$ e)
139158
140− , testE "switchPromptly-3" $ do
159+ , testE "switchHoldPromptly-3" $ do
141160 e <- events1
142− switchPromptly never $ (e <$ deep e)
161+ switchHoldPromptly never $ (e <$ deep e)
143162
144− , testE "switchPromptly-4" $ do
163+ , testE "switchHoldPromptly-4" $ do
145164 e <- events1
146− switchPromptly never $ (deep e <$ e)
165+ switchHoldPromptly never $ (deep e <$ e)
147166
148167 , testE "switch-5" $ do
149168 e <- events1
150169 switch <$> hold never (deep e <$ e)
151170
152− , testE "switchPromptly-5" $ do
171+ , testE "switchHoldPromptly-5" $ do
153172 e <- events1
154− switchPromptly never $ flip push e $
173+ switchHoldPromptly never $ flip push e $
155174 const (Just <$> headE e)
156175
157− , testE "switchPromptly-6" $ do
176+ , testE "switchHoldPromptly-6" $ do
158177 e <- events1
159− switchPromptly never $ flip pushAlways e $
160− const (switchPromptly e never)
178+ switchHoldPromptly never $ flip pushAlways e $
179+ const (switchHoldPromptly e never)
161180
162181 , testE "coincidence-1" $ do
163182 e <- events1
@@ -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+186−16
@@ -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,22 +89,21 @@ 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
4796 , Requester t m
48− , MonadAdjust t m)
97+ , 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
57105 , Requester t m
58− , MonadAdjust t m)
106+ , Adjustable t m)
59107 => Event t (These () ())
60108 -> m ()
61109testSimultaneous pulse = do
@@ -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−