on develop help sign in
.github/workflows/haskell.ymlnew file+41
since splitsnapshots
unifiedsplit
@@ -0,0 +1,41 @@
1+name: github-action
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+ strategy:
8+ matrix:
9+ ghc: ['8.4.4', '8.6.5', '8.8.4', '8.10.2']
10+ os: ['ubuntu-latest', 'macos-latest']
11+ runs-on: ${{ matrix.os }}
12+
13+ name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
14+ steps:
15+ - uses: actions/checkout@v2
16+ - uses: actions/setup-haskell@v1
17+ with:
18+ ghc-version: ${{ matrix.ghc }}
19+ - name: Cache
20+ uses: actions/cache@v1
21+ env:
22+ cache-name: cache-cabal
23+ with:
24+ path: ~/.cabal
25+ key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
26+ restore-keys: |
27+ ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
28+ ${{ runner.os }}-${{ matrix.ghc }}-build-
29+ ${{ runner.os }}-${{ matrix.ghc }}-
30+ ${{ runner.os }}
31+
32+ - name: Install dependencies
33+ run: |
34+ cabal update
35+ cabal build --only-dependencies --enable-tests --enable-benchmarks
36+ - name: Build
37+ run: cabal build --enable-tests --enable-benchmarks all
38+ - name: Run tests
39+ run: cabal test all
40+ - name: Build Docs
41+ run: cabal haddock
.stylish-haskell.yaml+2−3
@@ -149,6 +149,5 @@ columns: 110
149# needs to be aware of these, so it can parse the file correctly.
149# needs to be aware of these, so it can parse the file correctly.
150#
150#
151# No language extensions are enabled by default.
151# No language extensions are enabled by default.
152−# language_extensions:
152+language_extensions:
153− # - TemplateHaskell
153+ - TemplateHaskell
154− # - QuasiQuotes
.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
13[S] -- Function runs in any monad supporting MonadSample
13[S] -- Function runs in any monad supporting MonadSample
14[H] -- Function runs in any monad supporting MonadHold
14[H] -- Function runs in any monad supporting MonadHold
15```
15```
16−
17Since MonadHold depends on MonadSample, any [S] function also runs in [H] context.
16Since MonadHold depends on MonadSample, any [S] function also runs in [H] context.
18
17
19## Functions producing Event
18## Functions producing Event
@@ -31,6 +30,7 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
31[ ] ffilter :: (a -> Bool) -> Event a -> Event a
30[ ] ffilter :: (a -> Bool) -> Event a -> Event a
32[ ] ffor :: Event a -> (a -> b) -> Event b
31[ ] ffor :: Event a -> (a -> b) -> Event b
33[ ] fforMaybe :: Event a -> (a -> Maybe b) -> Event b
32[ ] fforMaybe :: Event a -> (a -> Maybe b) -> Event b
33+[ ] <$ :: a -> Event b -> Event a
34
34
35-- Event to identical Event with debug trace. (Only prints if Event is ultimately used.)
35-- Event to identical Event with debug trace. (Only prints if Event is ultimately used.)
36[ ] traceEvent :: Show a => String -> Event a -> Event a
36[ ] 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
46[ ] attachPromptlyDynWith :: (a -> b -> c) -> Dynamic a -> Event b -> Event c
46[ ] attachPromptlyDynWith :: (a -> b -> c) -> Dynamic a -> Event b -> Event c
47[ ] attachWithMaybe :: (a -> b -> Maybe c) -> Behavior a -> Event b -> Event c
47[ ] attachWithMaybe :: (a -> b -> Maybe c) -> Behavior a -> Event b -> Event c
48[ ] attachPromptlyDynWithMaybe :: (a -> b -> Maybe c) -> Dynamic a -> Event b -> Event c
48[ ] 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
49
51
50-- Combine multiple Events
52-- Combine multiple Events
51[ ] <> :: Semigroup a => Event a -> Event a -> Event a
53[ ] <> :: Semigroup a => Event a -> Event a -> Event a
52[ ] difference :: Event a -> Event b -> Event a
54[ ] difference :: Event a -> Event b -> Event a
53[ ] align :: Event a -> Event b -> Event (These a b)
55[ ] align :: Event a -> Event b -> Event (These a b)
54[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
56[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
57+ -- Note align functions from Data.Align in semialign package
55[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
58[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
56[ ] leftmost :: [Event a] -> Event a
59[ ] leftmost :: [Event a] -> Event a
57[ ] mergeList :: [Event a] -> Event (NonEmpty a)
60[ ] 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)
59[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
62[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
60
63
61-- Efficient one-to-many fanout
64-- Efficient one-to-many fanout
62−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
65+[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
63−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
66+[ ] fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
64−[ ] select :: EventSelector k -> k a -> Event a
67+[ ] select :: EventSelector k -> k a -> Event a
65−[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
68+[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
66−[ ] fanThese :: Event (These a b) -> (Event a, Event b)
69+[ ] fanThese :: Event (These a b) -> (Event a, Event b)
67
70
68-- Event to Event via function that can sample current values
71-- Event to Event via function that can sample current values
69[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
72[ ] 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
96[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
99[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
97-- ... plus many more due to typeclass membership
100-- ... plus many more due to typeclass membership
98
101
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+
99-- Behavior to Behavior by sampling current values
106-- Behavior to Behavior by sampling current values
100[S] sample :: Behavior a -> m a
107[S] sample :: Behavior a -> m a
101[ ] pull :: m a -> Behavior a
108[ ] pull :: m a -> Behavior a
@@ -133,12 +140,17 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
133[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
140[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
134[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
141[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
135
142
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+
136-- Efficient one-to-many fanout
147-- Efficient one-to-many fanout
137[ ] demux :: Ord k => Dynamic k -> Demux k
148[ ] demux :: Ord k => Dynamic k -> Demux k
138[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
149[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
139
150
140-- Dynamic to Dynamic, removing updates w/o value change
151-- 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)
142
154
143-- Dynamic to identical Dynamic with debug trace. (Only prints if Dynamic is ultimately used.)
155-- Dynamic to identical Dynamic with debug trace. (Only prints if Dynamic is ultimately used.)
144[ ] traceDyn :: Show a => String -> Dynamic a -> Dynamic a
156[ ] 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
155-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
156[ ] switch :: Behavior (Event a) -> Event a
168[ ] switch :: Behavior (Event a) -> Event a
157
169
158−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
159−[ ] switchPromptlyDyn :: Dynamic (Event a) -> Event a
171+[ ] switchDyn :: Dynamic (Event a) -> Event a
160
172
161-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
162[ ] coincidence :: Event (Event a) -> Event a
174[ ] coincidence :: Event (Event a) -> Event a
@@ -179,5 +191,125 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
179
191
180-- Similar to above, for Events. Created Event initially tracks the first argument.
192-- Similar to above, for Events. Created Event initially tracks the first argument.
181-- At switchover, the output Event immediately tracks the new Event.
193-- 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)
183```
315```
README.md+15−11
@@ -1,19 +1,23 @@
1−## Reflex
1+# [Reflex](https://reflex-frp.org/)
2−### Practical Functional Reactive Programming
3
2
4−Reflex is an fully-deterministic, higher-order Functional Reactive Programming (FRP) interface and an engine that efficiently implements that interface.
3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/reflex.svg)](https://hackage.haskell.org/package/reflex) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/reflex/badge)](https://matrix.hackage.haskell.org/#/package/reflex) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/reflex/blob/master/LICENSE)
5
4
6−[Reflex-DOM](https://github.com/reflex-frp/reflex-dom) is a framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
5+Interactive programs without callbacks or side-effects. Functional Reactive Programming (FRP) uses composable events and time-varying values to describe interactive systems as pure functions. Just like other pure functional code, functional reactive code is easier to get right on the first try, maintain, and reuse.
7
6
8−Comprehensive documentation is still a work in progress, but a tutorial for Reflex and Reflex-DOM is available at https://github.com/reflex-frp/reflex-platform and an introductory talk given at the New York Haskell Meetup is available here: [Part 1](https://www.youtube.com/watch?v=mYvkcskJbc4) / [Part 2](https://www.youtube.com/watch?v=3qfc9XFVo2c).
7+Reflex is a fully-deterministic, higher-order Functional Reactive Programming interface and an engine that efficiently implements that interface.
9
8
10−A summary of Reflex functions is available in the [quick reference](Quickref.md).
9+**Visit https://reflex-frp.org for more information, tutorials, documentation and [examples](https://examples.reflex-frp.org/).**
11
10
12−### Additional resources
11+## Resources
13−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
14
12
13+* [Official Website](https://reflex-frp.org)
14+* [Quick Reference](Quickref.md)
15+* [Reflex-DOM](https://github.com/reflex-frp/reflex-dom): A framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
16+* [Obelisk](https://github.com/obsidiansystems/obelisk#obelisk): A framework built on Reflex and Reflex-DOM for functional reactive web and mobile applications, with batteries included.
17+* [Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
15−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
18+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
19+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
16
20
17−[hackage](https://hackage.haskell.org/package/reflex)
21+## Hacking
18
22
19−[irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
23+From the root of a [Reflex Platform](https://github.com/reflex-frp/reflex-platform) checkout, run `./scripts/hack-on haskell-overlays/reflex-packages/dep/reflex`. This will check out the reflex source code into the `haskell-overlays/reflex-packages/dep/reflex` directory. You can then point that checkout at your fork, make changes, etc. Use the `./try-reflex` or `./scripts/work-on` scripts to start a shell in which you can test your changes.
bench-cbits/checkCapability.c+11−12
@@ -42,7 +42,7 @@ typedef struct Task_ {
42 // or just continue immediately. It's a workaround for the fact
42 // or just continue immediately. It's a workaround for the fact
43 // that signalling a condition variable doesn't do anything if the
43 // that signalling a condition variable doesn't do anything if the
44 // thread is already running, but we want it to be sticky.
44 // thread is already running, but we want it to be sticky.
45− rtsBool wakeup;
45+ HsBool wakeup;
46#endif
46#endif
47
47
48 // This points to the Capability that the Task "belongs" to. If
48 // This points to the Capability that the Task "belongs" to. If
@@ -62,14 +62,14 @@ typedef struct Task_ {
62 // The current top-of-stack InCall
62 // The current top-of-stack InCall
63 struct InCall_ *incall;
63 struct InCall_ *incall;
64
64
65− nat n_spare_incalls;
65+ uint32_t n_spare_incalls;
66 struct InCall_ *spare_incalls;
66 struct InCall_ *spare_incalls;
67
67
68− rtsBool worker; // == rtsTrue if this is a worker Task
68+ HsBool worker; // == rtsTrue if this is a worker Task
69− rtsBool stopped; // this task has stopped or exited Haskell
69+ HsBool stopped; // this task has stopped or exited Haskell
70
70
71 // So that we can detect when a finalizer illegally calls back into Haskell
71 // So that we can detect when a finalizer illegally calls back into Haskell
72− rtsBool running_finalizers;
72+ HsBool running_finalizers;
73
73
74 // Links tasks on the returning_tasks queue of a Capability, and
74 // Links tasks on the returning_tasks queue of a Capability, and
75 // on spare_workers.
75 // on spare_workers.
@@ -88,7 +88,7 @@ struct Capability_ {
88 StgFunTable f;
88 StgFunTable f;
89 StgRegTable r;
89 StgRegTable r;
90
90
91− nat no; // capability number.
91+ uint32_t no; // capability number.
92
92
93 // The Task currently holding this Capability. This task has
93 // The Task currently holding this Capability. This task has
94 // exclusive access to the contents of this Capability (apart from
94 // exclusive access to the contents of this Capability (apart from
@@ -98,12 +98,12 @@ struct Capability_ {
98
98
99 // true if this Capability is running Haskell code, used for
99 // true if this Capability is running Haskell code, used for
100 // catching unsafe call-ins.
100 // catching unsafe call-ins.
101− rtsBool in_haskell;
101+ HsBool in_haskell;
102
102
103 // Has there been any activity on this Capability since the last GC?
103 // Has there been any activity on this Capability since the last GC?
104− nat idle;
104+ uint32_t idle;
105
105
106− rtsBool disabled;
106+ HsBool disabled;
107
107
108 // The run queue. The Task owning this Capability has exclusive
108 // The run queue. The Task owning this Capability has exclusive
109 // access to its run queue, so can wake up threads without
109 // access to its run queue, so can wake up threads without
@@ -159,7 +159,7 @@ struct Capability_ {
159#if defined(THREADED_RTS)
159#if defined(THREADED_RTS)
160 // Worker Tasks waiting in the wings. Singly-linked.
160 // Worker Tasks waiting in the wings. Singly-linked.
161 Task *spare_workers;
161 Task *spare_workers;
162− nat n_spare_workers; // count of above
162+ uint32_t n_spare_workers; // count of above
163
163
164 // This lock protects:
164 // This lock protects:
165 // running_task
165 // running_task
@@ -192,10 +192,9 @@ struct Capability_ {
192
192
193 // Per-capability STM-related data
193 // Per-capability STM-related data
194 StgTVarWatchQueue *free_tvar_watch_queues;
194 StgTVarWatchQueue *free_tvar_watch_queues;
195− StgInvariantCheckQueue *free_invariant_check_queues;
196 StgTRecChunk *free_trec_chunks;
195 StgTRecChunk *free_trec_chunks;
197 StgTRecHeader *free_trec_headers;
196 StgTRecHeader *free_trec_headers;
198− nat transaction_tokens;
197+ uint32_t transaction_tokens;
199} // typedef Capability is defined in RtsAPI.h
198} // typedef Capability is defined in RtsAPI.h
200 // We never want a Capability to overlap a cache line with anything
199 // We never want a Capability to overlap a cache line with anything
201 // else, so round it up to a cache line size:
200 // 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
20import Data.Dependent.Sum
20import Data.Dependent.Sum
21import Data.Functor.Misc
21import Data.Functor.Misc
22import Data.IORef
22import Data.IORef
23+import Data.Maybe (fromJust)
23import Reflex
24import Reflex
24import Reflex.Host.Class
25import Reflex.Host.Class
25
26
@@ -70,7 +71,7 @@ micros =
70 , withSetupWHNF "fireEventsOnly"
71 , withSetupWHNF "fireEventsOnly"
71 (newEventWithTriggerRef >>= subscribePair)
72 (newEventWithTriggerRef >>= subscribePair)
72 (\(_, trigger) -> do
73 (\(_, trigger) -> do
73− Just key <- liftIO $ readIORef trigger
74+ key <- fromJust <$> liftIO (readIORef trigger)
74 fireEvents [key :=> Identity (42 :: Int)])
75 fireEvents [key :=> Identity (42 :: Int)])
75 , withSetupWHNF "fireEventsAndRead(head/merge1)"
76 , withSetupWHNF "fireEventsAndRead(head/merge1)"
76 (setupMerge 1 >>= subscribePair)
77 (setupMerge 1 >>= subscribePair)
@@ -84,14 +85,14 @@ micros =
84 , withSetupWHNF "fireEventsOnly(head/merge100)"
85 , withSetupWHNF "fireEventsOnly(head/merge100)"
85 (setupMerge 100 >>= subscribePair)
86 (setupMerge 100 >>= subscribePair)
86 (\(_, t:_) -> do
87 (\(_, t:_) -> do
87− Just key <- liftIO $ readIORef t
88+ key <- fromJust <$> liftIO (readIORef t)
88 fireEvents [key :=> Identity (42 :: Int)])
89 fireEvents [key :=> Identity (42 :: Int)])
89 , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
90 , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
90 , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
91 , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
91 ]
92 ]
92
93
93setupMerge :: Int
94setupMerge :: Int
94− -> SpiderHost Global ( Event (SpiderEnv Global) (DMap (Const2 Int a) Identity)
95+ -> SpiderHost Global ( Event (SpiderTimeline Global) (DMap (Const2 Int a) Identity)
95 , [IORef (Maybe (EventTrigger Spider a))]
96 , [IORef (Maybe (EventTrigger Spider a))]
96 )
97 )
97setupMerge num = do
98setupMerge num = do
@@ -99,11 +100,11 @@ setupMerge num = do
99 let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100 let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100 pure (merge m, triggers)
101 pure (merge m, triggers)
101
102
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)
103subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104
105
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
106 -> SpiderHost Global (Maybe b)
107 -> SpiderHost Global (Maybe b)
107fireAndRead trigger val subd = do
108fireAndRead trigger val subd = do
108− Just key <- liftIO $ readIORef trigger
109+ key <- fromJust <$> liftIO (readIORef trigger)
109 fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
110 fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
bench/RunAll.hs+1−1
@@ -136,7 +136,7 @@ benchmarks = implGroup "spider" runSpiderHost cases
136pattern RunTestCaseFlag = "--run-test-case"
136pattern RunTestCaseFlag = "--run-test-case"
137
137
138spawnBenchmark :: String -> Benchmark
138spawnBenchmark :: String -> Benchmark
139−spawnBenchmark name = Benchmark name $ Benchmarkable $ \n -> do
139+spawnBenchmark name = bench name . toBenchmarkable $ \n -> do
140 self <- getExecutablePath
140 self <- getExecutablePath
141 callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
141 callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
142
142
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 @@
1Name: reflex
1Name: reflex
2−Version: 0.5.0
2+Version: 0.8.2.0
3Synopsis: Higher-order Functional Reactive Programming
3Synopsis: Higher-order Functional Reactive Programming
4+Description:
5+ Interactive programs without callbacks or side-effects.
6+ Functional Reactive Programming (FRP) uses composable events and time-varying
7+ values to describe interactive systems as pure functions.
8+ Just like other pure functional code, functional reactive code is easier
9+ to get right on the first try, maintain, and reuse.
10+ .
4−Description: Reflex is a high-performance, deterministic, higher-order Functional Reactive Programming system
11+ Reflex is a fully-deterministic, higher-order Functional Reactive Programming
12+ interface and an engine that efficiently implements that interface.
13+ .
14+ <https://reflex-frp.org>
5License: BSD3
15License: BSD3
6License-file: LICENSE
16License-file: LICENSE
7Author: Ryan Trinkle
17Author: Ryan Trinkle
@@ -9,14 +19,17 @@ Maintainer: ryan.trinkle@gmail.com
9Stability: Experimental
19Stability: Experimental
10Category: FRP
20Category: FRP
11Build-type: Simple
21Build-type: Simple
12−Cabal-version: >=1.9.2
22+Cabal-version: 1.22
13−homepage: https://github.com/reflex-frp/reflex
23+homepage: https://reflex-frp.org
14bug-reports: https://github.com/reflex-frp/reflex/issues
24bug-reports: https://github.com/reflex-frp/reflex/issues
25+extra-source-files:
26+ README.md
27+ Quickref.md
28+ ChangeLog.md
15
29
16−flag specialize-to-spidertimeline-global
30+tested-with:
17− description: Specialize all Reflex functions to the SpiderTimeline Global implementation. This may improve performance, but will disable all other implementations.
31+ GHC ==8.4.4 || ==8.6.5 || ==8.8.1 || ==8.10.2,
18− default: False
32+ GHCJS ==8.6
19− manual: True
20
33
21flag use-reflex-optimizer
34flag use-reflex-optimizer
22 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
35 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
@@ -28,124 +41,168 @@ flag use-template-haskell
28 default: True
41 default: True
29 manual: True
42 manual: True
30
43
31−flag expose-all-unfoldings
44+flag debug-trace-events
32− description: Build the library with -fexpose-all-unfoldings which can help client code specialize better
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!
33 default: False
46 default: False
34 manual: True
47 manual: True
35
48
36−flag debug-trace-events
49+flag fast-weak
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!
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
38 default: False
51 default: False
39 manual: True
52 manual: True
40
53
41−flag experimental-dependent-sum-instances
54+flag debug-propagation
42− description: Use experimental incoherent instances for certain forked dependent-sum typeclasses
55+ description: Enable debugging of spider internals
43 default: False
56 default: False
44 manual: True
57 manual: True
45
58
59+flag debug-cycles
60+ description: Enable debugging of event cycles
61+ default: False
62+ manual: True
63+
64+flag split-these
65+ description: Use split these/semialign packages
66+ manual: False
67+ default: True
68+
46library
69library
70+ default-language: Haskell2010
47 hs-source-dirs: src
71 hs-source-dirs: src
48 build-depends:
72 build-depends:
49 MemoTrie == 0.6.*,
73 MemoTrie == 0.6.*,
50− base >= 4.7 && < 4.11,
74+ base >= 4.11 && < 4.15,
51− bifunctors >= 5.2 && < 5.5,
75+ bifunctors >= 5.2 && < 5.6,
52− comonad,
76+ comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
78+ constraints-extras >= 0.3 && < 0.4,
53− containers == 0.5.*,
79+ containers >= 0.6 && < 0.7,
54 data-default >= 0.5 && < 0.8,
80 data-default >= 0.5 && < 0.8,
55− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
56 exception-transformers == 0.4.*,
82 exception-transformers == 0.4.*,
57 lens >= 4.7 && < 5,
83 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
58 monad-control >= 1.0.1 && < 1.1,
85 monad-control >= 1.0.1 && < 1.1,
59 mtl >= 2.1 && < 2.3,
86 mtl >= 2.1 && < 2.3,
87+ patch >= 0.0.1 && < 0.1,
60− prim-uniq >= 0.1.0.1 && < 0.2,
88+ prim-uniq >= 0.1.0.1 && < 0.3,
61− primitive >= 0.5 && < 0.7,
89+ primitive >= 0.5 && < 0.8,
90+ profunctors >= 5.3 && < 5.7,
91+ random == 1.1.*,
62 ref-tf == 0.4.*,
92 ref-tf == 0.4.*,
63 reflection == 2.1.*,
93 reflection == 2.1.*,
64 semigroupoids >= 4.0 && < 6,
94 semigroupoids >= 4.0 && < 6,
65− semigroups >= 0.16 && < 0.19,
95+ stm >= 2.4 && < 2.6,
66− stm == 2.4.*,
67 syb >= 0.5 && < 0.8,
96 syb >= 0.5 && < 0.8,
68− these >= 0.4 && < 0.8,
97+ time >= 1.4 && < 1.10,
69− transformers >= 0.2,
98+ transformers >= 0.5.6.0 && < 0.6,
70− transformers-compat >= 0.3
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
71
109
72 exposed-modules:
110 exposed-modules:
111+ Control.Monad.ReaderIO
73 Data.AppendMap,
112 Data.AppendMap,
74− Data.Functor.Misc,
75− Data.WeakBag,
76− Data.FastWeakBag,
77 Data.FastMutableIntMap,
113 Data.FastMutableIntMap,
114+ Data.FastWeakBag,
115+ Data.Map.Misc,
116+ Data.WeakBag,
78 Reflex,
117 Reflex,
79 Reflex.Class,
118 Reflex.Class,
80− Reflex.EventWriter,
119+ Reflex.Adjustable.Class,
120+ Reflex.BehaviorWriter.Base,
121+ Reflex.BehaviorWriter.Class,
122+ Reflex.Collection,
81 Reflex.Dynamic,
123 Reflex.Dynamic,
82 Reflex.Dynamic.Uniq,
124 Reflex.Dynamic.Uniq,
83 Reflex.DynamicWriter,
125 Reflex.DynamicWriter,
126+ Reflex.DynamicWriter.Base,
127+ Reflex.DynamicWriter.Class,
128+ Reflex.EventWriter,
129+ Reflex.EventWriter.Base,
130+ Reflex.EventWriter.Class,
84 Reflex.FastWeak,
131 Reflex.FastWeak,
85 Reflex.FunctorMaybe,
132 Reflex.FunctorMaybe,
86 Reflex.Host.Class,
133 Reflex.Host.Class,
87− Reflex.Patch,
134+ Reflex.Host.Headless,
88− Reflex.Patch.Class,
89− Reflex.Patch.DMap,
135+ Reflex.Network,
90− Reflex.Patch.DMapWithMove,
136+ Reflex.NotReady.Class,
91− Reflex.Patch.Map,
92− Reflex.Patch.MapWithMove,
93− Reflex.TriggerEvent.Base,
94− Reflex.TriggerEvent.Class,
95 Reflex.PerformEvent.Base,
137 Reflex.PerformEvent.Base,
96 Reflex.PerformEvent.Class,
138 Reflex.PerformEvent.Class,
97 Reflex.PostBuild.Base,
139 Reflex.PostBuild.Base,
98 Reflex.PostBuild.Class,
140 Reflex.PostBuild.Class,
99 Reflex.Profiled,
141 Reflex.Profiled,
142+ Reflex.Pure,
100 Reflex.Query.Base,
143 Reflex.Query.Base,
101 Reflex.Query.Class,
144 Reflex.Query.Class,
102 Reflex.Requester.Base,
145 Reflex.Requester.Base,
103 Reflex.Requester.Class,
146 Reflex.Requester.Class,
104 Reflex.Spider,
147 Reflex.Spider,
105 Reflex.Spider.Internal,
148 Reflex.Spider.Internal,
149+ Reflex.Time,
150+ Reflex.TriggerEvent.Base,
151+ Reflex.TriggerEvent.Class,
106− Reflex.Widget.Basic
152+ Reflex.Widget.Basic,
153+ Reflex.Workflow
107
154
108− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively -ddump-simpl -ddump-to-file -dsuppress-coercions -dsuppress-idinfo
155+ reexported-modules:
109− ghc-prof-options: -fprof-auto
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
110
164
111− if flag(specialize-to-spidertimeline-global)
165+ ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
112− cpp-options: -DSPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
113− else
114− exposed-modules: Reflex.Pure
115
166
116 if flag(debug-trace-events)
167 if flag(debug-trace-events)
117 cpp-options: -DDEBUG_TRACE_EVENTS
168 cpp-options: -DDEBUG_TRACE_EVENTS
118− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
119
171
120 if flag(use-reflex-optimizer)
172 if flag(use-reflex-optimizer)
121 cpp-options: -DUSE_REFLEX_OPTIMIZER
173 cpp-options: -DUSE_REFLEX_OPTIMIZER
122 build-depends: ghc
174 build-depends: ghc
123 exposed-modules: Reflex.Optimizer
175 exposed-modules: Reflex.Optimizer
124
176
177+ if flag(debug-propagation)
178+ cpp-options: -DDEBUG -DDEBUG_TRACE_PROPAGATION -DDEBUG_TRACE_INVALIDATION
179+
180+ if flag(debug-cycles)
181+ cpp-options: -DDEBUG_CYCLES
182+
125 if flag(use-template-haskell)
183 if flag(use-template-haskell)
126 cpp-options: -DUSE_TEMPLATE_HASKELL
184 cpp-options: -DUSE_TEMPLATE_HASKELL
127 build-depends:
185 build-depends:
128− dependent-sum >= 0.3 && < 0.5,
186+ dependent-sum >= 0.6 && < 0.8,
129− haskell-src-exts >= 1.16 && < 1.19,
187+ haskell-src-exts >= 1.16 && < 1.24,
130 haskell-src-meta >= 0.6 && < 0.9,
188 haskell-src-meta >= 0.6 && < 0.9,
131− template-haskell >= 2.9 && < 2.13
189+ template-haskell >= 2.9 && < 2.17
132 exposed-modules:
190 exposed-modules:
133 Reflex.Dynamic.TH
191 Reflex.Dynamic.TH
134 other-extensions: TemplateHaskell
192 other-extensions: TemplateHaskell
135 else
193 else
136 build-depends:
194 build-depends:
137− dependent-sum == 0.4.*
195+ dependent-sum >= 0.6 && < 0.8
138−
139− if flag(expose-all-unfoldings)
140− ghc-options: -fexpose-all-unfoldings
141
196
142− if flag(experimental-dependent-sum-instances)
197+ if flag(fast-weak) && impl(ghcjs)
143− ghc-options: -DEXPERIMENTAL_DEPENDENT_SUM_INSTANCES
198+ cpp-options: -DGHCJS_FAST_WEAK
144
199
145 if impl(ghcjs)
200 if impl(ghcjs)
146− build-depends: ghcjs-base
201+ build-depends:
202+ ghcjs-base == 0.2.*
147
203
148test-suite semantics
204test-suite semantics
205+ default-language: Haskell2010
149 type: exitcode-stdio-1.0
206 type: exitcode-stdio-1.0
150 main-is: semantics.hs
207 main-is: semantics.hs
151 hs-source-dirs: test
208 hs-source-dirs: test
@@ -154,33 +211,46 @@ test-suite semantics
154 base,
211 base,
155 bifunctors,
212 bifunctors,
156 containers,
213 containers,
157− deepseq >= 1.3 && < 1.5,
214+ deepseq,
158 dependent-map,
215 dependent-map,
159 dependent-sum,
216 dependent-sum,
160 mtl,
217 mtl,
161 ref-tf,
218 ref-tf,
162 reflex,
219 reflex,
163 split,
220 split,
164− transformers >= 0.3
221+ transformers
165− if flag(specialize-to-spidertimeline-global)
222+ other-modules:
166− buildable: False
223+ Reflex.Bench.Focused
224+ Reflex.Plan.Pure
225+ Reflex.Plan.Reflex
226+ Reflex.Test
227+ Reflex.Test.Micro
228+ Reflex.TestPlan
167
229
168test-suite CrossImpl
230test-suite CrossImpl
231+ default-language: Haskell2010
169 type: exitcode-stdio-1.0
232 type: exitcode-stdio-1.0
170 main-is: Reflex/Test/CrossImpl.hs
233 main-is: Reflex/Test/CrossImpl.hs
171 hs-source-dirs: test
234 hs-source-dirs: test
172− ghc-options: -O2 -Wall -rtsopts -main-is Reflex.Test.CrossImpl.test
235+ ghc-options: -O2 -Wall -rtsopts
173 build-depends:
236 build-depends:
174 base,
237 base,
175 containers,
238 containers,
176 dependent-map,
239 dependent-map,
240+ dependent-sum,
241+ deepseq,
177 mtl,
242 mtl,
243+ transformers,
178 ref-tf,
244 ref-tf,
179 reflex
245 reflex
180− if flag(specialize-to-spidertimeline-global)
246+ other-modules:
181− buildable: False
247+ Reflex.Test
248+ Reflex.TestPlan
249+ Reflex.Plan.Reflex
250+ Reflex.Plan.Pure
182
251
183test-suite hlint
252test-suite hlint
253+ default-language: Haskell2010
184 type: exitcode-stdio-1.0
254 type: exitcode-stdio-1.0
185 main-is: hlint.hs
255 main-is: hlint.hs
186 hs-source-dirs: test
256 hs-source-dirs: test
@@ -188,103 +258,226 @@ test-suite hlint
188 , directory
258 , directory
189 , filepath
259 , filepath
190 , filemanip
260 , 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
192 if impl(ghcjs)
265 if impl(ghcjs)
193 buildable: False
266 buildable: False
194− buildable: False
195
267
196test-suite EventWriterT
268test-suite EventWriterT
269+ default-language: Haskell2010
197 type: exitcode-stdio-1.0
270 type: exitcode-stdio-1.0
198 main-is: EventWriterT.hs
271 main-is: EventWriterT.hs
199 hs-source-dirs: test
272 hs-source-dirs: test
200 build-depends: base
273 build-depends: base
274+ , containers
275+ , deepseq
276+ , dependent-map
201 , dependent-sum
277 , dependent-sum
202 , lens
278 , lens
279+ , mtl
203 , these
280 , these
204 , transformers
281 , transformers
205 , reflex
282 , reflex
206 , ref-tf
283 , ref-tf
207
284
285+ if flag(split-these)
286+ build-depends: these-lens
287+
288+ other-modules:
289+ Test.Run
290+
291+
292+test-suite DebugCycles
293+ default-language: Haskell2010
294+ type: exitcode-stdio-1.0
295+ main-is: DebugCycles.hs
296+ hs-source-dirs: test
297+ ghc-options: -threaded
298+ build-depends: base
299+ , containers
300+ , deepseq
301+ , dependent-map
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+
208test-suite RequesterT
321test-suite RequesterT
322+ default-language: Haskell2010
209 type: exitcode-stdio-1.0
323 type: exitcode-stdio-1.0
210 main-is: RequesterT.hs
324 main-is: RequesterT.hs
211 hs-source-dirs: test
325 hs-source-dirs: test
212 build-depends: base
326 build-depends: base
213− , dependent-sum
327+ , constraints
328+ , constraints-extras
329+ , containers
330+ , deepseq
214 , dependent-map
331 , dependent-map
332+ , dependent-sum
215 , lens
333 , lens
334+ , mtl
335+ , ref-tf
336+ , reflex
337+ , text
216 , these
338 , these
217 , transformers
339 , 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
218 , reflex
365 , reflex
219 , ref-tf
366 , ref-tf
220− buildable: False
367+ , these
368+
369+ other-modules:
370+ Test.Run
221
371
222test-suite QueryT
372test-suite QueryT
373+ default-language: Haskell2010
223 type: exitcode-stdio-1.0
374 type: exitcode-stdio-1.0
224 main-is: QueryT.hs
375 main-is: QueryT.hs
225 hs-source-dirs: test
376 hs-source-dirs: test
226 build-depends: base
377 build-depends: base
227 , containers
378 , containers
228− , dependent-sum
229 , dependent-map
379 , dependent-map
380+ , dependent-sum
381+ , deepseq
230 , lens
382 , lens
383+ , monoidal-containers
384+ , mtl
385+ , patch
386+ , ref-tf
387+ , reflex
231 , these
388 , these
232 , transformers
389 , transformers
233− , reflex
390+
234− , ref-tf
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
235
399
236test-suite GC-Semantics
400test-suite GC-Semantics
401+ default-language: Haskell2010
237 type: exitcode-stdio-1.0
402 type: exitcode-stdio-1.0
238 main-is: GC.hs
403 main-is: GC.hs
239 hs-source-dirs: test
404 hs-source-dirs: test
240− if flag(specialize-to-spidertimeline-global)
241− buildable: False
242 build-depends: base
405 build-depends: base
406+ , containers
243 , dependent-sum
407 , dependent-sum
244 , dependent-map
408 , dependent-map
409+ , deepseq
410+ , mtl
411+ , patch
245 , these
412 , these
246 , transformers
413 , transformers
247 , reflex
414 , reflex
248 , ref-tf
415 , ref-tf
249− if impl(ghc < 8)
416+
417+ if flag(split-these)
250− build-depends: semigroups
418+ build-depends: semialign
419+
420+ other-modules:
421+ Reflex.Plan.Pure
422+ Reflex.Plan.Reflex
423+ Reflex.TestPlan
424+ Test.Run
251
425
252test-suite rootCleanup
426test-suite rootCleanup
427+ default-language: Haskell2010
253 type: exitcode-stdio-1.0
428 type: exitcode-stdio-1.0
254 main-is: rootCleanup.hs
429 main-is: rootCleanup.hs
255 hs-source-dirs: test
430 hs-source-dirs: test
256 build-depends: base
431 build-depends: base
432+ , containers
433+ , deepseq
434+ , dependent-sum
435+ , mtl
257 , reflex
436 , reflex
437+ , ref-tf
438+ , these
439+ other-modules:
440+ Reflex.Plan.Pure
441+ Reflex.TestPlan
442+ Test.Run
258
443
259benchmark spider-bench
444benchmark spider-bench
445+ default-language: Haskell2010
260 type: exitcode-stdio-1.0
446 type: exitcode-stdio-1.0
261− hs-source-dirs: bench
447+ hs-source-dirs: bench test
262 main-is: Main.hs
448 main-is: Main.hs
263 ghc-options: -Wall -O2 -rtsopts
449 ghc-options: -Wall -O2 -rtsopts
264 build-depends:
450 build-depends:
265 base,
451 base,
452+ containers,
266− criterion == 1.1.*,
453+ criterion,
267− deepseq >= 1.3 && < 1.5,
454+ deepseq,
268 dependent-map,
455 dependent-map,
269 dependent-sum,
456 dependent-sum,
457+ ref-tf,
270 mtl,
458 mtl,
271 primitive,
459 primitive,
272 reflex,
460 reflex,
461+ split,
273 stm,
462 stm,
274− transformers >= 0.3
463+ transformers
464+ other-modules:
465+ Reflex.TestPlan
466+ Reflex.Plan.Reflex
467+ Reflex.Bench.Focused
275
468
276benchmark saulzar-bench
469benchmark saulzar-bench
470+ default-language: Haskell2010
277 type: exitcode-stdio-1.0
471 type: exitcode-stdio-1.0
278 hs-source-dirs: bench test
472 hs-source-dirs: bench test
279 c-sources: bench-cbits/checkCapability.c
473 c-sources: bench-cbits/checkCapability.c
280 main-is: RunAll.hs
474 main-is: RunAll.hs
281 ghc-options: -Wall -O2 -rtsopts -threaded
475 ghc-options: -Wall -O2 -rtsopts -threaded
282− ghc-prof-options: -fprof-auto
283 build-depends:
476 build-depends:
284 base,
477 base,
285− containers == 0.5.*,
478+ containers,
286− criterion == 1.1.*,
479+ criterion,
287− deepseq >= 1.3 && < 1.5,
480+ deepseq,
288 dependent-map,
481 dependent-map,
289 dependent-sum,
482 dependent-sum,
290 loch-th,
483 loch-th,
@@ -296,7 +489,11 @@ benchmark saulzar-bench
296 split,
489 split,
297 stm,
490 stm,
298 time,
491 time,
299− transformers >= 0.3
492+ transformers
493+ other-modules:
494+ Reflex.TestPlan
495+ Reflex.Plan.Reflex
496+ Reflex.Bench.Focused
300
497
301source-repository head
498source-repository head
302 type: git
499 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 #-}
1+{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE DeriveTraversable #-}
4{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
4{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE PatternSynonyms #-}
8{-# LANGUAGE RoleAnnotations #-}
6{-# LANGUAGE RoleAnnotations #-}
9{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
11−-- | 'Data.Map' with a better 'Monoid' instance
9+{-# OPTIONS_GHC -fno-warn-orphans #-}
12−--
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.
13−-- 'Data.Map' has @mappend = union@, which is left-biased. AppendMap has
16+-- 'Data.Map' has @mappend = union@, which is left-biased. 'MonoidalMap'
14−-- @mappend = unionWith mappend@ instead.
17+-- has @mappend = unionWith mappend@ instead.
15−module Data.AppendMap where
18+module Data.AppendMap
19+ ( module Data.AppendMap
20+ , module Data.Map.Monoidal
21+ ) where
22+
23+import Prelude hiding (null)
16
24
17−import Prelude hiding (map)
18−
19−import Control.Lens
20−import Data.Align
21import Data.Coerce
25import Data.Coerce
22import Data.Default
26import Data.Default
23import Data.Map (Map)
27import Data.Map (Map)
28+#if MIN_VERSION_containers(0,5,11)
24−import qualified Data.Map as Map
29+import qualified Data.Map.Internal.Debug as Map (showTree, showTreeWith)
25−import Data.Semigroup
30+#else
26−import Data.Set (Set)
31+import qualified Data.Map as Map (showTree, showTreeWith)
32+#endif
27−import Data.Typeable
33+import qualified Data.Witherable as W
28−import GHC.Generics (Generic)
34+import Data.Map.Monoidal
29−import Reflex.Class (FunctorMaybe (..))
35+import qualified Data.Map.Monoidal as MonoidalMap
30−import Reflex.Patch (Additive, Group (..))
36+
31−
37+
32−newtype AppendMap k m = AppendMap { _unAppendMap :: Map k m }
38+{-# DEPRECATED AppendMap "Use 'MonoidalMap' instead" #-}
33− deriving (Eq, Ord, Show, Read, Typeable, Generic, Functor, Foldable, Traversable, Align)
39+-- | AppendMap is a synonym for 'Data.Map.Monoidal.MonoidalMap'
34−
40+type AppendMap = MonoidalMap
35−type instance (Index (AppendMap k m)) = k
41+
36−type instance (IxValue (AppendMap k m)) = m
42+{-# DEPRECATED _unAppendMap "Use 'getMonoidalMap' instead" #-}
37−
43+-- | A synonym for 'getMonoidalMap'
38−instance Ord k => Ixed (AppendMap k m) where
44+_unAppendMap :: MonoidalMap k v -> Map k v
39− ix i = _Wrapped . ix i
45+_unAppendMap = getMonoidalMap
40−
46+
41−instance Ord k => At (AppendMap k m) where
47+-- | Pattern synonym for 'MonoidalMap'
42− at i = _Wrapped . at i
48+pattern AppendMap :: Map k v -> MonoidalMap k v
43−
49+pattern AppendMap m = MonoidalMap m
44−instance FunctorMaybe (AppendMap k) where
50+
45− fmapMaybe = mapMaybe
51+#if !MIN_VERSION_witherable(0,3,2)
52+instance W.Filterable (MonoidalMap k) where
53+ mapMaybe = MonoidalMap.mapMaybe
54+#endif
46
55
47-- | Deletes a key, returning 'Nothing' if the result is empty.
56-- | 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)
49nonEmptyDelete k vs =
58nonEmptyDelete k vs =
50 let deleted = delete k vs
59 let deleted = delete k vs
51− in if Data.AppendMap.null deleted
60+ in if null deleted
52 then Nothing
61 then Nothing
53 else Just deleted
62 else Just deleted
54
63
64+-- | Like 'mapMaybe' but indicates whether the resulting container is empty
55mapMaybeNoNull :: (a -> Maybe b)
65mapMaybeNoNull :: (a -> Maybe b)
56− -> AppendMap token a
66+ -> MonoidalMap token a
57− -> Maybe (AppendMap token b)
67+ -> Maybe (MonoidalMap token b)
58mapMaybeNoNull f as =
68mapMaybeNoNull f as =
59− let bs = fmapMaybe f as
69+ let bs = mapMaybe f as
60− in if Data.AppendMap.null bs
70+ in if null bs
61 then Nothing
71 then Nothing
62 else Just bs
72 else Just bs
63
73
64−instance FunctorWithIndex k (AppendMap k) where
74+-- TODO: Move instances to `Data.Patch`
65− imap f = AppendMap . imap f . _unAppendMap
75+-- | Displays a 'MonoidalMap' as a tree. See 'Data.Map.Lazy.showTree' for details.
66− imapped = _Wrapped . imapped
76+showTree :: forall k a. (Show k, Show a) => MonoidalMap k a -> String
67−
77+showTree = coerce (Map.showTree :: Map k a -> String)
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)
229
78
230−foldMapWithKey :: forall k a m. Monoid m => (k -> a -> m) -> AppendMap k a -> m
79+-- | Displays a 'MonoidalMap' as a tree, using the supplied function to convert nodes to string.
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
80+showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> MonoidalMap k a -> String
396showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
81showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
397
82
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
402 def = empty
84 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 #-}
5{-# LANGUAGE TypeFamilies #-}
1{-# LANGUAGE TypeFamilies #-}
2+-- |
3+-- Module:
4+-- Data.FastMutableIntMap
5+-- Description:
6+-- A mutable version of 'IntMap'
6module Data.FastMutableIntMap
7module Data.FastMutableIntMap
7 ( FastMutableIntMap
8 ( FastMutableIntMap
8 , new
9 , new
@@ -20,6 +21,7 @@ module Data.FastMutableIntMap
20 , patchIntMapNewElements
21 , patchIntMapNewElements
21 , patchIntMapNewElementsMap
22 , patchIntMapNewElementsMap
22 , getDeletions
23 , getDeletions
24+ , toList
23 ) where
25 ) where
24
26
25--TODO: Pure JS version
27--TODO: Pure JS version
@@ -27,41 +29,52 @@ module Data.FastMutableIntMap
27--TODO: Fast patch type
29--TODO: Fast patch type
28
30
29import Prelude hiding (lookup)
31import Prelude hiding (lookup)
32+
33+import Control.Monad.IO.Class
30−import Data.IORef
34+import Data.Foldable (traverse_)
31import Data.IntMap.Strict (IntMap)
35import Data.IntMap.Strict (IntMap)
32import qualified Data.IntMap.Strict as IntMap
36import qualified Data.IntMap.Strict as IntMap
33−import Data.Maybe
37+import Data.IORef
34−import Reflex.Patch.Class
38+import Data.Patch.Class
35−import Data.Foldable (traverse_)
39+import Data.Patch.IntMap
36−import Control.Monad.IO.Class
37
40
41+-- | A 'FastMutableIntMap' holds a map of values of type @a@ and allows low-overhead modifications via IO.
42+-- Operations on 'FastMutableIntMap' run in IO.
38newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
43newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
39
44
45+-- | Create a new 'FastMutableIntMap' out of an 'IntMap'
40new :: IntMap a -> IO (FastMutableIntMap a)
46new :: IntMap a -> IO (FastMutableIntMap a)
41new m = FastMutableIntMap <$> newIORef m
47new m = FastMutableIntMap <$> newIORef m
42
48
49+-- | Create a new empty 'FastMutableIntMap'
43newEmpty :: IO (FastMutableIntMap a)
50newEmpty :: IO (FastMutableIntMap a)
44newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
51newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
45
52
53+-- | Insert an element into a 'FastMutableIntMap' at the given key
46insert :: FastMutableIntMap a -> Int -> a -> IO ()
54insert :: FastMutableIntMap a -> Int -> a -> IO ()
47insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
55insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
48
56
57+-- | Attempt to lookup an element by key in a 'FastMutableIntMap'
49lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
58lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
50lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
59lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
51
60
61+-- | Runs the provided action over the intersection of a 'FastMutableIntMap' and an 'IntMap'
52forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
62forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
53forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
63forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
54 a <- liftIO $ readIORef r
64 a <- liftIO $ readIORef r
55 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
65 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
56
66
67+-- | Runs the provided action over the values of a 'FastMutableIntMap'
57for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
68for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
58for_ (FastMutableIntMap r) f = do
69for_ (FastMutableIntMap r) f = do
59 a <- liftIO $ readIORef r
70 a <- liftIO $ readIORef r
60 traverse_ f a
71 traverse_ f a
61
72
73+-- | Checks whether a 'FastMutableIntMap' is empty
62isEmpty :: FastMutableIntMap a -> IO Bool
74isEmpty :: FastMutableIntMap a -> IO Bool
63isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
75isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
64
76
77+-- | Retrieves the size of a 'FastMutableIntMap'
65size :: FastMutableIntMap a -> IO Int
78size :: FastMutableIntMap a -> IO Int
66size (FastMutableIntMap r) = IntMap.size <$> readIORef r
79size (FastMutableIntMap r) = IntMap.size <$> readIORef r
67
80
@@ -72,29 +85,13 @@ getFrozenAndClear (FastMutableIntMap r) = do
72 writeIORef r IntMap.empty
85 writeIORef r IntMap.empty
73 return result
86 return result
74
87
88+-- | Updates the value of a 'FastMutableIntMap' with the given patch (see 'Data.Patch.IntMap'),
89+-- and returns an 'IntMap' with the modified keys and values.
75applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
90applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
76applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
91applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
77 v <- readIORef r
92 v <- readIORef r
78 writeIORef r $! applyAlways p v
93 writeIORef r $! applyAlways p v
79 return $ IntMap.intersection v m
94 return $ IntMap.intersection v m
80
95
81−newtype PatchIntMap a = PatchIntMap (IntMap (Maybe a)) deriving (Functor, Foldable, Traversable, Monoid)
96+toList :: FastMutableIntMap a -> IO [(Int, a)]
82−
97+toList (FastMutableIntMap r) = IntMap.toList <$> readIORef r
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
src/Data/FastWeakBag.hs+26−22
@@ -3,7 +3,7 @@
3#ifdef USE_REFLEX_OPTIMIZER
3#ifdef USE_REFLEX_OPTIMIZER
4{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
4{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
5#endif
5#endif
6−#ifdef ghcjs_HOST_OS
6+#ifdef GHCJS_FAST_WEAK
7{-# LANGUAGE ForeignFunctionInterface #-}
7{-# LANGUAGE ForeignFunctionInterface #-}
8{-# LANGUAGE JavaScriptFFI #-}
8{-# LANGUAGE JavaScriptFFI #-}
9#endif
9#endif
@@ -18,40 +18,40 @@ module Data.FastWeakBag
18 , isEmpty
18 , isEmpty
19 , insert
19 , insert
20 , traverse
20 , traverse
21+ , traverse_
21 , remove
22 , remove
22 -- * Internal functions
23 -- * Internal functions
23 -- These will not always be available.
24 -- These will not always be available.
24−#ifndef ghcjs_HOST_OS
25+#ifndef GHCJS_FAST_WEAK
25 , _weakBag_children --TODO: Don't export this
26 , _weakBag_children --TODO: Don't export this
26#endif
27#endif
27 ) where
28 ) where
28
29
30+import Prelude hiding (traverse)
31+
29−import Control.Monad hiding (forM_, mapM_)
32+import Control.Monad
30import Control.Monad.IO.Class
33import Control.Monad.IO.Class
31
34
32−#ifdef ghcjs_HOST_OS
35+#ifdef GHCJS_FAST_WEAK
33import GHCJS.Types
36import GHCJS.Types
34−import Reflex.FastWeak (unsafeFromRawJSVal, unsafeToRawJSVal, js_isNull)
37+import Reflex.FastWeak (js_isNull, unsafeFromRawJSVal, unsafeToRawJSVal)
35#else
38#else
36import Control.Exception
39import Control.Exception
37−import Data.Foldable (forM_, mapM_)
38import Data.IntMap.Strict (IntMap)
40import Data.IntMap.Strict (IntMap)
39import qualified Data.IntMap.Strict as IntMap
41import qualified Data.IntMap.Strict as IntMap
40import Data.IORef
42import Data.IORef
41import System.Mem.Weak
43import System.Mem.Weak
42#endif
44#endif
43
45
44−import Prelude hiding (mapM_, traverse)
45−
46−-- | A @FastWeakBag a@ holds a set of values of type @a@, but does not retain them -
46+-- | A 'FastWeakBag' holds a set of values of type @/a/@, but does not retain them -
47−-- that is, they can still be garbage-collected. As long as the @a@s remain
47+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
48-- alive, the 'FastWeakBag' will continue to refer to them.
48-- alive, the 'FastWeakBag' will continue to refer to them.
49−#ifdef ghcjs_HOST_OS
49+#ifdef GHCJS_FAST_WEAK
50newtype FastWeakBag a = FastWeakBag JSVal
50newtype FastWeakBag a = FastWeakBag JSVal
51#else
51#else
52data FastWeakBag a = FastWeakBag
52data FastWeakBag a = FastWeakBag
53 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
53 { _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'
55 }
55 }
56#endif
56#endif
57
57
@@ -59,7 +59,7 @@ data FastWeakBag a = FastWeakBag
59-- the caller retains the ticket, the item is guranteed to stay in memory (and
59-- the caller retains the ticket, the item is guranteed to stay in memory (and
60-- thus in the 'FastWeakBag'). The ticket can also be used to remove the item from
60-- thus in the 'FastWeakBag'). The ticket can also be used to remove the item from
61-- the 'FastWeakBag' prematurely (i.e. while it is still alive), using 'remove'.
61-- the 'FastWeakBag' prematurely (i.e. while it is still alive), using 'remove'.
62−#ifdef ghcjs_HOST_OS
62+#ifdef GHCJS_FAST_WEAK
63newtype FastWeakBagTicket a = FastWeakBagTicket JSVal
63newtype FastWeakBagTicket a = FastWeakBagTicket JSVal
64#else
64#else
65data FastWeakBagTicket a = FastWeakBagTicket
65data FastWeakBagTicket a = FastWeakBagTicket
@@ -74,7 +74,7 @@ insert :: a -- ^ The item
74 -> FastWeakBag a -- ^ The 'FastWeakBag' to insert into
74 -> FastWeakBag a -- ^ The 'FastWeakBag' to insert into
75 -> IO (FastWeakBagTicket a) -- ^ Returns a 'FastWeakBagTicket' that ensures the item
75 -> IO (FastWeakBagTicket a) -- ^ Returns a 'FastWeakBagTicket' that ensures the item
76 -- is retained and allows the item to be removed.
76 -- is retained and allows the item to be removed.
77−#ifdef ghcjs_HOST_OS
77+#ifdef GHCJS_FAST_WEAK
78insert a wb = js_insert (unsafeToRawJSVal a) wb
78insert a wb = js_insert (unsafeToRawJSVal a) wb
79foreign import javascript unsafe "$r = new h$FastWeakBagTicket($2, $1);" js_insert :: JSVal -> FastWeakBag a -> IO (FastWeakBagTicket a)
79foreign import javascript unsafe "$r = new h$FastWeakBagTicket($2, $1);" js_insert :: JSVal -> FastWeakBag a -> IO (FastWeakBagTicket a)
80#else
80#else
@@ -93,7 +93,7 @@ insert a (FastWeakBag nextId children) = {-# SCC "insert" #-} do
93-- | Create an empty 'FastWeakBag'.
93-- | Create an empty 'FastWeakBag'.
94{-# INLINE empty #-}
94{-# INLINE empty #-}
95empty :: IO (FastWeakBag a)
95empty :: IO (FastWeakBag a)
96−#ifdef ghcjs_HOST_OS
96+#ifdef GHCJS_FAST_WEAK
97empty = js_empty
97empty = js_empty
98foreign import javascript unsafe "$r = new h$FastWeakBag();" js_empty :: IO (FastWeakBag a)
98foreign import javascript unsafe "$r = new h$FastWeakBag();" js_empty :: IO (FastWeakBag a)
99#else
99#else
@@ -110,21 +110,21 @@ empty = {-# SCC "empty" #-} do
110-- | Check whether a 'FastWeakBag' is empty.
110-- | Check whether a 'FastWeakBag' is empty.
111{-# INLINE isEmpty #-}
111{-# INLINE isEmpty #-}
112isEmpty :: FastWeakBag a -> IO Bool
112isEmpty :: FastWeakBag a -> IO Bool
113−#ifdef ghcjs_HOST_OS
113+#ifdef GHCJS_FAST_WEAK
114isEmpty = js_isEmpty
114isEmpty = js_isEmpty
115foreign 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
115foreign 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
116#else
116#else
117isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
117isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
118#endif
118#endif
119
119
120−{-# INLINE traverse #-}
120+{-# INLINE traverse_ #-}
121-- | Visit every node in the given list. If new nodes are appended during the
121-- | Visit every node in the given list. If new nodes are appended during the
122-- traversal, they will not be visited. Every live node that was in the list
122-- traversal, they will not be visited. Every live node that was in the list
123-- when the traversal began will be visited exactly once; however, no guarantee
123-- when the traversal began will be visited exactly once; however, no guarantee
124-- is made about the order of the traversal.
124-- is made about the order of the traversal.
125−traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
125+traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
126−#ifdef ghcjs_HOST_OS
126+#ifdef GHCJS_FAST_WEAK
127−traverse wb f = do
127+traverse_ wb f = do
128 let go cursor = when (not $ js_isNull cursor) $ do
128 let go cursor = when (not $ js_isNull cursor) $ do
129 val <- liftIO $ js_getTicketValue cursor
129 val <- liftIO $ js_getTicketValue cursor
130 f $ unsafeFromRawJSVal val
130 f $ unsafeFromRawJSVal val
@@ -135,18 +135,22 @@ foreign import javascript unsafe "$r = $1.val;" js_getTicketValue :: JSVal -> IO
135--TODO: Fix the race condition where if a cursor is deleted (presumably using 'remove', below) while we're holding it, it can't find its way back to the correct bag
135--TODO: Fix the race condition where if a cursor is deleted (presumably using 'remove', below) while we're holding it, it can't find its way back to the correct bag
136foreign import javascript unsafe "(function(){ for(var i = $1.pos - 1; i >= 0; i--) { if($1.bag.tickets[i] !== null) { return $1.bag.tickets[i]; } }; return null; })()" js_getNext :: FastWeakBagTicket a -> IO JSVal --TODO: Clean up as we go along so this isn't O(n) every time -- Result can be null or a FastWeakBagTicket a
136foreign import javascript unsafe "(function(){ for(var i = $1.pos - 1; i >= 0; i--) { if($1.bag.tickets[i] !== null) { return $1.bag.tickets[i]; } }; return null; })()" js_getNext :: FastWeakBagTicket a -> IO JSVal --TODO: Clean up as we go along so this isn't O(n) every time -- Result can be null or a FastWeakBagTicket a
137#else
137#else
138−traverse (FastWeakBag _ children) f = {-# SCC "traverse" #-} do
138+traverse_ (FastWeakBag _ children) f = {-# SCC "traverse_" #-} do
139 cs <- liftIO $ readIORef children
139 cs <- liftIO $ readIORef children
140 forM_ cs $ \c -> do
140 forM_ cs $ \c -> do
141 ma <- liftIO $ deRefWeak c
141 ma <- liftIO $ deRefWeak c
142 mapM_ f ma
142 mapM_ f ma
143#endif
143#endif
144
144
145+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
146+traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
147+traverse = traverse_
148+
145-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
149-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
146-- on the same 'FastWeakBagTicket'.
150-- on the same 'FastWeakBagTicket'.
147{-# INLINE remove #-}
151{-# INLINE remove #-}
148remove :: FastWeakBagTicket a -> IO ()
152remove :: FastWeakBagTicket a -> IO ()
149−#ifdef ghcjs_HOST_OS
153+#ifdef GHCJS_FAST_WEAK
150remove = js_remove
154remove = js_remove
151foreign 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
155foreign 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
152#else
156#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
15 , singleton
15 , singleton
16 , insert
16 , insert
17 , traverse
17 , traverse
18+ , traverse_
18 , remove
19 , remove
19 -- * Internal functions
20 -- * Internal functions
20 -- These will not always be available.
21 -- These will not always be available.
21 , _weakBag_children --TODO: Don't export this
22 , _weakBag_children --TODO: Don't export this
22 ) where
23 ) where
23
24
25+import Prelude hiding (traverse)
26+
24import Control.Exception
27import Control.Exception
25−import Control.Monad hiding (forM_, mapM_)
28+import Control.Monad
26import Control.Monad.IO.Class
29import Control.Monad.IO.Class
27−import Data.Foldable (forM_, mapM_)
28import Data.IntMap.Strict (IntMap)
30import Data.IntMap.Strict (IntMap)
29import qualified Data.IntMap.Strict as IntMap
31import qualified Data.IntMap.Strict as IntMap
30import Data.IORef
32import Data.IORef
31import System.Mem.Weak
33import System.Mem.Weak
32
34
33−import Prelude hiding (mapM_, traverse)
34−
35−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
35+-- | A 'WeakBag' holds a set of values of type @/a/@, but does not retain them -
36−-- that is, they can still be garbage-collected. As long as the @a@s remain
36+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
37-- alive, the 'WeakBag' will continue to refer to them.
37-- alive, the 'WeakBag' will continue to refer to them.
38data WeakBag a = WeakBag
38data WeakBag a = WeakBag
39 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
39 { _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
41 }
41 }
42
42
43-- | When inserting an item into a 'WeakBag', a 'WeakBagTicket' is returned. If
43-- | 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
72 let !csWithoutMe = IntMap.delete myId cs
72 let !csWithoutMe = IntMap.delete myId cs
73 in (csWithoutMe, csWithoutMe)
73 in (csWithoutMe, csWithoutMe)
74 when (IntMap.null csWithoutMe) $ finalizer b
74 when (IntMap.null csWithoutMe) $ finalizer b
75− return ()
76− return ()
77 wa <- mkWeakPtr a' $ Just cleanup
75 wa <- mkWeakPtr a' $ Just cleanup
78 atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
76 atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
79 return $ WeakBagTicket
77 return $ WeakBagTicket
@@ -102,18 +100,22 @@ singleton a wbRef finalizer = {-# SCC "singleton" #-} do
102 ticket <- insert a bag wbRef finalizer
100 ticket <- insert a bag wbRef finalizer
103 return (bag, ticket)
101 return (bag, ticket)
104
102
105−{-# INLINE traverse #-}
103+{-# INLINE traverse_ #-}
106-- | Visit every node in the given list. If new nodes are appended during the
104-- | Visit every node in the given list. If new nodes are appended during the
107-- traversal, they will not be visited. Every live node that was in the list
105-- traversal, they will not be visited. Every live node that was in the list
108-- when the traversal began will be visited exactly once; however, no guarantee
106-- when the traversal began will be visited exactly once; however, no guarantee
109-- is made about the order of the traversal.
107-- is made about the order of the traversal.
110−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
108+traverse_ :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
111−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
109+traverse_ (WeakBag _ children) f = {-# SCC "traverse" #-} do
112 cs <- liftIO $ readIORef children
110 cs <- liftIO $ readIORef children
113 forM_ cs $ \c -> do
111 forM_ cs $ \c -> do
114 ma <- liftIO $ deRefWeak c
112 ma <- liftIO $ deRefWeak c
115 mapM_ f ma
113 mapM_ f ma
116
114
115+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
116+traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
117+traverse = traverse_
118+
117-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
119-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
118-- on the same 'WeakBagTicket'.
120-- on the same 'WeakBagTicket'.
119{-# INLINE remove #-}
121{-# INLINE remove #-}
src/Reflex.hs+10−2
@@ -6,13 +6,20 @@ module Reflex
6 ) where
6 ) where
7
7
8import Reflex.Class as X
8import 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
10import Reflex.Dynamic as X
13import Reflex.Dynamic as X
14+import Reflex.EventWriter.Base as X
15+import Reflex.EventWriter.Class as X
11#ifdef USE_TEMPLATE_HASKELL
16#ifdef USE_TEMPLATE_HASKELL
12import Reflex.Dynamic.TH as X
17import Reflex.Dynamic.TH as X
13#endif
18#endif
14import Reflex.Dynamic.Uniq as X
19import 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
16import Reflex.PerformEvent.Base as X
23import Reflex.PerformEvent.Base as X
17import Reflex.PerformEvent.Class as X
24import Reflex.PerformEvent.Class as X
18import Reflex.PostBuild.Base as X
25import Reflex.PostBuild.Base as X
@@ -23,5 +30,6 @@ import Reflex.Query.Class as X
23import Reflex.Requester.Base as X
30import Reflex.Requester.Base as X
24import Reflex.Requester.Class as X
31import Reflex.Requester.Class as X
25import Reflex.Spider as X
32import Reflex.Spider as X
33+import Reflex.Time as X
26import Reflex.TriggerEvent.Base as X
34import Reflex.TriggerEvent.Base as X
27import Reflex.TriggerEvent.Class as X
35import 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 #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
3+{-# LANGUAGE ConstraintKinds #-}
2{-# LANGUAGE DefaultSignatures #-}
4{-# LANGUAGE DefaultSignatures #-}
3{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE GADTs #-}
8{-# LANGUAGE GADTs #-}
7{-# LANGUAGE LambdaCase #-}
9{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE NoMonomorphismRestriction #-}
10{-# LANGUAGE NoMonomorphismRestriction #-}
11+{-# LANGUAGE PolyKinds #-}
10{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
11{-# LANGUAGE RecursiveDo #-}
13{-# LANGUAGE RecursiveDo #-}
12{-# LANGUAGE RoleAnnotations #-}
14{-# LANGUAGE RoleAnnotations #-}
@@ -14,45 +16,56 @@
14{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeOperators #-}
17{-# LANGUAGE TypeOperators #-}
16{-# LANGUAGE UndecidableInstances #-}
18{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
17#ifdef USE_REFLEX_OPTIMIZER
20#ifdef USE_REFLEX_OPTIMIZER
18{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
21{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
19#endif
22#endif
20−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
21−{-# LANGUAGE EmptyDataDecls #-}
22−{-# OPTIONS_GHC -Wno-redundant-constraints #-}
23−#endif
24
23
24+-- |
25+-- Module:
26+-- Reflex.Class
27+-- Description:
25−-- | This module contains the Reflex interface, as well as a variety of
28+-- This module contains the Reflex interface, as well as a variety of
26−-- convenience functions for working with 'Event's, 'Behavior's, and other
29+-- convenience functions for working with 'Event's, 'Behavior's, and other
27−-- signals.
30+-- signals.
28module Reflex.Class
31module Reflex.Class
29− ( module Reflex.Patch
32+ ( module Data.Patch
30 -- * Primitives
33 -- * Primitives
31 , Reflex (..)
34 , Reflex (..)
32 , mergeInt
35 , mergeInt
33 , coerceBehavior
36 , coerceBehavior
34 , coerceEvent
37 , coerceEvent
35 , coerceDynamic
38 , coerceDynamic
39+ , coerceIncremental
36 , MonadSample (..)
40 , MonadSample (..)
37 , MonadHold (..)
41 , MonadHold (..)
38− -- ** 'fan'-related types
42+ -- ** 'fan' related types
39 , EventSelector (..)
43 , EventSelector (..)
44+ , EventSelectorG (..)
40 , EventSelectorInt (..)
45 , EventSelectorInt (..)
41− -- ** 'Incremental'-related types
42 -- * Convenience functions
46 -- * Convenience functions
43 , constDyn
47 , constDyn
44 , pushAlways
48 , pushAlways
45 -- ** Combining 'Event's
49 -- ** Combining 'Event's
46 , leftmost
50 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
47 , mergeMap
54 , mergeMap
55+ , mergeIntMap
48 , mergeMapIncremental
56 , mergeMapIncremental
49 , mergeMapIncrementalWithMove
57 , mergeMapIncrementalWithMove
58+ , mergeIntMapIncremental
59+ , coincidencePatchMap
60+ , coincidencePatchMapWithMove
61+ , coincidencePatchIntMap
50 , mergeList
62 , mergeList
51 , mergeWith
63 , mergeWith
52 , difference
64 , difference
53 , alignEventWithMaybe
65 , alignEventWithMaybe
54 -- ** Breaking up 'Event's
66 -- ** Breaking up 'Event's
55 , splitE
67 , splitE
68+ , fan
56 , fanEither
69 , fanEither
57 , fanThese
70 , fanThese
58 , fanMap
71 , fanMap
@@ -60,11 +73,16 @@ module Reflex.Class
60 , EitherTag (..)
73 , EitherTag (..)
61 , eitherToDSum
74 , eitherToDSum
62 , dsumToEither
75 , dsumToEither
63− -- ** Switching between 'Event's
76+ , factorEvent
64− , switchPromptly
77+ , filterEventKey
65− , switchPromptOnly
78+ -- ** Collapsing 'Event . Event'
79+ , switchHold
80+ , switchHoldPromptly
81+ , switchHoldPromptOnly
82+ , switchHoldPromptOnlyIncremental
66 -- ** Using 'Event's to sample 'Behavior's
83 -- ** Using 'Event's to sample 'Behavior's
67 , tag
84 , tag
85+ , tagMaybe
68 , attach
86 , attach
69 , attachWith
87 , attachWith
70 , attachWithMaybe
88 , attachWithMaybe
@@ -72,6 +90,7 @@ module Reflex.Class
72 , gate
90 , gate
73 -- ** Combining 'Dynamic's
91 -- ** Combining 'Dynamic's
74 , distributeDMapOverDynPure
92 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
75 , distributeListOverDyn
94 , distributeListOverDyn
76 , distributeListOverDynWith
95 , distributeListOverDynWith
77 , zipDyn
96 , zipDyn
@@ -98,6 +117,14 @@ module Reflex.Class
98 , mapAccumM_
117 , mapAccumM_
99 , mapAccumMaybe_
118 , mapAccumMaybe_
100 , mapAccumMaybeM_
119 , mapAccumMaybeM_
120+ , accumIncremental
121+ , accumMIncremental
122+ , accumMaybeIncremental
123+ , accumMaybeMIncremental
124+ , mapAccumIncremental
125+ , mapAccumMIncremental
126+ , mapAccumMaybeIncremental
127+ , mapAccumMaybeMIncremental
101 , zipListWithEvent
128 , zipListWithEvent
102 , numberOccurrences
129 , numberOccurrences
103 , numberOccurrencesFrom
130 , numberOccurrencesFrom
@@ -107,6 +134,9 @@ module Reflex.Class
107 , tailE
134 , tailE
108 , headTailE
135 , headTailE
109 , takeWhileE
136 , takeWhileE
137+ , takeWhileJustE
138+ , dropWhileE
139+ , takeDropWhileJustE
110 , switcher
140 , switcher
111 -- * Debugging functions
141 -- * Debugging functions
112 , traceEvent
142 , traceEvent
@@ -114,21 +144,24 @@ module Reflex.Class
114 -- * Unsafe functions
144 -- * Unsafe functions
115 , unsafeDynamic
145 , unsafeDynamic
116 , unsafeMapIncremental
146 , unsafeMapIncremental
117− -- * 'FunctorMaybe'
147+ -- * 'Filterable' convenience functions
118− , FunctorMaybe (..)
148+ , FunctorMaybe -- fmapMaybe is purposely not exported from deprecated 'FunctorMaybe' and the new alias is exported instead
149+ , mapMaybe -- Re-exported for convenience
150+ , fmapMaybe
119 , fforMaybe
151 , fforMaybe
120 , ffilter
152 , ffilter
153+ , filterLeft
154+ , filterRight
121 -- * Miscellaneous convenience functions
155 -- * Miscellaneous convenience functions
122 , ffor
156 , ffor
123− , MonadAdjust (..)
157+ , ffor2
124− , sequenceDMapWithAdjust
158+ , ffor3
125− , sequenceDMapWithAdjustWithMove
126− , mapMapWithAdjustWithMove
127 -- * Deprecated functions
159 -- * Deprecated functions
128− , appendEvents
160+ , switchPromptly
129− , onceE
161+ , switchPromptOnly
130− , sequenceThese
162+ -- * "Cheap" functions
131 , fmapMaybeCheap
163 , fmapMaybeCheap
164+ , mapMaybeCheap
132 , fmapCheap
165 , fmapCheap
133 , fforCheap
166 , fforCheap
134 , fforMaybeCheap
167 , fforMaybeCheap
@@ -138,97 +171,63 @@ module Reflex.Class
138 , mergeWithCheap'
171 , mergeWithCheap'
139 -- * Slow, but general, implementations
172 -- * Slow, but general, implementations
140 , slowHeadE
173 , 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
172 ) where
174 ) where
173
175
176+#ifdef MIN_VERSION_semialign
177+import Prelude hiding (zip, zipWith)
178+
179+#if MIN_VERSION_these(0,8,0)
180+import Data.These.Combinators (justThese)
181+#endif
182+#if MIN_VERSION_semialign(1,1,0)
183+import Data.Zip (Zip (..), Unzip (..))
184+#endif
185+#endif
186+
174import Control.Applicative
187import Control.Applicative
175−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
188+import Control.Monad.Identity
176−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
189+import Control.Monad.Reader
177−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
190+import Control.Monad.State.Strict
178−import Control.Monad.Trans.Cont (ContT ())
191+import Control.Monad.Trans.Cont (ContT)
179−import Control.Monad.Trans.Except (ExceptT ())
192+import Control.Monad.Trans.Except (ExceptT)
180−import Control.Monad.Trans.RWS (RWST ())
193+import Control.Monad.Trans.RWS (RWST)
181−import Control.Monad.Trans.Writer (WriterT ())
194+import Control.Monad.Trans.Writer (WriterT)
182import Data.Align
195import Data.Align
183import Data.Bifunctor
196import Data.Bifunctor
184import Data.Coerce
197import Data.Coerce
185import Data.Default
198import Data.Default
186−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
187import qualified Data.Dependent.Map as DMap
201import 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)
189import Data.Foldable
206import Data.Foldable
190−import Data.Functor.Bind hiding (join)
207+import Data.Functor.Bind
191−import qualified Data.Functor.Bind as Bind
192−import Data.Functor.Constant
193import Data.Functor.Misc
208import Data.Functor.Misc
194import Data.Functor.Plus
209import Data.Functor.Plus
195import Data.IntMap.Strict (IntMap)
210import Data.IntMap.Strict (IntMap)
196import qualified Data.IntMap.Strict as IntMap
211import qualified Data.IntMap.Strict as IntMap
197import Data.List.NonEmpty (NonEmpty (..))
212import Data.List.NonEmpty (NonEmpty (..))
198import Data.Map (Map)
213import Data.Map (Map)
199−import Data.Maybe
214+import Data.Semigroup (Semigroup (..))
200−import Data.Monoid hiding (Alt, (<>))
215+import Data.Some (Some(Some))
201−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
202import Data.String
216import Data.String
203import Data.These
217import Data.These
204−import Data.Traversable
205import Data.Type.Coercion
218import Data.Type.Coercion
206−import Reflex.FunctorMaybe
219+import Data.Type.Equality ((:~:) (..))
207−import Reflex.Patch
220+import Data.Witherable (Filterable(..))
208−import Data.FastMutableIntMap (PatchIntMap)
221+import qualified Data.Witherable as W
209−
222+import Reflex.FunctorMaybe (FunctorMaybe)
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
223+import qualified Reflex.FunctorMaybe
218−import Unsafe.Coerce
224+import Data.Patch
219−#endif
225+import qualified Data.Patch.MapWithMove as PatchMapWithMove
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_)
223
226
224import Debug.Trace (trace)
227import Debug.Trace (trace)
225
228
226−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
227−#include "Spider/SpiderTimeline.include.hs"
228−#endif
229−
230-- | The 'Reflex' class contains all the primitive functionality needed for
229-- | 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
232-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
231-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
233-- and the type of the timeline determines the FRP engine to be used. For most
232-- and the type of the timeline determines the FRP engine to be used. For most
234-- purposes, the 'Reflex.Spider' implementation is recommended.
233-- purposes, the 'Reflex.Spider' implementation is recommended.
@@ -238,9 +237,6 @@ class ( MonadHold t (PushM t)
238 , Functor (Dynamic t)
237 , Functor (Dynamic t)
239 , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
238 , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
240 , Monad (Dynamic t)
239 , Monad (Dynamic t)
241−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
242− , t ~ SpiderTimeline Global
243−#endif
244 ) => Reflex t where
240 ) => Reflex t where
245 -- | A container for a value that can change over time. 'Behavior's can be
241 -- | A container for a value that can change over time. 'Behavior's can be
246 -- sampled at will, but it is not possible to be notified when they change
242 -- sampled at will, but it is not possible to be notified when they change
@@ -263,7 +259,6 @@ class ( MonadHold t (PushM t)
263 type PushM t :: * -> *
259 type PushM t :: * -> *
264 -- | A monad for doing complex pull-based calculations efficiently
260 -- | A monad for doing complex pull-based calculations efficiently
265 type PullM t :: * -> *
261 type PullM t :: * -> *
266−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
267 -- | An 'Event' with no occurrences
262 -- | An 'Event' with no occurrences
268 never :: Event t a
263 never :: Event t a
269 -- | Create a 'Behavior' that always has the given value
264 -- | Create a 'Behavior' that always has the given value
@@ -278,18 +273,23 @@ class ( MonadHold t (PushM t)
278 -- recomputed whenever any of the read 'Behavior's changes
273 -- recomputed whenever any of the read 'Behavior's changes
279 pull :: PullM t a -> Behavior t a
274 pull :: PullM t a -> Behavior t a
280 -- | Merge a collection of events; the resulting 'Event' will only occur if at
275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
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
282 -- that are occurring simultaneously
277 -- that are occurring simultaneously
278+
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
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+
284− -- | Efficiently fan-out an event to many destinations. This function should
283+ -- | Efficiently fan-out an event to many destinations. You should save the
285− -- be partially applied, and then the result applied repeatedly to create
284+ -- result in a @let@-binding, and then repeatedly 'selectG' on the result to
286− -- child events
285+ -- create 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
286+ fanG :: GCompare k => Event t (DMap k v) -> EventSelectorG t k v
287+
288 -- | Create an 'Event' that will occur whenever the currently-selected input
288 -- | Create an 'Event' that will occur whenever the currently-selected input
289 -- 'Event' occurs
289 -- 'Event' occurs
290 switch :: Behavior t (Event t a) -> Event t a
290 switch :: Behavior t (Event t a) -> Event t a
291− -- | Create an 'Event' that will occur whenever the input event is occurring
291+ -- | Create an 'Event' that will occur whenever the input event is occurring -- and its occurrence value, another 'Event', is also occurring.
292− -- and its occurrence value, another 'Event', is also occurring
292+ -- You maybe looking for '@switchHold@ @never@' instead.
293 coincidence :: Event t (Event t a) -> Event t a
293 coincidence :: Event t (Event t a) -> Event t a
294 -- | Extract the 'Behavior' of a 'Dynamic'.
294 -- | Extract the 'Behavior' of a 'Dynamic'.
295 current :: Dynamic t a -> Behavior t a
295 current :: Dynamic t a -> Behavior t a
@@ -298,14 +298,19 @@ class ( MonadHold t (PushM t)
298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
299 -- recent firing of the given 'Event', if any.
299 -- recent firing of the given 'Event', if any.
300 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
300 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
302 -- in the same way that the accumulated application of patches would change
302 -- in the same way that the accumulated application of patches would change
303 -- that value.
303 -- that value.
304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
305 -- | Create a merge whose parents can change over time
305 -- | Create a merge whose parents can change over time
306+ mergeIncrementalG :: GCompare k
307+ => (forall a. q a -> Event t (v a))
306− mergeIncremental :: GCompare k => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
308+ -> Incremental t (PatchDMap k q)
309+ -> Event t (DMap k v)
307 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
311+ mergeIncrementalWithMoveG :: GCompare k
312+ => (forall a. q a -> Event t (v a))
308− mergeIncrementalWithMove :: GCompare k => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
313+ -> Incremental t (PatchDMapWithMove k q) -> Event t (DMap k v)
309 -- | Extract the 'Behavior' component of an 'Incremental'
314 -- | Extract the 'Behavior' component of an 'Incremental'
310 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
311 -- | Extract the 'Event' component of an 'Incremental'
316 -- | Extract the 'Event' component of an 'Incremental'
@@ -321,86 +326,31 @@ class ( MonadHold t (PushM t)
321 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
322 -- occurrence type
327 -- occurrence type
323 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
328 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
329+ -- | Construct a 'Coercion' for an 'Incremental' given 'Coercion's for its
330+ -- patch target and patch types.
331+ incrementalCoercion
332+ :: Coercion (PatchTarget a) (PatchTarget b) -> Coercion a b -> Coercion (Incremental t a) (Incremental t b)
324 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
333 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
325 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
334 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
327
347
328--TODO: Specialize this so that we can take advantage of knowing that there's no changing going on
348--TODO: Specialize this so that we can take advantage of knowing that there's no changing going on
349+-- | Constructs a single 'Event' out of a map of events. The output event may fire with multiple
350+-- keys simultaneously.
329mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
351mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
330mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
352mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
331
353
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−
404-- | Coerce a 'Behavior' between representationally-equivalent value types
354-- | Coerce a 'Behavior' between representationally-equivalent value types
405coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
355coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
406coerceBehavior = coerceWith $ behaviorCoercion Coercion
356coerceBehavior = coerceWith $ behaviorCoercion Coercion
@@ -413,8 +363,14 @@ coerceEvent = coerceWith $ eventCoercion Coercion
413coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
414coerceDynamic = coerceWith $ dynamicCoercion Coercion
364coerceDynamic = coerceWith $ dynamicCoercion Coercion
415
365
366+-- | Coerce an 'Incremental' between representationally-equivalent value types
367+coerceIncremental
368+ :: (Reflex t, Coercible a b, Coercible (PatchTarget a) (PatchTarget b))
369+ => Incremental t a -> Incremental t b
370+coerceIncremental = coerceWith $ incrementalCoercion Coercion Coercion
371+
416-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
372-- | 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
418-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
419-- if this is not the case, the resulting 'Dynamic' will behave
375-- if this is not the case, the resulting 'Dynamic' will behave
420-- nondeterministically.
376-- nondeterministically.
@@ -442,7 +398,7 @@ class MonadSample t m => MonadHold t m where
442 -- value and will be updated whenever the given 'Event' occurs. The update
398 -- value and will be updated whenever the given 'Event' occurs. The update
443 -- takes effect immediately after the 'Event' occurs; if the occurrence that
399 -- takes effect immediately after the 'Event' occurs; if the occurrence that
444 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
400 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
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
446 -- one.
402 -- one.
447 hold :: a -> Event t a -> m (Behavior t a)
403 hold :: a -> Event t a -> m (Behavior t a)
448 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
404 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
@@ -457,16 +413,118 @@ class MonadSample t m => MonadHold t m where
457 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
413 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
458 default holdIncremental :: (Patch p, m ~ f m', MonadTrans f, MonadHold t m') => PatchTarget p -> Event t p -> m (Incremental t p)
414 default holdIncremental :: (Patch p, m ~ f m', MonadTrans f, MonadHold t m') => PatchTarget p -> Event t p -> m (Incremental t p)
459 holdIncremental v0 = lift . holdIncremental v0
415 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)
461 {-
417 {-
462 default buildDynamic :: (m ~ f m', MonadTrans f, MonadHold t m') => PullM t a -> Event t a -> m (Dynamic t a)
418 default buildDynamic :: (m ~ f m', MonadTrans f, MonadHold t m') => PullM t a -> Event t a -> m (Dynamic t a)
463 buildDynamic getV0 = lift . buildDynamic getV0
419 buildDynamic getV0 = lift . buildDynamic getV0
464 -}
420 -}
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
466 -- the supplied 'Event'.
422 -- the supplied 'Event'.
467 headE :: Event t a -> m (Event t a)
423 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'
468
474
475+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event'
476+-- with a function that both accumulates and produces a value to fire
477+-- as an 'Event'. Returns both the accumulated value and the constructed
478+-- 'Event'.
479+mapAccumIncremental
480+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
481+ => (PatchTarget p -> b -> (p, c))
482+ -> PatchTarget p
483+ -> Event t b
484+ -> m (Incremental t p, Event t c)
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')
469
526
527+-- | A somewhat slow implementation of 'headE'
470slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
528slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
471slowHeadE e = do
529slowHeadE e = do
472 rec be <- hold e $ fmapCheap (const never) e'
530 rec be <- hold e $ fmapCheap (const never) e'
@@ -475,18 +533,31 @@ slowHeadE e = do
475
533
476-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
477-- key. This is much more efficient than filtering for each key with
535-- key. This is much more efficient than filtering for each key with
478−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
479newtype EventSelector t k = EventSelector
537newtype EventSelector t k = EventSelector
480 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
481 -- determined by the type of the key, so this can be used to fan-out
539 -- determined by the type of the key, so this can be used to fan-out
482 -- 'Event's whose sub-'Event's have different types.
540 -- 'Event's whose sub-'Event's have different types.
483 --
541 --
484 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
485− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
486 -- occurrences of an 'Event'.
544 -- occurrences of an 'Event'.
487 select :: forall a. k a -> Event t a
545 select :: forall a. k a -> Event t a
488 }
546 }
489
547
548+newtype EventSelectorG t k v = EventSelectorG
549+ { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
550+ -- determined by the type of the key, so this can be used to fan-out
551+ -- 'Event's whose sub-'Event's have different types.
552+ --
553+ -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
554+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
555+ -- occurrences of an 'Event'.
556+ selectG :: forall a. k a -> Event t (v a)
557+ }
558+
559+-- | Efficiently select an 'Event' keyed on 'Int'. This is more efficient than manually
560+-- filtering by key.
490newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
561newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
491
562
492--------------------------------------------------------------------------------
563--------------------------------------------------------------------------------
@@ -502,6 +573,7 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
502 holdIncremental a0 = lift . holdIncremental a0
573 holdIncremental a0 = lift . holdIncremental a0
503 buildDynamic a0 = lift . buildDynamic a0
574 buildDynamic a0 = lift . buildDynamic a0
504 headE = lift . headE
575 headE = lift . headE
576+ now = lift now
505
577
506instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
507 sample = lift . sample
579 sample = lift . sample
@@ -512,6 +584,7 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
512 holdIncremental a0 = lift . holdIncremental a0
584 holdIncremental a0 = lift . holdIncremental a0
513 buildDynamic a0 = lift . buildDynamic a0
585 buildDynamic a0 = lift . buildDynamic a0
514 headE = lift . headE
586 headE = lift . headE
587+ now = lift now
515
588
516instance MonadSample t m => MonadSample t (StateT s m) where
589instance MonadSample t m => MonadSample t (StateT s m) where
517 sample = lift . sample
590 sample = lift . sample
@@ -522,6 +595,7 @@ instance MonadHold t m => MonadHold t (StateT s m) where
522 holdIncremental a0 = lift . holdIncremental a0
595 holdIncremental a0 = lift . holdIncremental a0
523 buildDynamic a0 = lift . buildDynamic a0
596 buildDynamic a0 = lift . buildDynamic a0
524 headE = lift . headE
597 headE = lift . headE
598+ now = lift now
525
599
526instance MonadSample t m => MonadSample t (ExceptT e m) where
600instance MonadSample t m => MonadSample t (ExceptT e m) where
527 sample = lift . sample
601 sample = lift . sample
@@ -532,6 +606,7 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
532 holdIncremental a0 = lift . holdIncremental a0
606 holdIncremental a0 = lift . holdIncremental a0
533 buildDynamic a0 = lift . buildDynamic a0
607 buildDynamic a0 = lift . buildDynamic a0
534 headE = lift . headE
608 headE = lift . headE
609+ now = lift now
535
610
536instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
537 sample = lift . sample
612 sample = lift . sample
@@ -542,6 +617,7 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
542 holdIncremental a0 = lift . holdIncremental a0
617 holdIncremental a0 = lift . holdIncremental a0
543 buildDynamic a0 = lift . buildDynamic a0
618 buildDynamic a0 = lift . buildDynamic a0
544 headE = lift . headE
619 headE = lift . headE
620+ now = lift now
545
621
546instance MonadSample t m => MonadSample t (ContT r m) where
622instance MonadSample t m => MonadSample t (ContT r m) where
547 sample = lift . sample
623 sample = lift . sample
@@ -552,6 +628,7 @@ instance MonadHold t m => MonadHold t (ContT r m) where
552 holdIncremental a0 = lift . holdIncremental a0
628 holdIncremental a0 = lift . holdIncremental a0
553 buildDynamic a0 = lift . buildDynamic a0
629 buildDynamic a0 = lift . buildDynamic a0
554 headE = lift . headE
630 headE = lift . headE
631+ now = lift now
555
632
556--------------------------------------------------------------------------------
633--------------------------------------------------------------------------------
557-- Convenience functions
634-- Convenience functions
@@ -566,6 +643,14 @@ pushAlways f = push (fmap Just . f)
566ffor :: Functor f => f a -> (a -> b) -> f b
643ffor :: Functor f => f a -> (a -> b) -> f b
567ffor = flip fmap
644ffor = flip fmap
568
645
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+
569instance Reflex t => Applicative (Behavior t) where
654instance Reflex t => Applicative (Behavior t) where
570 pure = constant
655 pure = constant
571 f <*> x = pull $ sample f `ap` sample x
656 f <*> x = pull $ sample f `ap` sample x
@@ -593,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
593 a >>= f = pull $ sample a >>= sample . f
678 a >>= f = pull $ sample a >>= sample . f
594 -- Note: it is tempting to write (_ >> b = b); however, this would result in (fail x >> return y) succeeding (returning y), which violates the law that (a >> b = a >>= \_ -> b), since the implementation of (>>=) above actually will fail. Since we can't examine 'Behavior's other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
679 -- Note: it is tempting to write (_ >> b = b); however, this would result in (fail x >> return y) succeeding (returning y), which violates the law that (a >> b = a >>= \_ -> b), since the implementation of (>>=) above actually will fail. Since we can't examine 'Behavior's other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
595 return = constant
680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
596 fail = error "Monad (Behavior t) does not support fail"
682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
597
684
598instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
599 mempty = constant mempty
686 mempty = constant mempty
@@ -609,32 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
609 negate = fmap negate
696 negate = fmap negate
610 signum = fmap signum
697 signum = fmap signum
611
698
699+instance (Num a, Reflex t) => Num (Dynamic t a) where
700+ (+) = liftA2 (+)
701+ (*) = liftA2 (*)
702+ abs = fmap abs
703+ signum = fmap signum
704+ fromInteger = pure . fromInteger
705+ negate = fmap negate
706+ (-) = liftA2 (-)
707+
612instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
613 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
614 sconcat = pull . fmap sconcat . mapM sample
710 sconcat = pull . fmap sconcat . mapM sample
615−#if MIN_VERSION_semigroups(0,17,0)
616 stimes n = fmap $ stimes n
711 stimes n = fmap $ stimes n
617−#else
618− times1p n = fmap $ times1p n
619−#endif
620
712
713+-- | Alias for 'mapMaybe'
714+fmapMaybe :: Filterable f => (a -> Maybe b) -> f a -> f b
715+fmapMaybe = mapMaybe
716+
621−-- | Flipped version of 'fmapMaybe'.
717+-- | Flipped version of 'mapMaybe'.
622−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
718+fforMaybe :: Filterable f => f a -> (a -> Maybe b) -> f b
623−fforMaybe = flip fmapMaybe
719+fforMaybe = flip mapMaybe
624
720
625-- | Filter 'f a' using the provided predicate.
721-- | Filter 'f a' using the provided predicate.
626−-- Relies on 'fforMaybe'.
627−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
722+ffilter :: Filterable f => (a -> Bool) -> f a -> f a
628−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
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)
629
732
630-- | Left-biased event union (prefers left event on simultaneous
733-- | Left-biased event union (prefers left event on simultaneous
631-- occurrence).
734-- occurrence).
632instance Reflex t => Alt (Event t) where
735instance Reflex t => Alt (Event t) where
633 ev1 <!> ev2 = leftmost [ev1, ev2]
736 ev1 <!> ev2 = leftmost [ev1, ev2]
634
737
635−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
636instance Reflex t => Apply (Event t) where
739instance 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+
638
744
639-- | 'Event' intersection (convenient interface to 'coincidence').
745-- | 'Event' intersection (convenient interface to 'coincidence').
640instance Reflex t => Bind (Event t) where
746instance Reflex t => Bind (Event t) where
@@ -643,13 +749,18 @@ instance Reflex t => Bind (Event t) where
643
749
644instance Reflex t => Functor (Event t) where
750instance Reflex t => Functor (Event t) where
645 {-# INLINE fmap #-}
751 {-# INLINE fmap #-}
646− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
647 {-# INLINE (<$) #-}
753 {-# INLINE (<$) #-}
648 x <$ e = fmapCheap (const x) e
754 x <$ e = fmapCheap (const x) e
649
755
756+-- TODO Remove this instance
650instance Reflex t => FunctorMaybe (Event t) where
757instance Reflex t => FunctorMaybe (Event t) where
651 {-# INLINE fmapMaybe #-}
758 {-# INLINE fmapMaybe #-}
759+ fmapMaybe = mapMaybe
760+
761+instance Reflex t => Filterable (Event t) where
762+ {-# INLINE mapMaybe #-}
652− fmapMaybe f = push $ return . f
763+ mapMaybe f = push $ return . f
653
764
654-- | Never: @'zero' = 'never'@.
765-- | Never: @'zero' = 'never'@.
655instance Reflex t => Plus (Event t) where
766instance Reflex t => Plus (Event t) where
@@ -660,7 +771,13 @@ instance Reflex t => Plus (Event t) where
660tag :: Reflex t => Behavior t b -> Event t a -> Event t b
771tag :: Reflex t => Behavior t b -> Event t a -> Event t b
661tag b = pushAlways $ \_ -> sample b
772tag b = pushAlways $ \_ -> sample b
662
773
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+
663−-- | Create a new 'Event' that combines occurences of supplied 'Event' with the
780+-- | Create a new 'Event' that combines occurrences of supplied 'Event' with the
664-- current value of the 'Behavior'.
781-- current value of the 'Behavior'.
665attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
782attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
666attach = attachWith (,)
783attach = attachWith (,)
@@ -670,53 +787,118 @@ attach = attachWith (,)
670attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
787attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
671attachWith f = attachWithMaybe $ \a b -> Just $ f a b
788attachWith f = attachWithMaybe $ \a b -> Just $ f a b
672
789
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
674-- the 'Behavior'. The occurrence is discarded if the combining function returns
791-- the 'Behavior'. The occurrence is discarded if the combining function returns
675-- Nothing
792-- Nothing
676attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
793attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
677attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
794attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
678
795
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
680-- supplied 'Event'.
797-- 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)
682tailE e = snd <$> headTailE e
799tailE e = snd <$> headTailE e
683
800
684−-- | Create a tuple of two 'Event's with the first one occuring only the first
801+-- | Create a tuple of two 'Event's with the first one occurring only the first
685−-- time the supplied 'Event' occurs and the second occuring on all but the first
802+-- time the supplied 'Event' occurs and the second occurring on all but the first
686−-- occurence.
803+-- occurrence.
687−headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
804+headTailE :: (Reflex t, MonadHold t m) => Event t a -> m (Event t a, Event t a)
688headTailE e = do
805headTailE e = do
689 eHead <- headE e
806 eHead <- headE e
690 be <- hold never $ fmap (const e) eHead
807 be <- hold never $ fmap (const e) eHead
691 return (eHead, switch be)
808 return (eHead, switch be)
692
809
810+-- | Take the streak of occurrences starting at the current time for which the
811+-- event returns 'True'.
812+--
693−-- | Starting at the current time, fire all the occurrences of the 'Event' for
813+-- Starting at the current time, fire all the occurrences of the 'Event' for
694−-- which the given predicate returns 'True'. When 'False' is returned, do not
814+-- which the given predicate returns 'True'. When first 'False' is returned,
695−-- fire, and permanently stop firing, even if 'True' values are encountered
815+-- do not fire, and permanently stop firing, even if 'True' values would have
696−-- later.
816+-- been encountered later.
817+takeWhileE
818+ :: forall t m a
697−takeWhileE :: forall t m a. (Reflex t, MonadFix m, MonadHold t m) => (a -> Bool) -> Event t a -> m (Event t a)
819+ . (Reflex t, MonadFix m, MonadHold t m)
698−takeWhileE f e = do
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
699− rec let (eFalse, eTrue) = fanEither $ ffor e' $ \a -> if f a
839+ rec let (eBad, eTrue) = fanEither $ ffor e' $ \a -> case f a of
700− then Right a
701− else Left never
840+ Nothing -> Left never
702− be <- hold e eFalse
841+ Just b -> Right b
703− let e' = switch be
842+ eFirstBad <- headE eBad
843+ e' <- switchHold e eFirstBad
704 return eTrue
844 return eTrue
705
845
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+
706−-- | Split the supplied 'Event' into two individual 'Event's occuring at the
888+-- | Split the supplied 'Event' into two individual 'Event's occurring at the
707-- same time with the respective values from the tuple.
889-- same time with the respective values from the tuple.
708splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
890splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
709splitE e = (fmap fst e, fmap snd e)
891splitE e = (fmap fst e, fmap snd e)
710
892
711-- | Print the supplied 'String' and the value of the 'Event' on each
893-- | 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.
713--
895--
714-- Note: As with Debug.Trace.trace, the message will only be printed if the
896-- Note: As with Debug.Trace.trace, the message will only be printed if the
715-- 'Event' is actually used.
897-- 'Event' is actually used.
716traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
898traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
717traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
899traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
718
900
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
720-- 'Event'. This should /only/ be used for debugging.
902-- 'Event'. This should /only/ be used for debugging.
721--
903--
722-- Note: As with Debug.Trace.trace, the message will only be printed if the
904-- 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
727instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
728 (<>) = alignWith (mergeThese (<>))
910 (<>) = alignWith (mergeThese (<>))
729 sconcat = fmap sconcat . mergeList . toList
911 sconcat = fmap sconcat . mergeList . toList
730−#if MIN_VERSION_semigroups(0,17,0)
731 stimes n = fmap $ stimes n
912 stimes n = fmap $ stimes n
732−#else
733− times1p n = fmap $ times1p n
734−#endif
735
913
736instance (Semigroup a, Reflex t) => Monoid (Event t a) where
914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
737 mempty = never
915 mempty = never
@@ -760,25 +938,38 @@ leftmost :: Reflex t => [Event t a] -> Event t a
760leftmost = mergeWith const
938leftmost = mergeWith const
761
939
762-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
940-- | 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
764-- time.
942-- time.
765mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
943mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
766mergeList [] = never
944mergeList [] = never
767mergeList es = mergeWithFoldCheap' id es
945mergeList es = mergeWithFoldCheap' id es
768
946
947+unsafeMapIncremental
948+ :: (Reflex t, Patch p, Patch p')
769−unsafeMapIncremental :: (Reflex t, Patch p, Patch p') => (PatchTarget p -> PatchTarget p') -> (p -> p') -> Incremental t p -> Incremental t p'
949+ => (PatchTarget p -> PatchTarget p')
950+ -> (p -> p')
951+ -> Incremental t p
952+ -> Incremental t p'
770unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
771
954
772-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
773-- occurs if at least one of them occurs and has a map of values of all 'Event's
956-- 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.
775mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
958mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
776mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
959mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
777
960
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+
778-- | Create a merge whose parents can change over time
965-- | Create a merge whose parents can change over time
779mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
966mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
780mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
967mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
781
968
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+
782-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
973-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
783mergeMapIncrementalWithMove :: (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Event t a)) -> Event t (Map k a)
974mergeMapIncrementalWithMove :: (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Event t a)) -> Event t (Map k a)
784mergeMapIncrementalWithMove = fmap dmapToMap . mergeIncrementalWithMove . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWithMoveWith id)
975mergeMapIncrementalWithMove = 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)
788fanEither e =
979fanEither e =
789 let justLeft = either Just (const Nothing)
980 let justLeft = either Just (const Nothing)
790 justRight = either (const Nothing) Just
981 justRight = either (const Nothing) Just
791− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
792
983
793-- | Split the event into separate events for 'This' and 'That' values,
984-- | Split the event into separate events for 'This' and 'That' values,
794-- allowing them to fire simultaneously when the input value is 'These'.
985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -800,47 +991,141 @@ fanThese e =
800 that (That y) = Just y
991 that (That y) = Just y
801 that (These _ y) = Just y
992 that (These _ y) = Just y
802 that _ = Nothing
993 that _ = Nothing
803− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
804
995
805-- | Split the event into an 'EventSelector' that allows efficient selection of
996-- | Split the event into an 'EventSelector' that allows efficient selection of
806-- the individual 'Event's.
997-- the individual 'Event's.
807fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
998fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
808fanMap = fan . fmap mapToDMap
999fanMap = fan . fmap mapToDMap
809
1000
810−-- | Switches to the new event whenever it receives one. Whenever a new event
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
811−-- is provided, if it is firing, its value will be the resulting event's value;
1015+-- provided, if it is firing, its value will be the resulting event's value; if
812−-- if it is not firing, but the old one is, the old one's value will be used.
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.
813−switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1022+switchHoldPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
814−switchPromptly ea0 eea = do
1023+switchHoldPromptly ea0 eea = do
815 bea <- hold ea0 eea
1024 bea <- hold ea0 eea
816 let eLag = switch bea
1025 let eLag = switch bea
817 eCoincidences = coincidence eea
1026 eCoincidences = coincidence eea
818 return $ leftmost [eCoincidences, eLag]
1027 return $ leftmost [eCoincidences, eLag]
819
1028
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
821-- switching, the old event will be ignored if it fires, and the new one will be
1030-- switching, the old event will be ignored if it fires, and the new one will be
822-- used if it fires; this is the opposite of 'switch', which will use only the
1031-- used if it fires; this is the opposite of 'switch', which will use only the
823-- old value.
1032-- old value.
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.
824−switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1038+switchHoldPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
825−switchPromptOnly e0 e' = do
1039+switchHoldPromptOnly e0 e' = do
826 eLag <- switch <$> hold e0 e'
1040 eLag <- switch <$> hold e0 e'
827 return $ coincidence $ leftmost [e', eLag <$ eLag]
1041 return $ coincidence $ leftmost [e', eLag <$ eLag]
828
1042
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+
829instance Reflex t => Align (Event t) where
1094instance Reflex t => Align (Event t) where
830 nil = never
1095 nil = never
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
831 align = alignEventWithMaybe Just
1099 align = alignEventWithMaybe Just
832
1100
1101+#ifdef MIN_VERSION_semialign
1102+#if MIN_VERSION_semialign(1,1,0)
1103+instance Reflex t => Zip (Event t) where
1104+#endif
1105+ zip x y = mapMaybe justThese $ align x y
1106+#endif
1107+
1108+#ifdef MIN_VERSION_semialign
1109+#if MIN_VERSION_semialign(1,1,0)
1110+instance Reflex t => Unzip (Event t) where
1111+ unzip = splitE
1112+#endif
1113+#endif
1114+
833-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
1115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
834−-- the 'Behavior' is true at the time of occurence.
1116+-- the 'Behavior' is true at the time of occurrence.
835gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
1117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
836gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
1118gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
837
1119
838−-- | Create a new behavior given a starting behavior and switch to a the behvior
1120+-- | Create a new behavior given a starting behavior and switch to the behavior
839−-- carried by the event when it fires.
1121+-- carried by the event when it fires.
840switcher :: (Reflex t, MonadHold t m)
1122switcher :: (Reflex t, MonadHold t m)
841 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
1123 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
842switcher b eb = pull . (sample <=< sample) <$> hold b eb
1124switcher b eb = pull . (sample <=< sample) <$> hold b eb
843
1125
1126+instance (Reflex t, IsString a) => IsString (Dynamic t a) where
1127+ fromString = pure . fromString
1128+
844-- | Combine two 'Dynamic's. The result will change whenever either (or both)
1129-- | Combine two 'Dynamic's. The result will change whenever either (or both)
845-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
1130-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
846zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
1131zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
@@ -848,7 +1133,7 @@ zipDyn = zipDynWith (,)
848
1133
849-- | Combine two 'Dynamic's with a combining function. The result will change
1134-- | Combine two 'Dynamic's with a combining function. The result will change
850-- whenever either (or both) input 'Dynamic' changes.
1135-- whenever either (or both) input 'Dynamic' changes.
851−-- More efficient than liftA2.
1136+-- More efficient than 'liftA2'.
852zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
1137zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
853zipDynWith f da db =
1138zipDynWith f da db =
854 let eab = align (updated da) (updated db)
1139 let eab = align (updated da) (updated db)
@@ -864,6 +1149,10 @@ zipDynWith f da db =
864 return $ Just $ f a b
1149 return $ Just $ f a b
865 in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
1150 in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
866
1151
1152+instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
1153+ (<>) = zipDynWith (<>)
1154+ stimes n = fmap $ stimes n
1155+
867instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
1156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
868 mconcat = distributeListOverDynWith mconcat
1157 mconcat = distributeListOverDynWith mconcat
869 mempty = constDyn mempty
1158 mempty = constDyn mempty
@@ -871,14 +1160,23 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
871
1160
872-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
1161-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
873-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
1162-- '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.
875distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
1164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
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
877 [] -> constDyn DMap.empty
1175 [] -> constDyn DMap.empty
878− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
879 _ ->
1177 _ ->
880− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
1178+ let getInitial = DMap.traverseWithKey (\_ -> sample . current . nt) dm
881− edmPre = merge $ DMap.map updated dm
1179+ edmPre = mergeG getCompose $ DMap.map (Compose . updated . nt) dm
882 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
1180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
883 olds <- sample $ current result
1181 olds <- sample $ current result
884 return $ DMap.unionWithKey (\_ _ new -> new) olds news
1182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -890,21 +1188,73 @@ distributeListOverDyn = distributeListOverDynWith id
890
1188
891-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
1189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
892distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
1190distributeListOverDynWith :: 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
894
1201
895-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
1202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
896-- unless the second supplied 'Event' occurs simultaneously.
1203-- unless the second supplied 'Event' occurs simultaneously.
897difference :: Reflex t => Event t a -> Event t b -> Event t a
1204difference :: Reflex t => Event t a -> Event t b -> Event t a
898difference = alignEventWithMaybe $ \case
1205difference = alignEventWithMaybe $ \case
899 This a -> Just a
1206 This a -> Just a
900− _ -> Nothing
1207+ _ -> Nothing
901
1208
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
1210+-- 'Nothing' values are dropped.
902alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
1211alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
903−alignEventWithMaybe f ea eb =
1212+alignEventWithMaybe f ea eb = mapMaybe (f <=< dmapToThese) $
904− fmapMaybe (f <=< dmapToThese)
905− $ merge
906− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1213+ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
907−
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)
908
1258
909--------------------------------------------------------------------------------
1259--------------------------------------------------------------------------------
910-- Accumulator
1260-- Accumulator
@@ -934,26 +1284,94 @@ class Reflex t => Accumulator t f | f -> t where
934 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
1284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
935 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
1285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
936
1286
1287+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1288+-- with the provided function. See 'foldDyn'.
1289+accumDyn
937−accumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Dynamic t a)
1290+ :: (Reflex t, MonadHold t m, MonadFix m)
1291+ => (a -> b -> a)
1292+ -> a
1293+ -> Event t b
1294+ -> m (Dynamic t a)
938accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
1295accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
1296+
1297+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1298+-- with the provided 'PushM' action.
1299+accumMDyn
939−accumMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Dynamic t a)
1300+ :: (Reflex t, MonadHold t m, MonadFix m)
1301+ => (a -> b -> PushM t a)
1302+ -> a
1303+ -> Event t b
1304+ -> m (Dynamic t a)
940accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
1305accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
1306+
1307+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1308+-- with the provided function, discarding 'Nothing' results.
1309+accumMaybeDyn
941−accumMaybeDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Dynamic t a)
1310+ :: (Reflex t, MonadHold t m, MonadFix m)
1311+ => (a -> b -> Maybe a)
1312+ -> a
1313+ -> Event t b
1314+ -> m (Dynamic t a)
942accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
1315accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
1316+
1317+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1318+-- with the provided 'PushM' action, discarding 'Nothing' results.
1319+accumMaybeMDyn
943−accumMaybeMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Dynamic t a)
1320+ :: (Reflex t, MonadHold t m, MonadFix m)
1321+ => (a -> b -> PushM t (Maybe a))
1322+ -> a
1323+ -> Event t b
1324+ -> m (Dynamic t a)
944accumMaybeMDyn f z e = do
1325accumMaybeMDyn f z e = do
945 rec let e' = flip push e $ \o -> do
1326 rec let e' = flip push e $ \o -> do
946 v <- sample $ current d'
1327 v <- sample $ current d'
947 f v o
1328 f v o
948 d' <- holdDyn z e'
1329 d' <- holdDyn z e'
949 return d'
1330 return d'
1331+
1332+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1333+-- with a function that both accumulates and produces a value to fire
1334+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
1335+mapAccumDyn
950−mapAccumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
1336+ :: (Reflex t, MonadHold t m, MonadFix m)
1337+ => (a -> b -> (a, c))
1338+ -> a
1339+ -> Event t b
1340+ -> m (Dynamic t a, Event t c)
951mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1341mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1342+
1343+-- | Similar to 'mapAccumDyn' except that the combining function is a
1344+-- 'PushM' action.
1345+mapAccumMDyn
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)
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)
953mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1351mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1352+
1353+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event' with
1354+-- a function that both optionally accumulates and optionally produces
1355+-- a value to fire as a separate output 'Event'.
1356+-- Note that because 'Nothing's are discarded in both cases, the output
1357+-- 'Event' may fire even though the output 'Dynamic' has not changed, and
1358+-- the output 'Dynamic' may update even when the output 'Event' is not firing.
1359+mapAccumMaybeDyn
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)
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)
955mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1365mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1366+
1367+-- | Like 'mapAccumMaybeDyn' except that the combining function is a
1368+-- 'PushM' action.
1369+mapAccumMaybeMDyn
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)
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)
957mapAccumMaybeMDyn f z e = do
1375mapAccumMaybeMDyn f z e = do
958 rec let e' = flip push e $ \o -> do
1376 rec let e' = flip push e $ \o -> do
959 v <- sample $ current d'
1377 v <- sample $ current d'
@@ -961,18 +1379,42 @@ mapAccumMaybeMDyn f z e = do
961 return $ case result of
1379 return $ case result of
962 (Nothing, Nothing) -> Nothing
1380 (Nothing, Nothing) -> Nothing
963 _ -> Just result
1381 _ -> Just result
964− d' <- holdDyn z $ fmapMaybe fst e'
1382+ d' <- holdDyn z $ mapMaybe fst e'
965− return (d', fmapMaybe snd e')
1383+ return (d', mapMaybe snd e')
966
1384
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
967{-# INLINE accumB #-}
1387{-# INLINE accumB #-}
1388+accumB
968−accumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Behavior t a)
1389+ :: (Reflex t, MonadHold t m, MonadFix m)
1390+ => (a -> b -> a)
1391+ -> a
1392+ -> Event t b
1393+ -> m (Behavior t a)
969accumB f = accumMaybeB $ \v o -> Just $ f v o
1394accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
970{-# INLINE accumMB #-}
1397{-# INLINE accumMB #-}
1398+accumMB
971−accumMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Behavior t a)
1399+ :: (Reflex t, MonadHold t m, MonadFix m)
1400+ => (a -> b -> PushM t a)
1401+ -> a
1402+ -> Event t b
1403+ -> m (Behavior t a)
972accumMB f = accumMaybeMB $ \v o -> Just <$> f v o
1404accumMB f = accumMaybeMB $ \v o -> Just <$> f v o
1405+
1406+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1407+-- with the provided function, discarding 'Nothing' results.
973{-# INLINE accumMaybeB #-}
1408{-# INLINE accumMaybeB #-}
1409+accumMaybeB
974−accumMaybeB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Behavior t a)
1410+ :: (Reflex t, MonadHold t m, MonadFix m)
1411+ => (a -> b -> Maybe a)
1412+ -> a
1413+ -> Event t b
1414+ -> m (Behavior t a)
975accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1415accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
976{-# INLINE accumMaybeMB #-}
1418{-# INLINE accumMaybeMB #-}
977accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
1419accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
978accumMaybeMB f z e = do
1420accumMaybeMB f z e = do
@@ -981,16 +1423,42 @@ accumMaybeMB f z e = do
981 f v o
1423 f v o
982 d' <- hold z e'
1424 d' <- hold z e'
983 return d'
1425 return d'
1426+
1427+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1428+-- with a function that both accumulates and produces a value to fire
1429+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
984{-# INLINE mapAccumB #-}
1430{-# INLINE mapAccumB #-}
1431+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)
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)
986mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1437mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
987{-# INLINE mapAccumMB #-}
1440{-# INLINE mapAccumMB #-}
1441+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)
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)
989mapAccumMB f = mapAccumMaybeMB $ \v o -> bimap Just Just <$> f v o
1447mapAccumMB f = mapAccumMaybeMB $ \v o -> bimap Just Just <$> f v o
1448+
1449+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event' with
1450+-- a function that both optionally accumulates and optionally produces
1451+-- a value to fire as a separate output 'Event'. 'Nothing's are discarded.
990{-# INLINE mapAccumMaybeB #-}
1452{-# INLINE mapAccumMaybeB #-}
1453+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)
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)
992mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
1459mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
993
1460
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
994{-# INLINE mapAccumMaybeMB #-}
1462{-# INLINE mapAccumMaybeMB #-}
995mapAccumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Behavior t a, Event t c)
1463mapAccumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Behavior t a, Event t c)
996mapAccumMaybeMB f z e = do
1464mapAccumMaybeMB f z e = do
@@ -1000,8 +1468,8 @@ mapAccumMaybeMB f z e = do
1000 return $ case result of
1468 return $ case result of
1001 (Nothing, Nothing) -> Nothing
1469 (Nothing, Nothing) -> Nothing
1002 _ -> Just result
1470 _ -> Just result
1003− d' <- hold z $ fmapMaybe fst e'
1471+ d' <- hold z $ mapMaybe fst e'
1004− return (d', fmapMaybe snd e')
1472+ return (d', mapMaybe snd e')
1005
1473
1006-- | Accumulate occurrences of an 'Event', producing an output occurrence each
1474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
1007-- time. Discard the underlying 'Accumulator'.
1475-- time. Discard the underlying 'Accumulator'.
@@ -1048,7 +1516,7 @@ instance Reflex t => Accumulator t (Event t) where
1048 accumMaybeM f z e = updated <$> accumMaybeM f z e
1516 accumMaybeM f z e = updated <$> accumMaybeM f z e
1049 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
1517 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
1050
1518
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
1052-- list using the supplied function. If the list runs out of items, all
1520-- list using the supplied function. If the list runs out of items, all
1053-- subsequent 'Event' occurrences will be ignored.
1521-- subsequent 'Event' occurrences will be ignored.
1054zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
1522zipListWithEvent :: (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
1058 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
1526 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
1059 mapAccumMaybe_ f' l e
1527 mapAccumMaybe_ f' l e
1060
1528
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
1062{-# INLINE numberOccurrences #-}
1530{-# INLINE numberOccurrences #-}
1063numberOccurrences :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Event t (b, a))
1531numberOccurrences :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Event t (b, a))
1064numberOccurrences = numberOccurrencesFrom 0
1532numberOccurrences = numberOccurrencesFrom 0
1065
1533
1066−-- | Assign a number to each occurence of the given 'Event'
1534+-- | Assign a number to each occurrence of the given 'Event'
1067{-# INLINE numberOccurrencesFrom #-}
1535{-# INLINE numberOccurrencesFrom #-}
1068numberOccurrencesFrom :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t (b, a))
1536numberOccurrencesFrom :: (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)))
1070
1538
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
1072{-# INLINE numberOccurrencesFrom_ #-}
1540{-# INLINE numberOccurrencesFrom_ #-}
1073numberOccurrencesFrom_ :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t b)
1541numberOccurrencesFrom_ :: (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))
1075
1543
1076-- | This is used to sample the value of a 'Behavior' using an 'Event'.
1544-- | This is used to sample the value of a 'Behavior' using an 'Event'.
1077--
1545--
@@ -1141,79 +1609,74 @@ infixl 4 <@>
1141(<@) = tag
1609(<@) = tag
1142infixl 4 <@
1610infixl 4 <@
1143
1611
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−
1181------------------
1612------------------
1182-- Cheap Functions
1613-- Cheap Functions
1183------------------
1614------------------
1184
1615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
1185{-# INLINE pushAlwaysCheap #-}
1617{-# INLINE pushAlwaysCheap #-}
1186pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
1618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
1187pushAlwaysCheap f = pushCheap (fmap Just . f)
1619pushAlwaysCheap f = pushCheap (fmap Just . f)
1188
1620
1621+-- | A "cheap" version of 'mapMaybe'. See the performance note on 'pushCheap'.
1622+{-# INLINE mapMaybeCheap #-}
1623+mapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1624+mapMaybeCheap f = pushCheap $ return . f
1625+
1626+-- | An alias for 'mapMaybeCheap'
1189{-# INLINE fmapMaybeCheap #-}
1627{-# INLINE fmapMaybeCheap #-}
1190fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1191−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
1630+
1192
1631
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
1193{-# INLINE fforMaybeCheap #-}
1633{-# INLINE fforMaybeCheap #-}
1194fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1195−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
1196
1636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
1197{-# INLINE fforCheap #-}
1638{-# INLINE fforCheap #-}
1198fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
1639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
1199fforCheap = flip fmapCheap
1640fforCheap = flip fmapCheap
1200
1641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
1201{-# INLINE fmapCheap #-}
1643{-# INLINE fmapCheap #-}
1202fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
1644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
1203fmapCheap f = pushCheap $ return . Just . f
1645fmapCheap f = pushCheap $ return . Just . f
1204
1646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
1205{-# INLINE tagCheap #-}
1648{-# INLINE tagCheap #-}
1206tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
1649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
1207tagCheap b = pushAlwaysCheap $ \_ -> sample b
1650tagCheap b = pushAlwaysCheap $ \_ -> sample b
1208
1651
1652+-- | Merge a collection of events; the resulting 'Event' will only occur if at
1653+-- least one input event is occurring, and will contain all of the input keys
1654+-- that are occurring simultaneously
1655+merge :: (Reflex t, GCompare k) => DMap k (Event t) -> Event t (DMap k Identity)
1656+merge = mergeG coerceEvent
1657+{-# INLINE merge #-}
1658+
1659+-- | Create a merge whose parents can change over time
1660+mergeIncremental :: (Reflex t, GCompare k)
1661+ => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
1662+mergeIncremental = mergeIncrementalG coerceEvent
1663+
1664+-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
1665+mergeIncrementalWithMove :: (Reflex t, GCompare k)
1666+ => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
1667+mergeIncrementalWithMove = mergeIncrementalWithMoveG coerceEvent
1668+
1669+-- | A "cheap" version of 'mergeWithCheap'. See the performance note on 'pushCheap'.
1209{-# INLINE mergeWithCheap #-}
1670{-# INLINE mergeWithCheap #-}
1210mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
1671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
1211mergeWithCheap = mergeWithCheap' id
1672mergeWithCheap = mergeWithCheap' id
1212
1673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
1213{-# INLINE mergeWithCheap' #-}
1675{-# INLINE mergeWithCheap' #-}
1214mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
1676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
1215mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
1677mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
1216
1678
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
1217{-# INLINE mergeWithFoldCheap' #-}
1680{-# INLINE mergeWithFoldCheap' #-}
1218mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
1681mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
1219mergeWithFoldCheap' f es =
1682mergeWithFoldCheap' f es =
@@ -1226,24 +1689,11 @@ mergeWithFoldCheap' f es =
1226-- Deprecated functions
1689-- Deprecated functions
1227--------------------------------------------------------------------------------
1690--------------------------------------------------------------------------------
1228
1691
1229−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
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'. " #-}
1230−-- occurs. If both occur at the same time they are combined using 'mappend'.
1693+-- | See 'switchHoldPromptly'
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
1694+switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1233−appendEvents = alignWith $ mergeThese mappend
1695+switchPromptly = switchHoldPromptly
1234−
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'. " #-}
1235−-- | Alias for 'headE'
1697+-- | See 'switchHoldPromptOnly'
1236−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1698+switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1237−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
1699+switchPromptOnly = switchHoldPromptOnly
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
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 @@
17#ifdef USE_REFLEX_OPTIMIZER
17#ifdef USE_REFLEX_OPTIMIZER
18{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
18{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
19#endif
19#endif
20+-- |
21+-- Module:
22+-- Reflex.Dynamic
23+-- Description:
20−-- | This module contains various functions for working with 'Dynamic' values.
24+-- This module contains various functions for working with 'Dynamic' values.
21−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
25+-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
22module Reflex.Dynamic
26module Reflex.Dynamic
23 ( -- * Basics
27 ( -- * Basics
24 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
28 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
25 , current
29 , current
26 , updated
30 , updated
27 , holdDyn
31 , holdDyn
32+ , mapDynM
33+ , forDynM
28 , constDyn
34 , constDyn
29 , count
35 , count
30 , toggle
36 , toggle
37+ , switchDyn
31 , switchPromptlyDyn
38 , switchPromptlyDyn
32 , tagPromptlyDyn
39 , tagPromptlyDyn
33 , attachPromptlyDyn
40 , attachPromptlyDyn
@@ -46,15 +53,18 @@ module Reflex.Dynamic
46 , foldDynMaybe
53 , foldDynMaybe
47 , foldDynMaybeM
54 , foldDynMaybeM
48 , joinDynThroughMap
55 , joinDynThroughMap
56+ , joinDynThroughIntMap
49 , traceDyn
57 , traceDyn
50 , traceDynWith
58 , traceDynWith
51 , splitDynPure
59 , splitDynPure
52 , distributeMapOverDynPure
60 , distributeMapOverDynPure
61+ , distributeIntMapOverDynPure
53 , distributeDMapOverDynPure
62 , distributeDMapOverDynPure
54 , distributeListOverDynPure
63 , distributeListOverDynPure
55 , Demux
64 , Demux
56 , demux
65 , demux
57 , demuxed
66 , demuxed
67+ -- * Miscellaneous
58 -- Things that probably aren't very useful:
68 -- Things that probably aren't very useful:
59 , HList (..)
69 , HList (..)
60 , FHList (..)
70 , FHList (..)
@@ -64,36 +74,14 @@ module Reflex.Dynamic
64 , AllAreFunctors (..)
74 , AllAreFunctors (..)
65 , HListPtr (..)
75 , HListPtr (..)
66 , distributeFHListOverDynPure
76 , distributeFHListOverDynPure
67− -- Unsafe
77+ -- * Unsafe
68 , unsafeDynamic
78 , 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
90 ) where
79 ) where
91
80
92import Data.Functor.Compose
81import Data.Functor.Compose
93import Data.Functor.Misc
82import Data.Functor.Misc
94import Reflex.Class
83import Reflex.Class
95
84
96−import Control.Applicative ((<*>))
97import Control.Monad
85import Control.Monad
98import Control.Monad.Fix
86import Control.Monad.Fix
99import Control.Monad.Identity
87import Control.Monad.Identity
@@ -101,14 +89,25 @@ import Data.Align
101import Data.Dependent.Map (DMap)
89import Data.Dependent.Map (DMap)
102import qualified Data.Dependent.Map as DMap
90import qualified Data.Dependent.Map as DMap
103import Data.Dependent.Sum (DSum (..))
91import 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
105import Data.Map (Map)
95import Data.Map (Map)
106import Data.Maybe
96import Data.Maybe
107−import Data.Monoid
97+import Data.Monoid ((<>))
108import Data.These
98import Data.These
99+import Data.Type.Equality ((:~:) (..))
109
100
110import Debug.Trace
101import Debug.Trace
111
102
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+
112-- | Create a new 'Dynamic' that only signals changes if the values actually
111-- | Create a new 'Dynamic' that only signals changes if the values actually
113-- changed.
112-- changed.
114holdUniqDyn :: (Reflex t, MonadHold t m, MonadFix m, Eq a) => Dynamic t a -> m (Dynamic t a)
113holdUniqDyn :: (Reflex t, MonadHold t m, MonadFix m, Eq a) => Dynamic t a -> m (Dynamic t a)
@@ -120,7 +119,7 @@ holdUniqDyn = holdUniqDynBy (==)
120holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
119holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
121holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
120holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
122
121
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/@)
124improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
123improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
125improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
124improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
126
125
@@ -164,7 +163,7 @@ foldDynMaybe = accumMaybeDyn . flip
164foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
163foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
165foldDynMaybeM = accumMaybeMDyn . flip
164foldDynMaybeM = accumMaybeMDyn . flip
166
165
167−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
166+-- | Create a new 'Dynamic' that counts the occurrences of the 'Event'.
168count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
167count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
169count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
168count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
170
169
@@ -173,10 +172,25 @@ count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
173toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
172toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
174toggle = foldDyn (const not)
173toggle = foldDyn (const not)
175
174
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+
176-- | Switches to the new 'Event' whenever it receives one. Switching occurs
186-- | 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
178-- old and new inner Events fire simultaneously, the output will fire with the
188-- old and new inner Events fire simultaneously, the output will fire with the
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.
180switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
194switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
181switchPromptlyDyn de =
195switchPromptlyDyn de =
182 let eLag = switch $ current de
196 let eLag = switch $ current de
@@ -192,28 +206,30 @@ splitDynPure d = (fmap fst d, fmap snd d)
192distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
193distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
194
208
209+-- | Convert an 'IntMap' with 'Dynamic' elements into a 'Dynamic' of an 'IntMap' with
210+-- non-'Dynamic' elements.
211+distributeIntMapOverDynPure :: (Reflex t) => IntMap (Dynamic t v) -> Dynamic t (IntMap v)
212+distributeIntMapOverDynPure = fmap dmapToIntMap . distributeDMapOverDynPure . intMapWithFunctorToDMap
213+
195-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
196-- non-'Dynamic' elements, preserving the order of the elements.
215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
197distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
198−distributeListOverDynPure =
218+distributeListOverDynPure = distributeListOverDyn
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
208
219
209--TODO: Generalize this to functors other than Maps
220--TODO: Generalize this to functors other than Maps
210-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
211-- with the current values of the 'Dynamic's in a map.
222-- with the current values of the 'Dynamic's in a map.
212joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
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 =<<)
214
230
215-- | Print the value of the 'Dynamic' when it is first read and on each
231-- | Print the value of the 'Dynamic' when it is first read and on each
216−-- subsequent change that is observed (as traceEvent), prefixed with the
232+-- subsequent change that is observed (as 'traceEvent'), prefixed with the
217-- provided string. This should /only/ be used for debugging.
233-- provided string. This should /only/ be used for debugging.
218--
234--
219-- Note: Just like Debug.Trace.trace, the value will only be shown if something
235-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -223,7 +239,7 @@ traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
223
239
224-- | Print the result of applying the provided function to the value
240-- | Print the result of applying the provided function to the value
225-- of the 'Dynamic' when it is first read and on each subsequent change
241-- of the 'Dynamic' when it is first read and on each subsequent change
226−-- that is observed (as traceEvent). This should /only/ be used for
242+-- that is observed (as 'traceEvent'). This should /only/ be used for
227-- debugging.
243-- debugging.
228--
244--
229-- Note: Just like Debug.Trace.trace, the value will only be shown if something
245-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -239,36 +255,35 @@ traceDynWith f d =
239-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
255-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
240-- each time the 'Event' occurs.
256-- each time the 'Event' occurs.
241--
257--
242−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
258+-- Note: @/tagPromptlyDyn d e/@ differs from @/tag (current d) e/@ in the case that @/e/@ is firing
243−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
259+-- at the same time that @/d/@ is changing. With @/tagPromptlyDyn d e/@, the __new__ value of @/d/@
244−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
260+-- will replace the value of @/e/@, whereas with @/tag (current d) e/@, the __old__ value
245-- will be used, since the 'Behavior' won't be updated until the end of the frame.
261-- will be used, since the 'Behavior' won't be updated until the end of the frame.
246-- Additionally, this means that the output 'Event' may not be used to directly change
262-- Additionally, this means that the output 'Event' may not be used to directly change
247−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
263+-- the input 'Dynamic', because that would mean its value depends on itself. __When creating__
248−-- cyclic data flows, generally `tag (current d) e` is preferred.
264+-- __cyclic data flows, generally @/tag (current d) e/@ is preferred.__
249tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
265tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
250tagPromptlyDyn = attachPromptlyDynWith const
266tagPromptlyDyn = attachPromptlyDynWith const
251
267
252-- | Attach the current value of the 'Dynamic' to the value of the
268-- | Attach the current value of the 'Dynamic' to the value of the
253-- 'Event' each time it occurs.
269-- 'Event' each time it occurs.
254--
270--
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.
256attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
272attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
257attachPromptlyDyn = attachPromptlyDynWith (,)
273attachPromptlyDyn = attachPromptlyDynWith (,)
258
274
259-- | Combine the current value of the 'Dynamic' with the value of the
275-- | Combine the current value of the 'Dynamic' with the value of the
260-- 'Event' each time it occurs.
276-- 'Event' each time it occurs.
261--
277--
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.
263attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
279attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
264attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
280attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
265
281
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
267-- current value of the 'Dynamic' value and possibly filtering if the combining
283-- current value of the 'Dynamic' value and possibly filtering if the combining
268-- function returns 'Nothing'.
284-- function returns 'Nothing'.
269--
285--
270−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
286+-- Note: @/attachPromptlyDynWithMaybe f d/@ is not the same as @/attachWithMaybe f (current d)/@. See 'tagPromptlyDyn' for details.
271−-- (current d)`. See 'tagPromptlyDyn' for details.
272attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
287attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
273attachPromptlyDynWithMaybe f d e =
288attachPromptlyDynWithMaybe f d e =
274 let e' = attach (current d) e
289 let e' = attach (current d) e
@@ -277,8 +292,8 @@ attachPromptlyDynWithMaybe f d e =
277 These (_, b) a -> f a b -- Both events are firing, so use the newer value
292 These (_, b) a -> f a b -- Both events are firing, so use the newer value
278 That _ -> Nothing -- The tagging event isn't firing, so don't fire
293 That _ -> Nothing -- The tagging event isn't firing, so don't fire
279
294
280−-- | Factor a @Dynamic t (Maybe a)@ into a @Dynamic t (Maybe (Dynamic t a))@,
295+-- | Factor a @/Dynamic t (Maybe a)/@ into a @/Dynamic t (Maybe (Dynamic t a))/@,
281−-- such that the outer 'Dynamic' is updated only when the 'Maybe''s constructor
296+-- such that the outer 'Dynamic' is updated only when the "Maybe"'s constructor
282-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
297-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
283-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
298-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
284-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
299-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
@@ -293,6 +308,8 @@ maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
293 Left _ -> Nothing
308 Left _ -> Nothing
294 Right a -> Just a
309 Right a -> Just a
295
310
311+-- | Turns a 'Dynamic t (Either a b)' into a 'Dynamic t (Either (Dynamic t a) (Dynamic t b))' such that
312+-- the outer 'Dynamic' is updated only when the 'Either' constructor changes (e.g., from 'Left' to 'Right').
296eitherDyn :: forall t a b m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Either a b) -> m (Dynamic t (Either (Dynamic t a) (Dynamic t b)))
313eitherDyn :: forall t a b m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Either a b) -> m (Dynamic t (Either (Dynamic t a) (Dynamic t b)))
297eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
314eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
298 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
315 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
@@ -300,26 +317,23 @@ eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
300 LeftTag :=> Compose a -> Left $ coerceDynamic a
317 LeftTag :=> Compose a -> Left $ coerceDynamic a
301 RightTag :=> Compose b -> Right $ coerceDynamic b
318 RightTag :=> Compose b -> Right $ coerceDynamic b
302
319
320+-- | Factor a 'Dynamic t DSum' into a 'Dynamic' 'DSum' containing nested 'Dynamic' values.
321+-- The outer 'Dynamic' updates only when the key of the 'DSum' changes, while the update of the inner
322+-- 'Dynamic' represents updates within the current key.
323+factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k)
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)))
324+ => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
304−factorDyn d = do
325+factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
305− let inner :: forall m' a. (MonadFix m', MonadHold t m') => k a -> v a -> m' (Dynamic t (v a))
326+ update :: Event t (DSum k (Compose (Dynamic t) v))
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
327+ update = flip push (updated d) $ \(newKey :=> newVal) -> do
315− (oldKey :=> _) <- sample $ current d
328+ (oldKey :=> _) <- sample (current d)
316− case newKey `geq` oldKey of
329+ case newKey `geq` oldKey of
317− Just Refl -> return Nothing
330+ Just Refl -> return Nothing
318− Nothing -> do
331+ Nothing -> Just <$> holdKey (newKey :=> newVal)
319− newInner <- inner newKey newVal
332+
320− return $ Just $ newKey :=> Compose newInner
333+ holdKey (k :=> v) = do
321− o0 <- getInitial --TODO: Figure out how to get this to run inside something like the first argument to buildDynamic
334+ inner' <- filterEventKey k (updated d)
322− holdDyn o0 update
335+ inner <- holdDyn v inner'
336+ return $ k :=> Compose inner
323
337
324--------------------------------------------------------------------------------
338--------------------------------------------------------------------------------
325-- Demux
339-- Demux
@@ -334,7 +348,7 @@ factorDyn d = do
334--
348--
335-- > demuxed (demux d) k === fmap (== k) d
349-- > demuxed (demux d) k === fmap (== k) d
336--
350--
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
338-- /O(log(n))/, rather than /O(n)/ for fmap.
352-- /O(log(n))/, rather than /O(n)/ for fmap.
339data Demux t k = Demux { demuxValue :: Behavior t k
353data Demux t k = Demux { demuxValue :: Behavior t k
340 , demuxSelector :: EventSelector t (Const2 k Bool)
354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -404,21 +418,12 @@ data FHList f l where
404 FHCons :: f e -> FHList f l -> FHList f (e ': l)
418 FHCons :: f e -> FHList f l -> FHList f (e ': l)
405
419
406instance GEq (HListPtr l) where
420instance 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
413 HHeadPtr `geq` HHeadPtr = Just Refl
421 HHeadPtr `geq` HHeadPtr = Just Refl
414 HHeadPtr `geq` HTailPtr _ = Nothing
422 HHeadPtr `geq` HTailPtr _ = Nothing
415 HTailPtr _ `geq` HHeadPtr = Nothing
423 HTailPtr _ `geq` HHeadPtr = Nothing
416 HTailPtr a `geq` HTailPtr b = a `geq` b
424 HTailPtr a `geq` HTailPtr b = a `geq` b
417
425
418instance GCompare (HListPtr l) where -- Warning: This ordering can't change, dmapTo*HList will break
426instance 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
422 HHeadPtr `gcompare` HHeadPtr = GEQ
427 HHeadPtr `gcompare` HHeadPtr = GEQ
423 HHeadPtr `gcompare` HTailPtr _ = GLT
428 HHeadPtr `gcompare` HTailPtr _ = GLT
424 HTailPtr _ `gcompare` HHeadPtr = GGT
429 HTailPtr _ `gcompare` HHeadPtr = GGT
@@ -497,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
497
502
498-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
499-- single 'Dynamic' whose value represents all the current values of the input's
504-- single 'Dynamic' whose value represents all the current values of the input's
500−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
501collectDynPure :: ( RebuildSortedHList (HListElems b)
506collectDynPure :: ( RebuildSortedHList (HListElems b)
502 , IsHList a, IsHList b
507 , IsHList a, IsHList b
503 , AllAreFunctors (Dynamic t) (HListElems b)
508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -538,150 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
538#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
539 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
540#endif
545#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
13 ( qDynPure
13 ( qDynPure
14 , unqDyn
14 , unqDyn
15 , mkDynPure
15 , mkDynPure
16− -- * Deprecated functions
17− , qDyn
18− , mkDyn
19 ) where
16 ) where
20
17
21import Reflex.Dynamic
18import Reflex.Dynamic
@@ -23,7 +20,7 @@ import Reflex.Dynamic
23import Control.Monad.State
20import Control.Monad.State
24import Data.Data
21import Data.Data
25import Data.Generics
22import Data.Generics
26−import Data.Monoid
23+import Data.Monoid ((<>))
27import qualified Language.Haskell.Exts as Hs
24import qualified Language.Haskell.Exts as Hs
28import qualified Language.Haskell.Meta.Syntax.Translate as Hs
25import qualified Language.Haskell.Meta.Syntax.Translate as Hs
29import Language.Haskell.TH
26import Language.Haskell.TH
@@ -47,8 +44,8 @@ qDynPure qe = do
47 _ -> gmapM f d
44 _ -> gmapM f d
48 (e', exprsReversed) <- runStateT (gmapM f e) []
45 (e', exprsReversed) <- runStateT (gmapM f e) []
49 let exprs = reverse exprsReversed
46 let exprs = reverse exprsReversed
50− arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
47+ arg = foldr (\a b -> ConE 'FHCons `AppE` snd a `AppE` b) (ConE 'FHNil) exprs
51− param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
48+ param = foldr (\a b -> ConP 'HCons [VarP (fst a), b]) (ConP 'HNil []) exprs
52 [| $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
49 [| $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
53
50
54-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
51-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
@@ -84,7 +81,7 @@ mkDynPure = QuasiQuoter
84 }
81 }
85
82
86mkDynExp :: String -> Q Exp
83mkDynExp :: String -> Q Exp
87−mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] }) s of
84+mkDynExp s = case Hs.parseExpWithMode Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] } s of
88 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
85 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
89 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
86 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
90 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
87 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
@@ -107,24 +104,3 @@ mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ H
107 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
104 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
108 | modName == modName' && occName == occName' = 'unqMarker
105 | modName == modName' && occName == occName' = 'unqMarker
109 reinstateUnqDyn x = x
106 reinstateUnqDyn x = x
110−
111−--------------------------------------------------------------------------------
112−-- Deprecated
113−--------------------------------------------------------------------------------
114−
115−{-# DEPRECATED qDyn "Instead of $(qDyn x), use return $(qDynPure x)" #-}
116−-- | Like 'qDynPure', but wraps its result monadically using 'return'. This is
117−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
118−qDyn :: Q Exp -> Q Exp
119−qDyn qe = [| return $(qDynPure qe) |]
120−
121−{-# DEPRECATED mkDyn "Instead of [mkDyn| x |], use return [mkDynPure| x |]" #-}
122−-- | Like 'mkDynPure', but wraps its result monadically using 'return'. This is
123−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
124−mkDyn :: QuasiQuoter
125−mkDyn = QuasiQuoter
126− { quoteExp = \s -> [| return $(mkDynExp s) |]
127− , quotePat = error "mkDyn: pattern splices are not supported"
128− , quoteType = error "mkDyn: type splices are not supported"
129− , quoteDec = error "mkDyn: declaration splices are not supported"
130− }
src/Reflex/Dynamic/Uniq.hs+1−1
@@ -31,7 +31,7 @@ newtype UniqDynamic t a = UniqDynamic { unUniqDynamic :: Dynamic t a }
31
31
32-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
32-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
33uniqDynamic :: Reflex t => Dynamic t a -> UniqDynamic t a
33uniqDynamic :: 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
35 old <- sample $ current d --TODO: Is it better to sample ourselves here?
35 old <- sample $ current d --TODO: Is it better to sample ourselves here?
36 return $ unsafeJustChanged old new
36 return $ unsafeJustChanged old new
37
37
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
17module Reflex.DynamicWriter
1module Reflex.DynamicWriter
18− ( MonadDynamicWriter (..)
2+ {-# DEPRECATED "Use 'Reflex.DynamicWriter.Class' and 'Reflex.DynamicWrite.Base' instead, or just import 'Reflex'" #-}
19− , DynamicWriterT (..)
3+ ( module X
20− , runDynamicWriterT
21− , withDynamicWriterT
22 ) where
4 ) where
23
5
24−import Control.Monad.Exception
6+import Reflex.DynamicWriter.Base as X
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
7+import Reflex.DynamicWriter.Class as X
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_
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
17module Reflex.EventWriter
1module Reflex.EventWriter
18− ( EventWriterT (..)
2+ {-# DEPRECATED "Use 'Reflex.EventWriter.Class' and 'Reflex.EventWriter.Base' instead, or just import 'Reflex'" #-}
19− , runEventWriterT
3+ ( module X
20− , EventWriter (..)
21− , runWithReplaceEventWriterTWith
22− , sequenceDMapWithAdjustEventWriterTWith
23 ) where
4 ) where
24
5
25−import Reflex.Class
6+import Reflex.EventWriter.Base as X
26−import Reflex.Host.Class
27−import Reflex.PerformEvent.Class
28−import Reflex.PostBuild.Class
29−import Reflex.Query.Class
7+import Reflex.EventWriter.Class as X
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
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 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE LambdaCase #-}
3{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE ScopedTypeVariables #-}
4−#ifdef ghcjs_HOST_OS
4+#if GHCJS_FAST_WEAK
5{-# LANGUAGE ForeignFunctionInterface #-}
5{-# LANGUAGE ForeignFunctionInterface #-}
6{-# LANGUAGE JavaScriptFFI #-}
6{-# LANGUAGE JavaScriptFFI #-}
7#endif
7#endif
8+
9+-- |
10+-- Module:
11+-- Reflex.FastWeak
12+-- Description:
13+-- 'FastWeak' is a weak pointer to some value, and 'FastWeakTicket' ensures the value
14+-- referred to by a 'FastWeak' stays live while the ticket is held (live).
15+--
16+-- On GHC or GHCJS when not built with the @fast-weak@ cabal flag, 'FastWeak' is a wrapper
17+-- around the simple version of 'System.Mem.Weak.Weak' where the key and value are the same.
18+--
19+-- On GHCJS when built with the @fast-weak@ cabal flag, 'FastWeak' is implemented directly
20+-- in JS using @h$FastWeak@ and @h$FastWeakTicket@ which are a nonstandard part of the GHCJS RTS.
8module Reflex.FastWeak
21module Reflex.FastWeak
9 ( FastWeakTicket
22 ( FastWeakTicket
10 , FastWeak
23 , FastWeak
@@ -14,7 +27,7 @@ module Reflex.FastWeak
14 , getFastWeakValue
27 , getFastWeakValue
15 , getFastWeakTicket
28 , getFastWeakTicket
16 , emptyFastWeak
29 , emptyFastWeak
17−#ifdef ghcjs_HOST_OS
30+#ifdef GHCJS_FAST_WEAK
18 --TODO: Move these elsewhere
31 --TODO: Move these elsewhere
19 , unsafeFromRawJSVal
32 , unsafeFromRawJSVal
20 , unsafeToRawJSVal
33 , unsafeToRawJSVal
@@ -25,7 +38,7 @@ module Reflex.FastWeak
25import GHC.Exts (Any)
38import GHC.Exts (Any)
26import Unsafe.Coerce
39import Unsafe.Coerce
27
40
28−#ifdef ghcjs_HOST_OS
41+#ifdef GHCJS_FAST_WEAK
29import GHCJS.Types
42import GHCJS.Types
30#else
43#else
31import Control.Exception (evaluate)
44import Control.Exception (evaluate)
@@ -34,32 +47,60 @@ import System.Mem.Weak
34#endif
47#endif
35
48
36
49
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@.
38newtype FastWeakTicket a = FastWeakTicket JSVal
56newtype FastWeakTicket a = FastWeakTicket JSVal
39
57
58+-- | A reference to some value which can be garbage collected if there are only
59+-- weak references to the value left.
60+--
61+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
62+--
63+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using
64+-- 'getFastWeakTicket' if the value hasn't been collected yet.
65+--
66+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeak@.
40newtype FastWeak a = FastWeak JSVal
67newtype FastWeak a = FastWeak JSVal
41
68
42-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
69-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
43data Val a = Val { unVal :: a }
70data Val a = Val { unVal :: a }
44
71
45−-- | Coerce a JSVal that represents the heap object of a value of type 'a' into a value of type 'a'
72+-- | Coerce a JSVal that represents the heap object of a value of type @a@ into a value of type @a@
46unsafeFromRawJSVal :: JSVal -> a
73unsafeFromRawJSVal :: JSVal -> a
47unsafeFromRawJSVal v = unVal (unsafeCoerce v)
74unsafeFromRawJSVal v = unVal (unsafeCoerce v)
48
75
76+-- | Coerce a heap object of type @a@ into a 'JSVal' which represents that object.
49unsafeToRawJSVal :: a -> JSVal
77unsafeToRawJSVal :: a -> JSVal
50unsafeToRawJSVal v = unsafeCoerce (Val v)
78unsafeToRawJSVal v = unsafeCoerce (Val v)
51#else
79#else
80+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
81+-- can be used to get the referred to value without fear of @Nothing@,
82+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
52data FastWeakTicket a = FastWeakTicket
83data FastWeakTicket a = FastWeakTicket
53 { _fastWeakTicket_val :: !a
84 { _fastWeakTicket_val :: !a
54 , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
85 , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
55 }
86 }
56
87
88+-- | A reference to some value which can be garbage collected if there are only weak references to the value left.
89+--
90+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
91+--
92+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using 'getFastWeakTicket'
93+-- if the value hasn't been collected yet.
94+--
95+-- Synonymous with 'Weak'.
57type FastWeak a = Weak a
96type FastWeak a = Weak a
58#endif
97#endif
59
98
99+-- | Return the @a@ kept alive by the given 'FastWeakTicket'.
100+--
60−-- This needs to be in IO so we know that we've relinquished the ticket
101+-- This needs to be in IO so we know that we've relinquished the ticket.
61getFastWeakTicketValue :: FastWeakTicket a -> IO a
102getFastWeakTicketValue :: FastWeakTicket a -> IO a
62−#ifdef ghcjs_HOST_OS
103+#ifdef GHCJS_FAST_WEAK
63getFastWeakTicketValue t = do
104getFastWeakTicketValue t = do
64 v <- js_ticketVal t
105 v <- js_ticketVal t
65 return $ unsafeFromRawJSVal v
106 return $ unsafeFromRawJSVal v
@@ -69,8 +110,10 @@ foreign import javascript unsafe "$r = $1.val;" js_ticketVal :: FastWeakTicket a
69getFastWeakTicketValue = return . _fastWeakTicket_val
110getFastWeakTicketValue = return . _fastWeakTicket_val
70#endif
111#endif
71
112
113+-- | Get the value referred to by a 'FastWeak' if it hasn't yet been collected,
114+-- or @Nothing@ if it has been collected.
72getFastWeakValue :: FastWeak a -> IO (Maybe a)
115getFastWeakValue :: FastWeak a -> IO (Maybe a)
73−#ifdef ghcjs_HOST_OS
116+#ifdef GHCJS_FAST_WEAK
74getFastWeakValue w = do
117getFastWeakValue w = do
75 r <- js_weakVal w
118 r <- js_weakVal w
76 case js_isNull r of
119 case js_isNull r of
@@ -84,8 +127,11 @@ foreign import javascript unsafe "$r = ($1.ticket === null) ? null : $1.ticket.v
84getFastWeakValue = deRefWeak
127getFastWeakValue = deRefWeak
85#endif
128#endif
86
129
130+-- | Try to create a 'FastWeakTicket' for the given 'FastWeak' which will ensure the value referred
131+-- remains alive. Returns @Just@ if the value hasn't been collected
132+-- and a ticket can therefore be obtained, @Nothing@ if it's been collected.
87getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
133getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
88−#ifdef ghcjs_HOST_OS
134+#ifdef GHCJS_FAST_WEAK
89getFastWeakTicket w = do
135getFastWeakTicket w = do
90 r <- js_weakTicket w
136 r <- js_weakTicket w
91 case js_isNull r of
137 case js_isNull r of
@@ -103,9 +149,22 @@ getFastWeakTicket w = do
103 }
149 }
104#endif
150#endif
105
151
106−-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the associated FastWeak to actually be weak
152+-- | Create a 'FastWeakTicket' directly from a value, creating a 'FastWeak' in the process
153+-- which can be obtained with 'getFastWeakTicketValue'.
154+--
155+-- This function is marked NOINLINE so it is opaque to GHC.
156+-- If we do not do this, then GHC will sometimes fuse the constructor away
157+-- so any weak references that are attached to the ticket will have their
158+-- finalizer run. Using the opaque constructor, GHC does not see the
159+-- constructor application, so it behaves like an IORef and cannot be fused away.
160+--
161+-- The result is also evaluated to WHNF, since forcing a thunk invalidates
162+-- the weak pointer to it in some cases.
163+{-# NOINLINE mkFastWeakTicket #-}
107mkFastWeakTicket :: a -> IO (FastWeakTicket a)
164mkFastWeakTicket :: a -> IO (FastWeakTicket a)
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
109mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
168mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
110
169
111foreign import javascript unsafe "$r = new h$FastWeakTicket($1);" js_fastWeakTicket :: JSVal -> IO (FastWeakTicket a)
170foreign import javascript unsafe "$r = new h$FastWeakTicket($1);" js_fastWeakTicket :: JSVal -> IO (FastWeakTicket a)
@@ -119,11 +178,16 @@ mkFastWeakTicket v = do
119 }
178 }
120#endif
179#endif
121
180
181+-- | Demote a 'FastWeakTicket'; which ensures the value is alive, to a 'FastWeak' which doesn't.
182+-- Note that unless the ticket for the same 'FastWeak' is held in some other way
183+-- the value might be collected immediately.
184+getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
122-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
185-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
123−#ifdef ghcjs_HOST_OS
186+#ifdef GHCJS_FAST_WEAK
124−foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
187+foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak' :: FastWeakTicket a -> IO (FastWeak a)
188+{-# INLINE getFastWeakTicketWeak #-}
189+getFastWeakTicketWeak = getFastWeakTicketWeak'
125#else
190#else
126−getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
127getFastWeakTicketWeak = return . _fastWeakTicket_weak
191getFastWeakTicketWeak = return . _fastWeakTicket_weak
128#endif
192#endif
129
193
@@ -131,9 +195,8 @@ getFastWeakTicketWeak = return . _fastWeakTicket_weak
131emptyFastWeak :: FastWeak a
195emptyFastWeak :: FastWeak a
132emptyFastWeak = unsafeCoerce w
196emptyFastWeak = unsafeCoerce w
133 where w :: FastWeak Any
197 where w :: FastWeak Any
134−#ifdef ghcjs_HOST_OS
198+#ifdef GHCJS_FAST_WEAK
135 w = js_emptyWeak
199 w = js_emptyWeak
136−foreign import javascript unsafe "$r = new h$FastWeak(null);" js_emptyWeak :: FastWeak Any
137#else
200#else
138 w = unsafePerformIO $ do
201 w = unsafePerformIO $ do
139 w' <- mkWeakPtr undefined Nothing
202 w' <- mkWeakPtr undefined Nothing
@@ -141,3 +204,7 @@ foreign import javascript unsafe "$r = new h$FastWeak(null);" js_emptyWeak :: Fa
141 return w'
204 return w'
142#endif
205#endif
143{-# NOINLINE emptyFastWeak #-}
206{-# 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+{-# LANGUAGE CPP #-}
2+#if MIN_VERSION_base(4,9,0)
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE StandaloneDeriving #-}
5+#endif
6+
7+-- |
8+-- Module:
9+-- Reflex.FunctorMaybe
10+-- Description:
1−-- | This module defines the FunctorMaybe class, which extends Functors with the
11+-- This module defines the FunctorMaybe class, which extends Functors with the
2−-- ability to delete values.
12+-- ability to delete values.
3module Reflex.FunctorMaybe
13module Reflex.FunctorMaybe
4 ( FunctorMaybe (..)
14 ( FunctorMaybe (..)
5 ) where
15 ) where
6
16
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
8
23
9--TODO: See if there's a better class in the standard libraries already
24--TODO: See if there's a better class in the standard libraries already
10
25
11-- | A class for values that combines filtering and mapping using 'Maybe'.
26-- | A class for values that combines filtering and mapping using 'Maybe'.
12−-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@. Also similar is the
27+-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@.
13−-- @Witherable@ typeclass, but it requires @Foldable f@ and @Traverable f@,
28+{-# DEPRECATED FunctorMaybe "Use 'Filterable' from Data.Witherable instead" #-}
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@
23class FunctorMaybe f where
29class FunctorMaybe f where
24 -- | Combined mapping and filtering function.
30 -- | Combined mapping and filtering function.
25 fmapMaybe :: (a -> Maybe b) -> f a -> f b
31 fmapMaybe :: (a -> Maybe b) -> f a -> f b
26
32
33+instance FunctorMaybe Maybe where
27−-- | @fmapMaybe f = catMaybes . fmap f@
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
39+
28instance FunctorMaybe [] where
40instance 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 @@
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE GADTs #-}
6{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE RankNTypes #-}
7{-# LANGUAGE RankNTypes #-}
9{-# LANGUAGE RoleAnnotations #-}
8{-# LANGUAGE RoleAnnotations #-}
10{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
@@ -30,38 +29,19 @@ module Reflex.Host.Class
30
29
31import Reflex.Class
30import Reflex.Class
32
31
33−import Control.Applicative
34−import Control.Monad
35import Control.Monad.Fix
32import Control.Monad.Fix
36import Control.Monad.Identity
33import Control.Monad.Identity
37import Control.Monad.Ref
34import Control.Monad.Ref
38import Control.Monad.Trans
35import Control.Monad.Trans
39−import Control.Monad.Trans.Cont (ContT ())
36+import Control.Monad.Trans.Cont (ContT)
40−import Control.Monad.Trans.Except (ExceptT ())
37+import Control.Monad.Trans.Except (ExceptT)
41−import Control.Monad.Trans.Reader (ReaderT ())
38+import Control.Monad.Trans.Reader (ReaderT)
42−import Control.Monad.Trans.RWS (RWST ())
39+import Control.Monad.Trans.RWS (RWST)
43−import Control.Monad.Trans.State (StateT ())
40+import Control.Monad.Trans.State (StateT)
44import qualified Control.Monad.Trans.State.Strict as Strict
41import qualified Control.Monad.Trans.State.Strict as Strict
45−import Control.Monad.Trans.Writer (WriterT ())
42+import Control.Monad.Trans.Writer (WriterT)
46import Data.Dependent.Sum (DSum (..))
43import Data.Dependent.Sum (DSum (..))
47import Data.GADT.Compare
44import 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
65
45
66-- | Framework implementation support class for the reflex implementation
46-- | Framework implementation support class for the reflex implementation
67-- represented by @t@.
47-- 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.
5{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
6{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE LambdaCase #-}
7{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
4+-- |
5+-- Module:
6+-- Reflex.Optimizer
7+-- Description:
8+-- This module provides a GHC plugin designed to improve code that uses
9+-- Reflex. Currently, it just adds an INLINABLE pragma to any top-level
10+-- definition that doesn't have an explicit inlining pragma. In the future,
11+-- additional optimizations are likely to be added.
8module Reflex.Optimizer
12module Reflex.Optimizer
9 ( plugin
13 ( plugin
10 ) where
14 ) where
@@ -16,6 +20,11 @@ import Control.Arrow
16import CoreMonad
20import CoreMonad
17import Data.String
21import Data.String
18import GhcPlugins
22import GhcPlugins
23+
24+#if MIN_VERSION_base(4,9,0)
25+import Prelude hiding ((<>))
26+#endif
27+
19#endif
28#endif
20
29
21#ifdef ghcjs_HOST_OS
30#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
25 ) where
25 ) where
26
26
27import Reflex.Class
27import Reflex.Class
28+import Reflex.Adjustable.Class
28import Reflex.Host.Class
29import Reflex.Host.Class
29import Reflex.PerformEvent.Class
30import Reflex.PerformEvent.Class
30import Reflex.Requester.Base
31import Reflex.Requester.Base
@@ -40,9 +41,9 @@ import Data.Coerce
40import Data.Dependent.Map (DMap)
41import Data.Dependent.Map (DMap)
41import qualified Data.Dependent.Map as DMap
42import qualified Data.Dependent.Map as DMap
42import Data.Dependent.Sum
43import Data.Dependent.Sum
43−import Data.FastMutableIntMap
44import Data.IntMap.Strict (IntMap)
44import Data.IntMap.Strict (IntMap)
45import qualified Data.IntMap.Strict as IntMap
45import qualified Data.IntMap.Strict as IntMap
46+import qualified Data.Semigroup as S
46
47
47-- | A function that fires events for the given 'EventTrigger's and then runs
48-- | A function that fires events for the given 'EventTrigger's and then runs
48-- any followup actions provided via 'PerformEvent'. The given 'ReadPhase'
49-- any followup actions provided via 'PerformEvent'. The given 'ReadPhase'
@@ -60,19 +61,21 @@ deriving instance ReflexHost t => Monad (PerformEventT t m)
60deriving instance ReflexHost t => MonadFix (PerformEventT t m)
61deriving instance ReflexHost t => MonadFix (PerformEventT t m)
61deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
62deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
62deriving instance (ReflexHost t, MonadException (HostFrame t)) => MonadException (PerformEventT t m)
63deriving 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)
63
66
64instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
67instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
65 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
68 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
66 primitive = PerformEventT . lift . primitive
69 primitive = PerformEventT . lift . primitive
67
70
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
69 type Performable (PerformEventT t m) = HostFrame t
72 type Performable (PerformEventT t m) = HostFrame t
70 {-# INLINABLE performEvent_ #-}
73 {-# INLINABLE performEvent_ #-}
71 performEvent_ = PerformEventT . requesting_
74 performEvent_ = PerformEventT . requesting_
72 {-# INLINABLE performEvent #-}
75 {-# INLINABLE performEvent #-}
73 performEvent = PerformEventT . requestingIdentity
76 performEvent = PerformEventT . requestingIdentity
74
77
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
76 runWithReplace outerA0 outerA' = PerformEventT $ runWithReplaceRequesterTWith f (coerce outerA0) (coerceEvent outerA')
79 runWithReplace outerA0 outerA' = PerformEventT $ runWithReplaceRequesterTWith f (coerce outerA0) (coerceEvent outerA')
77 where f :: HostFrame t a -> Event t (HostFrame t b) -> RequesterT t (HostFrame t) Identity (HostFrame t) (a, Event t b)
80 where f :: HostFrame t a -> Event t (HostFrame t b) -> RequesterT t (HostFrame t) Identity (HostFrame t) (a, Event t b)
78 f a0 a' = do
81 f a0 a' = do
@@ -138,7 +141,7 @@ hostPerformEventT a = do
138 case mToPerform of
141 case mToPerform of
139 Nothing -> return [result']
142 Nothing -> return [result']
140 Just toPerform -> do
143 Just toPerform -> do
141− responses <- runHostFrame $ traverseRequesterData (\v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
142 mrt <- readRef responseTrigger
145 mrt <- readRef responseTrigger
143 let followupEventTriggers = case mrt of
146 let followupEventTriggers = case mrt of
144 Just rt -> [rt :=> Identity responses]
147 Just rt -> [rt :=> Identity responses]
@@ -161,6 +164,8 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
161 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
162 {-# INLINABLE headE #-}
165 {-# INLINABLE headE #-}
163 headE = PerformEventT . lift . headE
166 headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
164
169
165instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
166 type Ref (PerformEventT t m) = Ref (HostFrame t)
171 type Ref (PerformEventT t m) = Ref (HostFrame t)
src/Reflex/PerformEvent/Class.hs+6−2
@@ -5,11 +5,9 @@
5{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
14#ifdef USE_REFLEX_OPTIMIZER
12#ifdef USE_REFLEX_OPTIMIZER
15{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
13{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +21,7 @@ import Reflex.Class
23import Reflex.TriggerEvent.Class
21import Reflex.TriggerEvent.Class
24
22
25import Control.Monad.Reader
23import Control.Monad.Reader
24+import Control.Monad.Trans.Maybe (MaybeT (..))
26
25
27-- | 'PerformEvent' represents actions that can trigger other actions based on
26-- | 'PerformEvent' represents actions that can trigger other actions based on
28-- 'Event's.
27-- 'Event's.
@@ -62,3 +61,8 @@ instance PerformEvent t m => PerformEvent t (ReaderT r m) where
62 performEvent e = do
61 performEvent e = do
63 r <- ask
62 r <- ask
64 lift $ performEvent $ flip runReaderT r <$> e
63 lift $ performEvent $ flip runReaderT r <$> e
64+
65+instance PerformEvent t m => PerformEvent t (MaybeT m) where
66+ type Performable (MaybeT m) = MaybeT (Performable m)
67+ performEvent_ = lift . performEvent_ . fmapCheap (void . runMaybeT)
68+ performEvent = lift . fmap (fmapMaybe id) . performEvent . fmapCheap runMaybeT
src/Reflex/PostBuild/Base.hs+15−3
@@ -9,7 +9,6 @@
9{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
10{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE UndecidableInstances #-}
12{-# LANGUAGE UndecidableInstances #-}
14#ifdef USE_REFLEX_OPTIMIZER
13#ifdef USE_REFLEX_OPTIMIZER
15{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
14{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,11 +22,13 @@ module Reflex.PostBuild.Base
23 ) where
22 ) where
24
23
25import Reflex.Class
24import Reflex.Class
25+import Reflex.Adjustable.Class
26import Reflex.Host.Class
26import Reflex.Host.Class
27import Reflex.PerformEvent.Class
27import Reflex.PerformEvent.Class
28import Reflex.PostBuild.Class
28import Reflex.PostBuild.Class
29import Reflex.TriggerEvent.Class
29import Reflex.TriggerEvent.Class
30
30
31+import Control.Applicative (liftA2)
31import Control.Monad.Exception
32import Control.Monad.Exception
32import Control.Monad.Identity
33import Control.Monad.Identity
33import Control.Monad.Primitive
34import Control.Monad.Primitive
@@ -39,6 +40,7 @@ import qualified Data.Dependent.Map as DMap
39import Data.Functor.Compose
40import Data.Functor.Compose
40import Data.IntMap.Strict (IntMap)
41import Data.IntMap.Strict (IntMap)
41import qualified Data.IntMap.Strict as IntMap
42import qualified Data.IntMap.Strict as IntMap
43+import qualified Data.Semigroup as S
42
44
43-- | Provides a basic implementation of 'PostBuild'.
45-- | Provides a basic implementation of 'PostBuild'.
44newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans, MonadException, MonadAsyncException)
46newtype 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
50runPostBuildT :: PostBuildT t m a -> Event t () -> m a
52runPostBuildT :: PostBuildT t m a -> Event t () -> m a
51runPostBuildT (PostBuildT a) = runReaderT a
53runPostBuildT (PostBuildT a) = runReaderT a
52
54
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+
53instance PrimMonad m => PrimMonad (PostBuildT x m) where
63instance PrimMonad m => PrimMonad (PostBuildT x m) where
54 type PrimState (PostBuildT x m) = PrimState m
64 type PrimState (PostBuildT x m) = PrimState m
55 primitive = lift . primitive
65 primitive = lift . primitive
@@ -73,6 +83,8 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
73 buildDynamic a0 = lift . buildDynamic a0
83 buildDynamic a0 = lift . buildDynamic a0
74 {-# INLINABLE headE #-}
84 {-# INLINABLE headE #-}
75 headE = lift . headE
85 headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
76
88
77instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
89instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
78 type Performable (PostBuildT t m) = Performable m
90 type Performable (PostBuildT t m) = Performable m
@@ -107,7 +119,7 @@ instance MonadAtomicRef m => MonadAtomicRef (PostBuildT t m) where
107 {-# INLINABLE atomicModifyRef #-}
119 {-# INLINABLE atomicModifyRef #-}
108 atomicModifyRef r = lift . atomicModifyRef r
120 atomicModifyRef r = lift . atomicModifyRef r
109
121
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
111 runWithReplace a0 a' = do
123 runWithReplace a0 a' = do
112 postBuild <- getPostBuild
124 postBuild <- getPostBuild
113 lift $ do
125 lift $ do
@@ -141,7 +153,7 @@ mapIntMapWithAdjustImpl base f dm0 dm' = do
141 rec (result0, result') <- base f' loweredDm0 loweredDm'
153 rec (result0, result') <- base f' loweredDm0 loweredDm'
142 cohortDone <- numberOccurrencesFrom_ 1 result'
154 cohortDone <- numberOccurrencesFrom_ 1 result'
143 numberedDm' <- numberOccurrencesFrom 1 dm'
155 numberedDm' <- numberOccurrencesFrom 1 dm'
144− let postBuild' = fanInt $ fmapCheap (\n -> IntMap.singleton n ()) cohortDone
156+ let postBuild' = fanInt $ fmapCheap (`IntMap.singleton` ()) cohortDone
145 loweredDm' = flip pushAlways numberedDm' $ \(n, p) -> do
157 loweredDm' = flip pushAlways numberedDm' $ \(n, p) -> do
146 return $ fmap ((,) (selectInt postBuild' n)) p
158 return $ fmap ((,) (selectInt postBuild' n)) p
147 return (result0, result')
159 return (result0, result')
src/Reflex/PostBuild/Class.hs−2
@@ -4,10 +4,8 @@
4{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DataKinds #-}
5{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
11{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
12#ifdef USE_REFLEX_OPTIMIZER
10#ifdef USE_REFLEX_OPTIMIZER
13{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
src/Reflex/Profiled.hs+121−35
@@ -1,4 +1,5 @@
1{-# LANGUAGE EmptyDataDecls #-}
1{-# LANGUAGE EmptyDataDecls #-}
2+{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4{-# LANGUAGE InstanceSigs #-}
5{-# LANGUAGE InstanceSigs #-}
@@ -7,33 +8,56 @@
7{-# LANGUAGE StandaloneDeriving #-}
8{-# LANGUAGE StandaloneDeriving #-}
8{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE UndecidableInstances #-}
10{-# LANGUAGE UndecidableInstances #-}
11+{-# LANGUAGE PolyKinds #-}
12+{-# LANGUAGE TypeApplications #-}
13+{-# LANGUAGE RankNTypes #-}
14+-- |
15+-- Module:
16+-- Reflex.Profiled
17+-- Description:
18+-- This module contains an instance of the 'Reflex' class that provides
19+-- profiling/cost-center information.
10module Reflex.Profiled where
20module Reflex.Profiled where
11
21
12−import Control.Lens hiding (children)
13import Control.Monad
22import Control.Monad
23+import Control.Monad.Exception
14import Control.Monad.Fix
24import Control.Monad.Fix
15import Control.Monad.Primitive
25import Control.Monad.Primitive
16import Control.Monad.Reader
26import Control.Monad.Reader
17import Control.Monad.Ref
27import Control.Monad.Ref
28+import Control.Monad.State.Strict (StateT, execStateT, modify)
29+import Data.Bifunctor
18import Data.Coerce
30import Data.Coerce
19−import Data.Dependent.Map (DMap, GCompare)
31+import Data.Dependent.Map (DMap)
20−import Data.List
32+import Data.GADT.Compare (GCompare)
21import Data.FastMutableIntMap
33import Data.FastMutableIntMap
22import Data.IORef
34import Data.IORef
35+import Data.List
23import Data.Map (Map)
36import Data.Map (Map)
24import qualified Data.Map.Strict as Map
37import qualified Data.Map.Strict as Map
25−import Data.Monoid
38+import Data.Monoid ((<>))
39+import Data.Ord
40+import Data.Profunctor.Unsafe ((#.))
41+import qualified Data.Semigroup as S
26import Data.Type.Coercion
42import Data.Type.Coercion
27import Foreign.Ptr
43import Foreign.Ptr
28import GHC.Foreign
44import GHC.Foreign
29import GHC.IO.Encoding
45import GHC.IO.Encoding
30import GHC.Stack
46import GHC.Stack
47+import Reflex.Adjustable.Class
48+import Reflex.BehaviorWriter.Class
31import Reflex.Class
49import Reflex.Class
32−import Reflex.PerformEvent.Class
50+import Reflex.DynamicWriter.Class
51+import Reflex.EventWriter.Class
33import Reflex.Host.Class
52import 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
34
59
35import System.IO.Unsafe
60import System.IO.Unsafe
36−import Unsafe.Coerce
37
61
38data ProfiledTimeline t
62data ProfiledTimeline t
39
63
@@ -48,9 +72,13 @@ data CostCentreTree = CostCentreTree
48 }
72 }
49 deriving (Show, Eq, Ord)
73 deriving (Show, Eq, Ord)
50
74
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+
51instance Monoid CostCentreTree where
79instance Monoid CostCentreTree where
52 mempty = CostCentreTree 0 0 mempty
80 mempty = CostCentreTree 0 0 mempty
53− CostCentreTree oa ea ca `mappend` CostCentreTree ob eb cb = CostCentreTree (oa + ob) (ea + eb) $ Map.unionWith (<>) ca cb
81+ mappend = (S.<>)
54
82
55getCostCentreStack :: Ptr CostCentreStack -> IO [Ptr CostCentre]
83getCostCentreStack :: Ptr CostCentreStack -> IO [Ptr CostCentre]
56getCostCentreStack = go []
84getCostCentreStack = go []
@@ -62,30 +90,39 @@ getCostCentreStack = go []
62 go (cc : l) parent
90 go (cc : l) parent
63
91
64toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
92toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
65−toCostCentreTree ccs n = do
93+toCostCentreTree ccs n =
66− ccList <- getCostCentreStack ccs
67− return $ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty) ccList
94+ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty)
68−
95+ <$> getCostCentreStack ccs
96+
97+getCostCentreTree :: IO CostCentreTree
98+getCostCentreTree = do
99+ vals <- readIORef profilingData
100+ mconcat <$> mapM (uncurry toCostCentreTree) (Map.toList vals)
101+
69−printCostCentreTree :: CostCentreTree -> IO ()
102+formatCostCentreTree :: CostCentreTree -> IO String
70−printCostCentreTree = go 0
103+formatCostCentreTree cct0 = unlines . reverse <$> execStateT (go 0 cct0) []
104+ where go :: Int -> CostCentreTree -> StateT [String] IO ()
71− where go depth cct = do
105+ go depth cct = do
72− let children = sortOn (_costCentreTree_cumulativeEntries . snd) $ Map.toList $ _costCentreTree_children cct
106+ let children = sortOn (Down . _costCentreTree_cumulativeEntries . snd) $ Map.toList $ _costCentreTree_children cct
73 indent = mconcat $ replicate depth " "
107 indent = mconcat $ replicate depth " "
74 forM_ children $ \(cc, childCct) -> do
108 forM_ children $ \(cc, childCct) -> do
75− lbl <- peekCString utf8 =<< ccLabel cc
109+ lbl <- liftIO $ peekCString utf8 =<< ccLabel cc
76− mdl <- peekCString utf8 =<< ccModule cc
110+ mdl <- liftIO $ peekCString utf8 =<< ccModule cc
77− loc <- peekCString utf8 =<< ccSrcSpan cc
111+ loc <- liftIO $ peekCString utf8 =<< ccSrcSpan cc
78 let description = mdl <> "." <> lbl <> " (" <> loc <> ")"
112 let description = mdl <> "." <> lbl <> " (" <> loc <> ")"
79− putStrLn $ indent <> description <> "\t" <> show (_costCentreTree_cumulativeEntries childCct) <> "\t" <> show (_costCentreTree_ownEntries childCct)
113+ modify $ (:) $ indent <> description <> "\t" <> show (_costCentreTree_cumulativeEntries childCct) <> "\t" <> show (_costCentreTree_ownEntries childCct)
80 go (succ depth) childCct
114 go (succ depth) childCct
81
115
82showProfilingData :: IO ()
116showProfilingData :: IO ()
83showProfilingData = do
117showProfilingData = do
84− vals <- readIORef profilingData
118+ putStr =<< formatCostCentreTree =<< getCostCentreTree
85− cct <- mconcat <$> mapM (uncurry toCostCentreTree) (Map.toList vals)
119+
86− printCostCentreTree cct
120+writeProfilingData :: FilePath -> IO ()
121+writeProfilingData p = do
122+ writeFile p =<< formatCostCentreTree =<< getCostCentreTree
87
123
88−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)
89
126
90profileEvent :: Reflex t => Event t a -> Event t a
127profileEvent :: Reflex t => Event t a -> Event t a
91profileEvent e = unsafePerformIO $ do
128profileEvent e = unsafePerformIO $ do
@@ -109,27 +146,32 @@ instance Reflex t => Reflex (ProfiledTimeline t) where
109 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
146 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
110 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
147 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
111 pull = Behavior_Profiled . pull . coerce
148 pull = Behavior_Profiled . pull . coerce
112− merge :: forall k. GCompare k => DMap k (Event (ProfiledTimeline t)) -> Event (ProfiledTimeline t) (DMap k Identity)
149+ fanG (Event_Profiled e) = EventSelectorG $ coerce $ selectG (fanG $ profileEvent e)
150+ mergeG :: forall z (k :: z -> *) q v. GCompare k
151+ => (forall a. q a -> Event (ProfiledTimeline t) (v a))
113− merge = Event_Profiled . merge . (unsafeCoerce :: DMap k (Event (ProfiledTimeline t)) -> DMap k (Event t))
152+ -> DMap k q -> Event (ProfiledTimeline t) (DMap k v)
114− fan (Event_Profiled e) = EventSelector $ coerce $ select (fan $ profileEvent e)
153+ mergeG nt = Event_Profiled #. mergeG (coerce nt)
115 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
154 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
116 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
155 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
117 current (Dynamic_Profiled d) = coerce $ current d
156 current (Dynamic_Profiled d) = coerce $ current d
118 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
157 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
119 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
158 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
120 unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
159 unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
121− mergeIncremental = Event_Profiled . mergeIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMap k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMap k (Event t)))
160+ mergeIncrementalG nt res = Event_Profiled $ mergeIncrementalG (coerce nt) (coerce res)
122− mergeIncrementalWithMove = Event_Profiled . mergeIncrementalWithMove . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMapWithMove k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMapWithMove k (Event t)))
161+ mergeIncrementalWithMoveG nt res = Event_Profiled $ mergeIncrementalWithMoveG (coerce nt) (coerce res)
123 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
162 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
124 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
163 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
125 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
164 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
126− behaviorCoercion (c :: Coercion a b) = case behaviorCoercion c :: Coercion (Behavior t a) (Behavior t b) of
165+ behaviorCoercion c =
127− Coercion -> unsafeCoerce (Coercion :: Coercion (Behavior (ProfiledTimeline t) a) (Behavior (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
166+ Coercion `trans` behaviorCoercion @t c `trans` Coercion
128− eventCoercion (c :: Coercion a b) = case eventCoercion c :: Coercion (Event t a) (Event t b) of
167+ eventCoercion c =
129− Coercion -> unsafeCoerce (Coercion :: Coercion (Event (ProfiledTimeline t) a) (Event (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
168+ Coercion `trans` eventCoercion @t c `trans` Coercion
169+ dynamicCoercion c =
130− dynamicCoercion (c :: Coercion a b) = case dynamicCoercion c :: Coercion (Dynamic t a) (Dynamic t b) of
170+ Coercion `trans` dynamicCoercion @t c `trans` Coercion
131− Coercion -> unsafeCoerce (Coercion :: Coercion (Dynamic (ProfiledTimeline t) a) (Dynamic (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
171+ incrementalCoercion c d =
172+ Coercion `trans` incrementalCoercion @t c d `trans` Coercion
132− mergeIntIncremental = Event_Profiled . mergeIntIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchIntMap (Event (ProfiledTimeline t) a)) -> Incremental t (PatchIntMap (Event t a)))
173+ mergeIntIncremental = Event_Profiled . mergeIntIncremental .
174+ coerceWith (Coercion `trans` incrementalCoercion Coercion Coercion `trans` Coercion)
133 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
175 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
134
176
135deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
177deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
@@ -142,10 +184,21 @@ instance MonadHold t m => MonadHold (ProfiledTimeline t) (ProfiledM m) where
142 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
184 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
143 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
185 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
144 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
186 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
187+ now = ProfiledM $ Event_Profiled <$> now
145
188
146instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
189instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
147 sample (Behavior_Profiled b) = ProfiledM $ sample b
190 sample (Behavior_Profiled b) = ProfiledM $ sample b
148
191
192+instance Adjustable t m => Adjustable (ProfiledTimeline t) (ProfiledM m) where
193+ runWithReplace a0 a' = (fmap . fmap) coerce . lift $
194+ runWithReplace (coerce a0) (coerce $ coerce <$> a')
195+ traverseIntMapWithKeyWithAdjust f dm0 dm' = (fmap . fmap) coerce . lift $
196+ traverseIntMapWithKeyWithAdjust (\k v -> coerce $ f k v) dm0 (coerce dm')
197+ traverseDMapWithKeyWithAdjust f dm0 dm' = (fmap . fmap) coerce . lift $
198+ traverseDMapWithKeyWithAdjust (\k v -> coerce $ f k v) dm0 (coerce dm')
199+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = (fmap . fmap) coerce . lift $
200+ traverseDMapWithKeyWithAdjustWithMove (\k v -> coerce $ f k v) dm0 (coerce dm')
201+
149instance MonadTrans ProfiledM where
202instance MonadTrans ProfiledM where
150 lift = ProfiledM
203 lift = ProfiledM
151
204
@@ -157,6 +210,39 @@ instance PerformEvent t m => PerformEvent (ProfiledTimeline t) (ProfiledM m) whe
157 performEvent_ = lift . performEvent_ . coerce
210 performEvent_ = lift . performEvent_ . coerce
158 performEvent = lift . fmap coerce . performEvent . coerce
211 performEvent = lift . fmap coerce . performEvent . coerce
159
212
213+instance TriggerEvent t m => TriggerEvent (ProfiledTimeline t) (ProfiledM m) where
214+ newTriggerEvent = first coerce <$> lift newTriggerEvent
215+ newTriggerEventWithOnComplete = first coerce <$> lift newTriggerEventWithOnComplete
216+ newEventWithLazyTriggerWithOnComplete f = coerce <$> lift (newEventWithLazyTriggerWithOnComplete f)
217+
218+instance PostBuild t m => PostBuild (ProfiledTimeline t) (ProfiledM m) where
219+ getPostBuild = coerce <$> lift getPostBuild
220+
221+instance NotReady t m => NotReady (ProfiledTimeline t) (ProfiledM m) where
222+ notReady = lift notReady
223+ notReadyUntil = lift . notReadyUntil . coerce
224+
225+instance BehaviorWriter t w m => BehaviorWriter (ProfiledTimeline t) w (ProfiledM m) where
226+ tellBehavior = lift . tellBehavior . coerce
227+
228+instance DynamicWriter t w m => DynamicWriter (ProfiledTimeline t) w (ProfiledM m) where
229+ tellDyn = lift . tellDyn . coerce
230+
231+instance EventWriter t w m => EventWriter (ProfiledTimeline t) w (ProfiledM m) where
232+ tellEvent = lift . tellEvent . coerce
233+
234+instance MonadQuery t q m => MonadQuery (ProfiledTimeline t) q (ProfiledM m) where
235+ tellQueryIncremental = lift . tellQueryIncremental . coerce
236+ askQueryResult = coerce <$> lift askQueryResult
237+ queryIncremental = fmap coerce . lift . queryIncremental . coerce
238+
239+instance Requester t m => Requester (ProfiledTimeline t) (ProfiledM m) where
240+ type Request (ProfiledM m) = Request m
241+ type Response (ProfiledM m) = Response m
242+
243+ requesting = fmap coerce . lift . requesting . coerce
244+ requesting_ = lift . requesting_ . coerce
245+
160instance MonadRef m => MonadRef (ProfiledM m) where
246instance MonadRef m => MonadRef (ProfiledM m) where
161 type Ref (ProfiledM m) = Ref m
247 type Ref (ProfiledM m) = Ref m
162 newRef = lift . newRef
248 newRef = lift . newRef
src/Reflex/Pure.hs+38−27
@@ -5,6 +5,9 @@
5{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE PolyKinds #-}
10+
8#ifdef USE_REFLEX_OPTIMIZER
11#ifdef USE_REFLEX_OPTIMIZER
9{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
10#endif
13#endif
@@ -13,11 +16,13 @@
13-- * MonadSample (Pure t) ((->) t)
16-- * MonadSample (Pure t) ((->) t)
14-- * MonadHold (Pure t) ((->) t)
17-- * MonadHold (Pure t) ((->) t)
15{-# OPTIONS_GHC -fno-warn-orphans #-}
18{-# OPTIONS_GHC -fno-warn-orphans #-}
16−
19+-- |
20+-- Module: Reflex.Pure
21+-- Description:
17−-- | This module provides a pure implementation of Reflex, which is intended to
22+-- This module provides a pure implementation of Reflex, which is intended to
18−-- serve as a reference for the semantics of the Reflex class. All
23+-- serve as a reference for the semantics of the Reflex class. All
19−-- implementations of Reflex should produce the same results as this
24+-- implementations of Reflex should produce the same results as this
20−-- implementation, although performance and laziness/strictness may differ.
25+-- implementation, although performance and laziness/strictness may differ.
21module Reflex.Pure
26module Reflex.Pure
22 ( Pure
27 ( Pure
23 , Behavior (..)
28 , Behavior (..)
@@ -26,14 +31,10 @@ module Reflex.Pure
26 , Incremental (..)
31 , Incremental (..)
27 ) where
32 ) where
28
33
29−#if !MIN_VERSION_base(4,8,0)
30−import Control.Applicative
31−#endif
32−
33import Control.Monad
34import Control.Monad
34−import Data.Dependent.Map (DMap, GCompare)
35+import Data.Dependent.Map (DMap)
36+import Data.GADT.Compare (GCompare)
35import qualified Data.Dependent.Map as DMap
37import qualified Data.Dependent.Map as DMap
36−import Data.Functor.Identity
37import Data.IntMap (IntMap)
38import Data.IntMap (IntMap)
38import qualified Data.IntMap as IntMap
39import qualified Data.IntMap as IntMap
39import Data.Maybe
40import Data.Maybe
@@ -41,14 +42,15 @@ import Data.MemoTrie
41import Data.Monoid
42import Data.Monoid
42import Data.Type.Coercion
43import Data.Type.Coercion
43import Reflex.Class
44import Reflex.Class
45+import Data.Kind (Type)
44
46
45-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
47-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
46−-- with the type @t@.
48+-- with the type @/t/@.
47−data Pure t
49+data Pure (t :: Type)
48
50
49−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
51+-- | The 'Enum' instance of @/t/@ must be dense: for all @/x :: t/@, there must not exist
50−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
52+-- any @/y :: t/@ such that @/'pred' x < y < x/@. The 'HasTrie' instance will be used
51−-- exclusively to memoize functions of t, not for any of its other capabilities.
53+-- exclusively to memoize functions of @/t/@, not for any of its other capabilities.
52instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
54instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
53
55
54 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
56 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
@@ -77,17 +79,19 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
77 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
79 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
78 -- warning because the GCompare instance is not used; however, removing the
80 -- warning because the GCompare instance is not used; however, removing the
79 -- GCompare instance produces a different warning, due to that constraint
81 -- GCompare instance produces a different warning, due to that constraint
80− -- being present in the original class definition
82+ -- being present in the original class definition.
81
83
82− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
84+ --mergeG :: GCompare k => (forall a. q a -> Event (Pure t) (v a))
85+ -- -> DMap k q -> Event (Pure t) (DMap k v)
83− merge events = Event $ memo $ \t ->
86+ mergeG nt events = Event $ memo $ \t ->
84− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
87+ let currentOccurrences = DMap.mapMaybeWithKey (\_ q -> case nt q of Event a -> a t) events
85 in if DMap.null currentOccurrences
88 in if DMap.null currentOccurrences
86 then Nothing
89 then Nothing
87 else Just currentOccurrences
90 else Just currentOccurrences
88
91
92+-- The instance signature doeesn't compile, leave commented for documentation
89− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
93+-- fanG :: GCompare k => Event (Pure t) (DMap k v) -> EventSelectorG (Pure t) k v
90− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
94+ fanG e = EventSelectorG $ \k -> Event $ \t -> unEvent e t >>= DMap.lookup k
91
95
92 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
96 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
93 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
97 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
@@ -110,8 +114,8 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
110 --a) -> Incremental (Pure t) p a
114 --a) -> Incremental (Pure t) p a
111 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
115 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
112
116
113− mergeIncremental = mergeIncrementalImpl
117+ mergeIncrementalG = mergeIncrementalImpl
114− mergeIncrementalWithMove = mergeIncrementalImpl
118+ mergeIncrementalWithMoveG = mergeIncrementalImpl
115
119
116 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
120 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
117
121
@@ -126,14 +130,17 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
126 behaviorCoercion Coercion = Coercion
130 behaviorCoercion Coercion = Coercion
127 eventCoercion Coercion = Coercion
131 eventCoercion Coercion = Coercion
128 dynamicCoercion Coercion = Coercion
132 dynamicCoercion Coercion = Coercion
133+ incrementalCoercion Coercion Coercion = Coercion
129
134
130 fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
135 fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
131
136
132 mergeIntIncremental = mergeIntIncrementalImpl
137 mergeIntIncremental = mergeIntIncrementalImpl
133
138
134−mergeIncrementalImpl :: (PatchTarget p ~ DMap k (Event (Pure t)), GCompare k) => Incremental (Pure t) p -> Event (Pure t) (DMap k Identity)
139+mergeIncrementalImpl :: (PatchTarget p ~ DMap k q, GCompare k)
140+ => (forall a. q a -> Event (Pure t) (v a))
141+ -> Incremental (Pure t) p -> Event (Pure t) (DMap k v)
135−mergeIncrementalImpl i = Event $ \t ->
142+mergeIncrementalImpl nt i = Event $ \t ->
136− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ unIncremental i t
143+ let results = DMap.mapMaybeWithKey (\_ q -> case nt q of Event e -> e t) $ fst $ unIncremental i t
137 in if DMap.null results
144 in if DMap.null results
138 then Nothing
145 then Nothing
139 else Just results
146 else Just results
@@ -204,3 +211,7 @@ instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
204 Just x -> fromMaybe lastValue $ apply x lastValue
211 Just x -> fromMaybe lastValue $ apply x lastValue
205
212
206 headE = slowHeadE
213 headE = slowHeadE
214+ now t = Event $ guard . (t ==)
215+
216+
217+
src/Reflex/Query/Base.hs+122−51
@@ -1,12 +1,14 @@
1{-# LANGUAGE FlexibleInstances #-}
1{-# LANGUAGE FlexibleInstances #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3{-# LANGUAGE InstanceSigs #-}
3{-# LANGUAGE InstanceSigs #-}
4−{-# LANGUAGE KindSignatures #-}
4+{-# LANGUAGE LambdaCase #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE RankNTypes #-}
6{-# LANGUAGE RankNTypes #-}
7{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
8{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
10+{-# LANGUAGE StandaloneDeriving #-}
11+
10module Reflex.Query.Base
12module Reflex.Query.Base
11 ( QueryT (..)
13 ( QueryT (..)
12 , runQueryT
14 , runQueryT
@@ -14,38 +16,52 @@ module Reflex.Query.Base
14 , mapQueryResult
16 , mapQueryResult
15 , dynWithQueryT
17 , dynWithQueryT
16 , withQueryT
18 , withQueryT
19+ , mapQueryT
17 ) where
20 ) where
18
21
22+import Control.Applicative (liftA2)
19import Control.Monad.Exception
23import Control.Monad.Exception
20import Control.Monad.Fix
24import Control.Monad.Fix
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
21import Control.Monad.Reader
27import Control.Monad.Reader
22import Control.Monad.Ref
28import Control.Monad.Ref
23import Control.Monad.State.Strict
29import Control.Monad.State.Strict
24import Data.Align
30import Data.Align
25−import Data.Dependent.Map (DMap, DSum (..))
31+import Data.Dependent.Map (DMap)
26import qualified Data.Dependent.Map as DMap
32import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
27import Data.Foldable
34import Data.Foldable
28import Data.Functor.Compose
35import Data.Functor.Compose
29import Data.Functor.Misc
36import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
38+import Data.IntMap (IntMap)
39+import qualified Data.IntMap as IntMap
30import Data.Map (Map)
40import Data.Map (Map)
31import qualified Data.Map as Map
41import qualified Data.Map as Map
32−import Data.Monoid
42+import Data.Monoid ((<>))
33−import Data.Some (Some)
34−import qualified Data.Some as Some
43+import qualified Data.Semigroup as S
44+import Data.Some (Some(Some))
35import Data.These
45import Data.These
36
46
37import Reflex.Class
47import 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
39import Reflex.Host.Class
52import Reflex.Host.Class
53+import qualified Data.Patch.MapWithMove as MapWithMove
40import Reflex.PerformEvent.Class
54import Reflex.PerformEvent.Class
41import Reflex.PostBuild.Class
55import Reflex.PostBuild.Class
42import Reflex.Query.Class
56import Reflex.Query.Class
43import Reflex.Requester.Class
57import Reflex.Requester.Class
44import Reflex.TriggerEvent.Class
58import Reflex.TriggerEvent.Class
45−import qualified Reflex.Patch.MapWithMove as MapWithMove
46
59
47newtype QueryT t q m a = QueryT { unQueryT :: StateT [Behavior t q] (EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m)) a }
60newtype 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)
49
65
50runQueryT :: (MonadFix m, Additive q, Group q, Reflex t) => QueryT t q m a -> Dynamic t (QueryResult q) -> m (a, Incremental t (AdditivePatch q))
66runQueryT :: (MonadFix m, Additive q, Group q, Reflex t) => QueryT t q m a -> Dynamic t (QueryResult q) -> m (a, Incremental t (AdditivePatch q))
51runQueryT (QueryT a) qr = do
67runQueryT (QueryT a) qr = do
@@ -60,30 +76,69 @@ getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
60getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
76getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
61getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
77getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
62
78
63−{-
79+maskMempty :: (Eq a, Monoid a) => a -> Maybe a
64−let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
80+maskMempty x = if x == mempty then Nothing else Just x
65− sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
81+
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
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
74 runWithReplace (QueryT a0) a' = do
83 runWithReplace (QueryT a0) a' = do
75 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
84 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
76 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
85 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
77 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
86 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
78 bs' = fmapCheap snd $ r'
87 bs' = fmapCheap snd $ r'
79 bbs <- hold bs0 bs'
88 bbs <- hold bs0 bs'
80− let patches = flip pushAlwaysCheap bs' $ \newBs -> do
89+ let patches = flip pushCheap bs' $ \newBs -> do
81 oldBs <- sample bbs
90 oldBs <- sample bbs
82− (~~) <$> sampleBs newBs <*> sampleBs oldBs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
83 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
92 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
84 QueryT $ lift $ tellEvent patches
93 QueryT $ lift $ tellEvent patches
85 return (r0, fmapCheap fst r')
94 return (r0, fmapCheap fst r')
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+
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'))
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'))
87 traverseDMapWithKeyWithAdjust f dm0 dm' = do
142 traverseDMapWithKeyWithAdjust f dm0 dm' = do
88 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
143 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
89 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
144 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -92,10 +147,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
92 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
147 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
93 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
148 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
94 liftedBs0 :: Map (Some k) [Behavior t q]
149 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
96 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
151 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
97 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
152 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
99 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
154 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
100 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
155 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
101 accumBehaviors :: forall m'. MonadHold t m'
156 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
111 let p k bs = case Map.lookup k bs0 of
166 let p k bs = case Map.lookup k bs0 of
112 Nothing -> case bs of
167 Nothing -> case bs of
113 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
168 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
114− Nothing -> return mempty
169+ Nothing -> return Nothing
115 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
170 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
116− Just newBs -> sampleBs newBs
171+ Just newBs -> maskMempty <$> sampleBs newBs
117 Just oldBs -> case bs of
172 Just oldBs -> case bs of
118 -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
173 -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
119− Nothing -> negateG <$> sampleBs oldBs
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
120 -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
175 -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
121 -- composed with the sampling the child's new state.
176 -- composed with the sampling the child's new state.
122− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
123 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
178 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
124 -- child patches and wrap them in AdditivePatch.
179 -- child patches and wrap them in AdditivePatch.
125− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
180+ patch <- fold <$> Map.traverseWithKey p bs'
126− return (apply pbs bs0, Just patch)
181+ return (apply pbs bs0, AdditivePatch <$> patch)
127 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
182 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
128 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
183 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
129 return (liftedResult0, liftedResult')
184 return (liftedResult0, liftedResult')
185+
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'))
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'))
131 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
187 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
132 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
188 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
133 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
189 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -135,10 +191,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
135 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
191 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
136 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
192 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
137 liftedBs0 :: Map (Some k) [Behavior t q]
193 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
139 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
195 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
140 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
196 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 -}
142 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
198 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
143 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
199 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
144 accumBehaviors' :: forall m'. MonadHold t m'
200 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
155 p k bs = case Map.lookup k bs0 of
211 p k bs = case Map.lookup k bs0 of
156 Nothing -> case MapWithMove._nodeInfo_from bs of
212 Nothing -> case MapWithMove._nodeInfo_from bs of
157 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
213 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
158− MapWithMove.From_Delete -> return mempty
214+ MapWithMove.From_Delete -> return Nothing
159 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
215 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
160− MapWithMove.From_Insert newBs -> sampleBs newBs
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
161 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
217 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
162− Nothing -> return mempty
218+ Nothing -> return Nothing
163− Just newBs -> sampleBs newBs
219+ Just newBs -> maskMempty <$> sampleBs newBs
164 Just oldBs -> case MapWithMove._nodeInfo_from bs of
220 Just oldBs -> case MapWithMove._nodeInfo_from bs of
165 -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
221 -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
166− MapWithMove.From_Delete -> negateG <$> sampleBs oldBs
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
167 -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
223 -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
168 -- composed with the sampling the child's new state.
224 -- 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)
170 MapWithMove.From_Move k'
226 MapWithMove.From_Move k'
171− | k' == k -> return mempty
227+ | k' == k -> return Nothing
172 | otherwise -> case Map.lookup k' bs0 of
228 | otherwise -> case Map.lookup k' bs0 of
173 -- If we are moving from a non-existent key, that is a delete
229 -- If we are moving from a non-existent key, that is a delete
174− Nothing -> negateG <$> sampleBs oldBs
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
175− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
176 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
232 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
177 -- child patches and wrap them in AdditivePatch.
233 -- child patches and wrap them in AdditivePatch.
178− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
234+ patch <- fold <$> Map.traverseWithKey p bs'
179− return (apply pbs bs0, Just patch)
235+ return (apply pbs bs0, AdditivePatch <$> patch)
180 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
236 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
181 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
237 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
182 return (liftedResult0, liftedResult')
238 return (liftedResult0, liftedResult')
@@ -184,6 +240,13 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Mon
184instance MonadTrans (QueryT t q) where
240instance MonadTrans (QueryT t q) where
185 lift = QueryT . lift . lift . lift
241 lift = QueryT . lift . lift . lift
186
242
243+instance MFunctor (QueryT t q) where
244+ hoist = mapQueryT
245+
246+instance PrimMonad m => PrimMonad (QueryT t q m) where
247+ type PrimState (QueryT t q m) = PrimState m
248+ primitive = lift . primitive
249+
187instance PostBuild t m => PostBuild t (QueryT t q m) where
250instance PostBuild t m => PostBuild t (QueryT t q m) where
188 getPostBuild = lift getPostBuild
251 getPostBuild = lift getPostBuild
189
252
@@ -210,11 +273,13 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (QueryT t q
210 newEventWithTrigger = QueryT . newEventWithTrigger
273 newEventWithTrigger = QueryT . newEventWithTrigger
211 newFanEventWithTrigger a = QueryT . lift $ newFanEventWithTrigger a
274 newFanEventWithTrigger a = QueryT . lift $ newFanEventWithTrigger a
212
275
213−mapQuery :: QueryMorphism q q' -> q -> q'
276+-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
214−mapQuery = _queryMorphism_mapQuery
277+instance (Monoid a, Monad m) => Monoid (QueryT t q m a) where
278+ mempty = pure mempty
279+ mappend = (<>)
215
280
216−mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
281+instance (S.Semigroup a, Monad m) => S.Semigroup (QueryT t q m a) where
217−mapQueryResult = _queryMorphism_mapQueryResult
282+ (<>) = liftA2 (S.<>)
218
283
219-- | withQueryT's QueryMorphism argument needs to be a group homomorphism in order to behave correctly
284-- | withQueryT's QueryMorphism argument needs to be a group homomorphism in order to behave correctly
220withQueryT :: (MonadFix m, PostBuild t m, Group q, Group q', Additive q, Additive q', Query q')
285withQueryT :: (MonadFix m, PostBuild t m, Group q, Group q', Additive q, Additive q', Query q')
@@ -229,6 +294,10 @@ withQueryT f a = do
229 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
294 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
230 return result
295 return result
231
296
297+-- | Maps a function over a 'QueryT' that can change the underlying monad
298+mapQueryT :: (forall b. m b -> n b) -> QueryT t q m a -> QueryT t q n a
299+mapQueryT f (QueryT a) = QueryT $ mapStateT (mapEventWriterT (mapReaderT f)) a
300+
232-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
301-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
233dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
302dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
234 => Dynamic t (QueryMorphism q q')
303 => Dynamic t (QueryMorphism q q')
@@ -241,7 +310,7 @@ dynWithQueryT f q = do
241 return result
310 return result
242 where zipDynIncrementalWith g da ib =
311 where zipDynIncrementalWith g da ib =
243 let eab = align (updated da) (updatedIncremental ib)
312 let eab = align (updated da) (updatedIncremental ib)
244− ec = flip push eab $ \o -> case o of
313+ ec = flip push eab $ \case
245 This a -> do
314 This a -> do
246 aOld <- sample $ current da
315 aOld <- sample $ current da
247 b <- sample $ currentIncremental ib
316 b <- sample $ currentIncremental ib
@@ -262,8 +331,7 @@ instance (Monad m, Group q, Additive q, Query q, Reflex t) => MonadQuery t q (Qu
262 askQueryResult = QueryT ask
331 askQueryResult = QueryT ask
263 queryIncremental q = do
332 queryIncremental q = do
264 tellQueryIncremental q
333 tellQueryIncremental q
265− r <- askQueryResult
266− return $ zipDynWith crop (incrementalToDynamic q) r
334+ zipDynWith crop (incrementalToDynamic q) <$> askQueryResult
267
335
268instance Requester t m => Requester t (QueryT t q m) where
336instance Requester t m => Requester t (QueryT t q m) where
269 type Request (QueryT t q m) = Request m
337 type Request (QueryT t q m) = Request m
@@ -273,3 +341,6 @@ instance Requester t m => Requester t (QueryT t q m) where
273
341
274instance EventWriter t w m => EventWriter t w (QueryT t q m) where
342instance EventWriter t w m => EventWriter t w (QueryT t q m) where
275 tellEvent = lift . tellEvent
343 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 #-}
1{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE UndecidableInstances #-}
8{-# LANGUAGE UndecidableInstances #-}
9+-- |
10+-- Module:
11+-- Reflex.Query.Class
12+-- Description:
13+-- A class that ties together queries to some data source and their results,
14+-- providing methods for requesting data from the source and accumulating
15+-- streamed results.
9module Reflex.Query.Class
16module Reflex.Query.Class
10 ( Query (..)
17 ( Query (..)
11 , QueryMorphism (..)
18 , QueryMorphism (..)
@@ -15,29 +22,94 @@ module Reflex.Query.Class
15 , MonadQuery (..)
22 , MonadQuery (..)
16 , tellQueryDyn
23 , tellQueryDyn
17 , queryDyn
24 , queryDyn
25+ , subQuery
26+ , mapQuery
27+ , mapQueryResult
18 ) where
28 ) where
19
29
30+import Control.Category (Category)
31+import qualified Control.Category as Cat
20import Control.Monad.Reader
32import Control.Monad.Reader
21import Data.Bits
33import Data.Bits
22import Data.Data
34import Data.Data
23import Data.Ix
35import 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(..))
25import Foreign.Storable
39import Foreign.Storable
40+import Data.Void
41+import Data.Monoid hiding ((<>))
42+import Control.Applicative
26
43
27import Reflex.Class
44import Reflex.Class
28
45
46+-- | A 'Query' can be thought of as a declaration of interest in some set of data.
47+-- A 'QueryResult' is the set of data associated with that interest set.
48+-- The @crop@ function provides a way to determine what part of a given 'QueryResult'
49+-- is relevant to a given 'Query'.
29class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
50class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
30 type QueryResult a :: *
51 type QueryResult a :: *
31 crop :: a -> QueryResult a -> QueryResult a
52 crop :: a -> QueryResult a -> QueryResult a
32
53
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+
33−-- | NB: QueryMorphism's must be group homomorphisms when acting on the query type
89+-- | QueryMorphism's must be group homomorphisms when acting on the query type
34−-- and compatible with the query relationship when acting on the query result
90+-- and compatible with the query relationship when acting on the query result.
35data QueryMorphism q q' = QueryMorphism
91data QueryMorphism q q' = QueryMorphism
36 { _queryMorphism_mapQuery :: q -> q'
92 { _queryMorphism_mapQuery :: q -> q'
37 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
93 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
38 }
94 }
39
95
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'
41newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
113newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
42 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
114 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
43
115
@@ -53,25 +125,34 @@ instance Group SelectedCount where
53
125
54instance Additive SelectedCount
126instance Additive SelectedCount
55
127
128+-- | The Semigroup\/Monoid\/Group instances for a Query containing 'SelectedCount's should use
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.
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.
57combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
131combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
58combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
132combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
59
133
134+-- | A class that allows sending of 'Query's and retrieval of 'QueryResult's. See 'queryDyn' for a commonly
135+-- used interface.
60−class (Group q, Additive q, Query q) => MonadQuery t q m | m -> q t where
136+class (Group q, Additive q, Query q, Monad m) => MonadQuery t q m | m -> q t where
61 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
137 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
62 askQueryResult :: m (Dynamic t (QueryResult q))
138 askQueryResult :: m (Dynamic t (QueryResult q))
63 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
139 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
64
140
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
66 tellQueryIncremental = lift . tellQueryIncremental
142 tellQueryIncremental = lift . tellQueryIncremental
67 askQueryResult = lift askQueryResult
143 askQueryResult = lift askQueryResult
68 queryIncremental = lift . queryIncremental
144 queryIncremental = lift . queryIncremental
69
145
146+-- | Produce and send an 'Incremental' 'Query' from a 'Dynamic' 'Query'.
70tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
147tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
71tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
148tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
72
149
150+-- | Retrieve 'Dynamic'ally updating 'QueryResult's for a 'Dynamic'ally updating 'Query'.
73−queryDyn :: (Reflex t, Monad m, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
151+queryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
74queryDyn q = do
152queryDyn q = do
75 tellQueryDyn q
153 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 @@
1-- | This module provides 'RequesterT', the standard implementation of
1-- | This module provides 'RequesterT', the standard implementation of
2-- 'Requester'.
2-- 'Requester'.
3{-# LANGUAGE AllowAmbiguousTypes #-}
3{-# LANGUAGE AllowAmbiguousTypes #-}
4−{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE ApplicativeDo #-}
5{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
6{-# LANGUAGE EmptyDataDecls #-}
6{-# LANGUAGE EmptyDataDecls #-}
7{-# LANGUAGE ExistentialQuantification #-}
7{-# LANGUAGE ExistentialQuantification #-}
@@ -22,17 +22,25 @@
22module Reflex.Requester.Base
22module Reflex.Requester.Base
23 ( RequesterT (..)
23 ( RequesterT (..)
24 , runRequesterT
24 , runRequesterT
25+ , withRequesterT
25 , runWithReplaceRequesterTWith
26 , runWithReplaceRequesterTWith
26 , traverseIntMapWithKeyWithAdjustRequesterTWith
27 , traverseIntMapWithKeyWithAdjustRequesterTWith
27 , traverseDMapWithKeyWithAdjustRequesterTWith
28 , traverseDMapWithKeyWithAdjustRequesterTWith
28 , RequesterData
29 , RequesterData
29 , RequesterDataKey
30 , RequesterDataKey
30 , traverseRequesterData
31 , traverseRequesterData
32+ , forRequesterData
31 , requesterDataToList
33 , requesterDataToList
32 , singletonRequesterData
34 , singletonRequesterData
35+ , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
37+ , multiEntry
38+ , unMultiEntry
39+ , requesting'
33 ) where
40 ) where
34
41
35import Reflex.Class
42import Reflex.Class
43+import Reflex.Adjustable.Class
36import Reflex.Dynamic
44import Reflex.Dynamic
37import Reflex.Host.Class
45import Reflex.Host.Class
38import Reflex.PerformEvent.Class
46import Reflex.PerformEvent.Class
@@ -40,17 +48,20 @@ import Reflex.PostBuild.Class
40import Reflex.Requester.Class
48import Reflex.Requester.Class
41import Reflex.TriggerEvent.Class
49import Reflex.TriggerEvent.Class
42
50
51+import Control.Applicative (liftA2)
43import Control.Monad.Exception
52import Control.Monad.Exception
44import Control.Monad.Identity
53import Control.Monad.Identity
54+import Control.Monad.Morph
55+import Control.Monad.Primitive
45import Control.Monad.Reader
56import Control.Monad.Reader
46import Control.Monad.Ref
57import Control.Monad.Ref
47import Control.Monad.State.Strict
58import Control.Monad.State.Strict
48import Data.Bits
59import Data.Bits
49import Data.Coerce
60import Data.Coerce
61+import Data.Constraint
50−import Data.Dependent.Map (DMap, DSum (..))
62+import Data.Dependent.Map (DMap)
51import qualified Data.Dependent.Map as DMap
63import qualified Data.Dependent.Map as DMap
52−import qualified Data.Some as Some
64+import Data.Dependent.Sum (DSum (..))
53−import Data.FastMutableIntMap
54import Data.Functor.Compose
65import Data.Functor.Compose
55import Data.Functor.Misc
66import Data.Functor.Misc
56import Data.IntMap.Strict (IntMap)
67import Data.IntMap.Strict (IntMap)
@@ -58,10 +69,11 @@ import qualified Data.IntMap.Strict as IntMap
58import Data.Map (Map)
69import Data.Map (Map)
59import qualified Data.Map as Map
70import qualified Data.Map as Map
60import Data.Monoid ((<>))
71import Data.Monoid ((<>))
61−import Data.Unique.Tag
62−import Data.Some (Some)
63−import Data.Type.Equality
64import Data.Proxy
72import 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
65
77
66import GHC.Exts (Any)
78import GHC.Exts (Any)
67import Unsafe.Coerce
79import Unsafe.Coerce
@@ -72,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
72
84
73newtype RequesterData f = RequesterData (TagMap (Entry f))
85newtype RequesterData f = RequesterData (TagMap (Entry f))
74
86
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
75data RequesterDataKey a where
90data RequesterDataKey a where
76 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
91 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
77 RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
92 RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
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
79 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
94 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
80
95
81singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
96singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
82singletonRequesterData rdk v = case rdk of
97singletonRequesterData rdk v = case rdk of
83 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
98 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
84 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
99 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
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+ }
86 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
87
105
106+mergeRequesterData :: RequesterData f -> RequesterData f -> RequesterData f
107+mergeRequesterData (RequesterData a) (RequesterData b) = RequesterData $ mergeTagMap a b
108+
109+mergeTagMap :: forall f. TagMap (Entry f) -> TagMap (Entry f) -> TagMap (Entry f)
110+mergeTagMap (TagMap m) (TagMap n) =
111+ TagMap $ IntMap.unionWithKey (g' combiner) m n
112+ where
113+ combiner :: forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a
114+ combiner k (Entry a) (Entry b) = Entry $ case myKeyType k of
115+ MyTagType_Single -> a
116+ MyTagType_Multi -> IntMap.unionWith mergeRequesterData a b
117+ MyTagType_Multi2 -> case _multi2Contents_dict a of
118+ Dict -> Multi2Contents
119+ { _multi2Contents_values = Map.unionWith (IntMap.unionWith mergeRequesterData) (_multi2Contents_values a) (_multi2Contents_values b)
120+ , _multi2Contents_dict = Dict
121+ }
122+ MyTagType_Multi3 -> IntMap.unionWith (IntMap.unionWith mergeRequesterData) a b
123+ g' :: (forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a) -> Int -> Any -> Any -> Any
124+ g' f rawKey a b =
125+ let k = MyTag rawKey :: MyTag a
126+ fromAny :: Any -> Entry f a
127+ fromAny = unsafeCoerce
128+ toAny :: Entry f a -> Any
129+ toAny = unsafeCoerce
130+ in toAny $ f k (fromAny a) (fromAny b)
131+
88requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
89requesterDataToList (RequesterData m) = do
133requesterDataToList (RequesterData m) = do
90 k :=> Entry e <- tagMapToList m
134 k :=> Entry e <- tagMapToList m
@@ -94,11 +138,12 @@ requesterDataToList (RequesterData m) = do
94 (k', e') <- IntMap.toList e
138 (k', e') <- IntMap.toList e
95 k'' :=> e'' <- requesterDataToList e'
139 k'' :=> e'' <- requesterDataToList e'
96 return $ RequesterDataKey_Multi k k' k'' :=> e''
140 return $ RequesterDataKey_Multi k k' k'' :=> e''
97− MyTagType_Multi2 -> do
141+ MyTagType_Multi2 -> case _multi2Contents_dict e of
142+ Dict -> do
98− (k', e') <- Map.toList e
143+ (k', e') <- Map.toList $ _multi2Contents_values e
99− (k'', e'') <- IntMap.toList e'
144+ (k'', e'') <- IntMap.toList e'
100− k''' :=> e''' <- requesterDataToList e''
145+ k''' :=> e''' <- requesterDataToList e''
101− return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
146+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
102 MyTagType_Multi3 -> do
147 MyTagType_Multi3 -> do
103 (k', e') <- IntMap.toList e
148 (k', e') <- IntMap.toList e
104 (k'', e'') <- IntMap.toList e'
149 (k'', e'') <- IntMap.toList e'
@@ -109,9 +154,9 @@ singletonTagMap :: forall f a. MyTag a -> f a -> TagMap f
109singletonTagMap (MyTag k) v = TagMap $ IntMap.singleton k $ (unsafeCoerce :: f a -> Any) v
154singletonTagMap (MyTag k) v = TagMap $ IntMap.singleton k $ (unsafeCoerce :: f a -> Any) v
110
155
111tagMapToList :: forall f. TagMap f -> [DSum MyTag f]
156tagMapToList :: forall f. TagMap f -> [DSum MyTag f]
112−tagMapToList (TagMap m) = fmap f $ IntMap.toList m
157+tagMapToList (TagMap m) = f <$> IntMap.toList m
113 where f :: (Int, Any) -> DSum MyTag f
158 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
115
160
116traverseTagMapWithKey :: forall t f g. Applicative t => (forall a. MyTag a -> f a -> t (g a)) -> TagMap f -> t (TagMap g)
161traverseTagMapWithKey :: forall t f g. Applicative t => (forall a. MyTag a -> f a -> t (g a)) -> TagMap f -> t (TagMap g)
117traverseTagMapWithKey f (TagMap m) = TagMap <$> IntMap.traverseWithKey g m
162traverseTagMapWithKey f (TagMap m) = TagMap <$> IntMap.traverseWithKey g m
@@ -126,9 +171,19 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
126 go k (Entry request) = Entry <$> case myKeyType k of
171 go k (Entry request) = Entry <$> case myKeyType k of
127 MyTagType_Single -> f request
172 MyTagType_Single -> f request
128 MyTagType_Multi -> traverse (traverseRequesterData f) request
173 MyTagType_Multi -> traverse (traverseRequesterData f) request
174+ MyTagType_Multi2 -> case request of
175+ Multi2Contents { _multi2Contents_values = request', _multi2Contents_dict = Dict } -> do
129− MyTagType_Multi2 -> traverse (traverse (traverseRequesterData f)) request
176+ v <- traverse (traverse (traverseRequesterData f)) request'
177+ pure $ Multi2Contents
178+ { _multi2Contents_values = v
179+ , _multi2Contents_dict = Dict
180+ }
130 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
131
182
183+-- | 'traverseRequesterData' with its arguments flipped
184+forRequesterData :: forall request response m. Applicative m => RequesterData request -> (forall a. request a -> m (response a)) -> m (RequesterData response)
185+forRequesterData r f = traverseRequesterData f r
186+
132data MyTagType :: * -> * where
187data MyTagType :: * -> * where
133 MyTagType_Single :: MyTagType (Single a)
188 MyTagType_Single :: MyTagType (Single a)
134 MyTagType_Multi :: MyTagType Multi
189 MyTagType_Multi :: MyTagType Multi
@@ -166,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
166type family EntryContents request a where
221type family EntryContents request a where
167 EntryContents request (Single a) = request a
222 EntryContents request (Single a) = request a
168 EntryContents request Multi = IntMap (RequesterData request)
223 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
170 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
171
226
227+data Multi2Contents k request = Multi2Contents
228+ { _multi2Contents_dict :: {-# UNPACK #-} !(Dict (GCompare k)) -- This is a Dict instead of an existential context because we only want to use it in certain circumstances
229+ , _multi2Contents_values :: {-# UNPACK #-} !(Map (Some k) (IntMap (RequesterData request)))
230+ }
231+
172newtype Entry request x = Entry { unEntry :: EntryContents request x }
232newtype Entry request x = Entry { unEntry :: EntryContents request x }
173
233
174{-# INLINE singleEntry #-}
234{-# INLINE singleEntry #-}
@@ -238,11 +298,23 @@ deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
238deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
239deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
240
300
301+instance PrimMonad m => PrimMonad (RequesterT t request response m) where
302+ type PrimState (RequesterT t request response m) = PrimState m
303+ primitive = lift . primitive
304+
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+
241-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
314-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
242-- requests are made, and responses should be provided in the input 'Event'.
315-- requests are made, and responses should be provided in the input 'Event'.
243-- The 'Tag' keys will be used to return the responses to the same place the
316-- The 'Tag' keys will be used to return the responses to the same place the
244-- requests were issued.
317-- requests were issued.
245−
246runRequesterT :: (Reflex t, Monad m)
318runRequesterT :: (Reflex t, Monad m)
247 => RequesterT t request response m a
319 => RequesterT t request response m a
248 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
320 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
@@ -252,6 +324,20 @@ runRequesterT (RequesterT a) responses = do
252 coerceEvent responses
324 coerceEvent responses
253 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
325 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
254
326
327+-- | Map a function over the request and response of a 'RequesterT'
328+withRequesterT
329+ :: (Reflex t, MonadFix m)
330+ => (forall x. req x -> req' x) -- ^ The function to map over the request
331+ -> (forall x. rsp' x -> rsp x) -- ^ The function to map over the response
332+ -> RequesterT t req rsp m a -- ^ The internal 'RequesterT' whose input and output will be transformed
333+ -> RequesterT t req' rsp' m a -- ^ The resulting 'RequesterT'
334+withRequesterT freq frsp child = do
335+ rec let rsp = fmap (runIdentity . traverseRequesterData (Identity . frsp)) rsp'
336+ (a, req) <- lift $ runRequesterT child rsp
337+ rsp' <- fmap (flip selectInt 0 . fanInt . fmapCheap unMultiEntry) $ requesting' $
338+ fmapCheap (multiEntry . IntMap.singleton 0) $ fmap (runIdentity . traverseRequesterData (Identity . freq)) req
339+ return a
340+
255instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
341instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
256 type Request (RequesterT t request response m) = request
342 type Request (RequesterT t request response m) = request
257 type Response (RequesterT t request response m) = response
343 type Response (RequesterT t request response m) = response
@@ -271,7 +357,7 @@ tagRequest req = do
271 return t
357 return t
272
358
273{-# INLINE responseFromTag #-}
359{-# 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))
275responseFromTag (MyTagWrap t) = do
361responseFromTag (MyTagWrap t) = do
276 responses :: EventSelectorInt t Any <- RequesterT ask
362 responses :: EventSelectorInt t Any <- RequesterT ask
277 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -279,6 +365,9 @@ responseFromTag (MyTagWrap t) = do
279instance MonadTrans (RequesterT t request response) where
365instance MonadTrans (RequesterT t request response) where
280 lift = RequesterT . lift . lift
366 lift = RequesterT . lift . lift
281
367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
282instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
283 type Performable (RequesterT t request response m) = Performable m
372 type Performable (RequesterT t request response m) = Performable m
284 performEvent_ = lift . performEvent_
373 performEvent_ = lift . performEvent_
@@ -299,14 +388,14 @@ instance MonadReader r m => MonadReader r (RequesterT t request response m) wher
299 local f (RequesterT a) = RequesterT $ mapStateT (mapReaderT $ local f) a
388 local f (RequesterT a) = RequesterT $ mapStateT (mapReaderT $ local f) a
300 reader = lift . reader
389 reader = lift . reader
301
390
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
303 runWithReplace = runWithReplaceRequesterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
392 runWithReplace = runWithReplaceRequesterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
304 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElementsMap mergeIntIncremental
393 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElementsMap mergeIntIncremental
305 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
394 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
306 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
395 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
307 traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
396 traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
308
397
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))
310requesting' = responseFromTag . castMyTagWrap <=< tagRequest
399requesting' = responseFromTag . castMyTagWrap <=< tagRequest
311
400
312{-# INLINABLE runWithReplaceRequesterTWith #-}
401{-# INLINABLE runWithReplaceRequesterTWith #-}
@@ -355,10 +444,10 @@ traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIn
355 pack = Entry
444 pack = Entry
356 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
445 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
357 f' k (n, v) = do
446 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?
359 return (fmapCheap (IntMap.singleton n) myRequests, result)
448 return (fmapCheap (IntMap.singleton n) myRequests, result)
360 ndm' <- numberOccurrencesFrom 1 dm'
449 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
362 let result0 = fmap snd children0
451 let result0 = fmap snd children0
363 result' = fforCheap children' $ fmap snd
452 result' = fforCheap children' $ fmap snd
364 requests0 :: IntMap (Event t (IntMap (RequesterData request)))
453 requests0 :: IntMap (Event t (IntMap (RequesterData request)))
@@ -398,12 +487,12 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
398 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
399 responses = fanMap $ fmapCheap unpack response
488 responses = fanMap $ fmapCheap unpack response
400 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
401− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
402 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
491 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 }
404 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
405 f' k (Compose (n, v)) = do
494 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))
407 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
496 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
408 ndm' <- numberOccurrencesFrom 1 dm'
497 ndm' <- numberOccurrencesFrom 1 dm'
409 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
498 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
@@ -417,3 +506,102 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
417 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
506 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
418 requests <- holdIncremental requests0 requests'
507 requests <- holdIncremental requests0 requests'
419 return (result0, result')
508 return (result0, result')
509+
510+data Decoder rawResponse response =
511+ forall a. Decoder (RequesterDataKey a) (rawResponse -> response a)
512+
513+matchResponsesWithRequests
514+ :: forall t rawRequest rawResponse request response m.
515+ ( MonadFix m
516+ , MonadHold t m
517+ , Reflex t
518+ )
519+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
520+ -- ^ Given a request (from 'Requester'), produces the wire format of the
521+ -- request and a function used to process the associated response
522+ -> Event t (RequesterData request)
523+ -- ^ The outgoing requests
524+ -> Event t (Int, rawResponse)
525+ -- ^ The incoming responses, tagged by an identifying key
526+ -> m ( Event t (Map Int rawRequest)
527+ , Event t (RequesterData response)
528+ )
529+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
530+ -- by the 'RequesterData' key of the associated outgoing request
531+matchResponsesWithRequests f send recv = matchResponseMapWithRequests f send $ uncurry Map.singleton <$> recv
532+
533+-- | Matches incoming responses with previously-sent requests
534+-- and uses the provided request "decoder" function to process
535+-- incoming responses.
536+matchResponseMapWithRequests
537+ :: forall t rawRequest rawResponse request response m.
538+ ( MonadFix m
539+ , MonadHold t m
540+ , Reflex t
541+ )
542+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
543+ -- ^ Given a request (from 'Requester'), produces the wire format of the
544+ -- request and a function used to process the associated response
545+ -> Event t (RequesterData request)
546+ -- ^ The outgoing requests
547+ -> Event t (Map Int rawResponse)
548+ -- ^ A map of incoming responses, tagged by an identifying key
549+ -> m ( Event t (Map Int rawRequest)
550+ , Event t (RequesterData response)
551+ )
552+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
553+ -- by the 'RequesterData' key of the associated outgoing request
554+matchResponseMapWithRequests f send recv = do
555+ rec nextId <- hold 1 $ fmap (\(next, _, _) -> next) outgoing
556+ waitingFor :: Incremental t (PatchMap Int (Decoder rawResponse response)) <-
557+ holdIncremental mempty $ leftmost
558+ [ fmap (\(_, outstanding, _) -> outstanding) outgoing
559+ , snd <$> incoming
560+ ]
561+ let outgoing = processOutgoing nextId send
562+ incoming = processIncoming waitingFor recv
563+ return (fmap (\(_, _, rawReqs) -> rawReqs) outgoing, fst <$> incoming)
564+ where
565+ -- Tags each outgoing request with an identifying integer key
566+ -- and returns the next available key, a map of response decoders
567+ -- for requests for which there are outstanding responses, and the
568+ -- raw requests to be sent out.
569+ processOutgoing
570+ :: Behavior t Int
571+ -- The next available key
572+ -> Event t (RequesterData request)
573+ -- The outgoing request
574+ -> Event t ( Int
575+ , PatchMap Int (Decoder rawResponse response)
576+ , Map Int rawRequest )
577+ -- The new next-available-key, a map of requests expecting responses, and the tagged raw requests
578+ processOutgoing nextId out = flip pushAlways out $ \dm -> do
579+ oldNextId <- sample nextId
580+ let (result, newNextId) = flip runState oldNextId $ forM (requesterDataToList dm) $ \(k :=> v) -> do
581+ n <- get
582+ put $ succ n
583+ let (rawReq, rspF) = f v
584+ return (n, rawReq, Decoder k rspF)
585+ patchWaitingFor = PatchMap $ Map.fromList $
586+ (\(n, _, dec) -> (n, Just dec)) <$> result
587+ toSend = Map.fromList $ (\(n, rawReq, _) -> (n, rawReq)) <$> result
588+ return (newNextId, patchWaitingFor, toSend)
589+ -- Looks up the each incoming raw response in a map of response
590+ -- decoders and returns the decoded response and a patch that can
591+ -- be used to clear the ID of the consumed response out of the queue
592+ -- of expected responses.
593+ processIncoming
594+ :: Incremental t (PatchMap Int (Decoder rawResponse response))
595+ -- A map of outstanding expected responses
596+ -> Event t (Map Int rawResponse)
597+ -- A incoming response paired with its identifying key
598+ -> Event t (RequesterData response, PatchMap Int v)
599+ -- The decoded response and a patch that clears the outstanding responses queue
600+ processIncoming waitingFor inc = flip push inc $ \rspMap -> do
601+ wf <- sample $ currentIncremental waitingFor
602+ let match rawRsp (Decoder k rspF) =
603+ let rsp = rspF rawRsp
604+ in singletonRequesterData k rsp
605+ matches = Map.intersectionWith match rspMap wf
606+ pure $ if Map.null matches then Nothing else Just
607+ (Map.foldl' mergeRequesterData emptyRequesterData matches, PatchMap $ Nothing <$ matches)
src/Reflex/Requester/Class.hs−1
@@ -6,7 +6,6 @@
6{-# LANGUAGE CPP #-}
6{-# LANGUAGE CPP #-}
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE TypeFamilies #-}
12{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
src/Reflex/Spider.hs+5−7
@@ -1,22 +1,20 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2+-- |
3+-- Module:
4+-- Reflex.Spider
5+-- Description:
2−-- | This module exports all of the user-facing functionality of the 'Spider'
6+-- This module exports all of the user-facing functionality of the 'Spider' 'Reflex' engine
3−-- 'Reflex' engine
4module Reflex.Spider
7module Reflex.Spider
5 ( Spider
8 ( Spider
6 , SpiderTimeline
9 , SpiderTimeline
7 , Global
10 , Global
8 , SpiderHost
11 , SpiderHost
9 , runSpiderHost
12 , runSpiderHost
10−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
11 , runSpiderHostForTimeline
13 , runSpiderHostForTimeline
12 , newSpiderTimeline
14 , newSpiderTimeline
13 , withSpiderTimeline
15 , withSpiderTimeline
14−#endif
15 -- * Deprecated
16 -- * Deprecated
16 , SpiderEnv
17 , SpiderEnv
17 ) where
18 ) where
18
19
19−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
20−import Reflex.Class
21−#endif
22import Reflex.Spider.Internal
20import Reflex.Spider.Internal
src/Reflex/Spider/Internal.hs+977−506
@@ -9,40 +9,49 @@
9{-# LANGUAGE GADTs #-}
9{-# LANGUAGE GADTs #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11{-# LANGUAGE LambdaCase #-}
11{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
15{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
16{-# LANGUAGE RoleAnnotations #-}
13{-# LANGUAGE RoleAnnotations #-}
17{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE ScopedTypeVariables #-}
18{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeFamilies #-}
19{-# LANGUAGE TypeOperators #-}
16{-# LANGUAGE TypeOperators #-}
20{-# LANGUAGE UndecidableInstances #-}
17{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
21#ifdef USE_REFLEX_OPTIMIZER
24#ifdef USE_REFLEX_OPTIMIZER
22{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
25{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
23#endif
26#endif
24−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
25−{-# OPTIONS_GHC -fno-warn-orphans #-}
27+{-# OPTIONS_GHC -Wunused-binds #-}
26−#endif
27-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
28-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
28-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
29-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
29module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
30module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
30
31
32+#if MIN_VERSION_base(4,10,0)
31−import Control.Applicative
33+import Control.Applicative (liftA2)
34+#endif
32import Control.Concurrent
35import Control.Concurrent
33import Control.Exception
36import Control.Exception
34−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
37+import Control.Monad hiding (forM, forM_, mapM, mapM_)
35import Control.Monad.Exception
38import Control.Monad.Exception
36−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
39+import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
37import Control.Monad.Primitive
40import 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
39import Control.Monad.Ref
44import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
40import Data.Align
47import Data.Align
41import Data.Coerce
48import Data.Coerce
42−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
43import qualified Data.Dependent.Map as DMap
50import 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
44import Data.Foldable hiding (concat, elem, sequence_)
54import Data.Foldable hiding (concat, elem, sequence_)
45−import Data.Function
46import Data.Functor.Constant
55import Data.Functor.Constant
47import Data.Functor.Misc
56import Data.Functor.Misc
48import Data.Functor.Product
57import Data.Functor.Product
@@ -50,62 +59,73 @@ import Data.GADT.Compare
50import Data.IntMap.Strict (IntMap)
59import Data.IntMap.Strict (IntMap)
51import qualified Data.IntMap.Strict as IntMap
60import qualified Data.IntMap.Strict as IntMap
52import Data.IORef
61import Data.IORef
53−import Data.List hiding (foldl')
62+import Data.Kind (Type)
54−import Data.Maybe
63+import Data.Maybe hiding (mapMaybe)
55−import Data.Monoid ((<>))
64+import Data.Monoid (mempty, (<>))
56import Data.Proxy
65import Data.Proxy
57import Data.These
66import Data.These
58import Data.Traversable
67import Data.Traversable
59−import Data.Word
68+import Data.Type.Equality ((:~:)(Refl))
60−import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
69+import Data.Witherable (Filterable, mapMaybe)
61−import qualified Data.FastMutableIntMap as FastMutableIntMap
62−import GHC.Exts
70+import GHC.Exts hiding (toList)
63import GHC.IORef (IORef (..))
71import GHC.IORef (IORef (..))
64import GHC.Stack
72import GHC.Stack
65import Reflex.FastWeak
73import Reflex.FastWeak
66−import Reflex.FunctorMaybe
67import System.IO.Unsafe
74import System.IO.Unsafe
68import System.Mem.Weak
75import System.Mem.Weak
69import Unsafe.Coerce
76import Unsafe.Coerce
70
77
78+#ifdef MIN_VERSION_semialign
79+#if MIN_VERSION_these(0,8,0)
80+import Data.These.Combinators (justThese)
81+#endif
82+#if MIN_VERSION_semialign(1,1,0)
83+import Data.Zip (Zip (..))
84+#endif
85+#endif
86+
71#ifdef DEBUG_CYCLES
87#ifdef DEBUG_CYCLES
72import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
88import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
73import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
91import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
74import qualified Data.List.NonEmpty as NonEmpty
92import qualified Data.List.NonEmpty as NonEmpty
75−import Data.Monoid (mempty)
76import Data.Tree (Forest, Tree (..), drawForest)
93import Data.Tree (Forest, Tree (..), drawForest)
77−#endif
94+import Data.List (isPrefixOf)
78
95
79−import Data.FastWeakBag (FastWeakBag)
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
80import qualified Data.FastWeakBag as FastWeakBag
97import qualified Data.FastWeakBag as FastWeakBag
81−import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
98+
82−import qualified Data.WeakBag as WeakBag
83−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
84import Data.Reflection
99import Data.Reflection
85−import Data.Some (Some)
100+import Data.Some (Some(Some))
86−import qualified Data.Some as Some
87import Data.Type.Coercion
101import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
103+import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
104+import qualified Data.WeakBag as WeakBag
88import qualified Reflex.Class
105import qualified Reflex.Class
89import qualified Reflex.Class as R
106import qualified Reflex.Class as R
90import qualified Reflex.Host.Class
107import qualified Reflex.Host.Class
91−#endif
92−import Reflex.Patch
108+import Reflex.NotReady.Class
109+import Data.Patch
93−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
94−
111+import Reflex.PerformEvent.Base (PerformEventT)
95−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
96−import Prelude hiding (any, concat, mapM, mapM_, sequence)
97
112
98#ifdef DEBUG_TRACE_EVENTS
113#ifdef DEBUG_TRACE_EVENTS
99−import System.IO (stderr)
100import qualified Data.ByteString.Char8 as BS8
114import qualified Data.ByteString.Char8 as BS8
115+import System.IO (stderr)
116+import Data.List (isPrefixOf)
101#endif
117#endif
102
118
103−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
104
122
123+#ifdef DEBUG_TRACE_EVENTS
105withStackOneLine :: (BS8.ByteString -> a) -> a
124withStackOneLine :: (BS8.ByteString -> a) -> a
106withStackOneLine expr = unsafePerformIO $ do
125withStackOneLine expr = unsafePerformIO $ do
107 stack <- currentCallStack
126 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"
109
129
110#endif
130#endif
111
131
@@ -116,28 +136,42 @@ debugInvalidateHeight :: Bool
116debugInvalidate :: Bool
136debugInvalidate :: Bool
117
137
118#ifdef DEBUG
138#ifdef DEBUG
119−
120#define DEBUG_NODEIDS
139#define DEBUG_NODEIDS
121
140
141+#ifdef DEBUG_TRACE_PROPAGATION
122debugPropagate = True
142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
123
146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
124debugInvalidateHeight = False
150debugInvalidateHeight = False
151+#endif
125
152
153+#ifdef DEBUG_TRACE_INVALIDATION
126debugInvalidate = True
154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
127
158
128class HasNodeId a where
159class HasNodeId a where
129 getNodeId :: a -> Int
160 getNodeId :: a -> Int
130
161
131−instance HasNodeId (Hold x p a) where
162+instance HasNodeId (CacheSubscribed x a) where
132− getNodeId = holdNodeId
163+ getNodeId = _cacheSubscribed_nodeId
133
164
134−instance HasNodeId (PushSubscribed x a b) where
165+instance HasNodeId (FanInt x a) where
135− getNodeId = pushSubscribedNodeId
166+ getNodeId = _fanInt_nodeId
167+
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
136
170
137instance HasNodeId (SwitchSubscribed x a) where
171instance HasNodeId (SwitchSubscribed x a) where
138 getNodeId = switchSubscribedNodeId
172 getNodeId = switchSubscribedNodeId
139
173
140−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
141 getNodeId = fanSubscribedNodeId
175 getNodeId = fanSubscribedNodeId
142
176
143instance HasNodeId (CoincidenceSubscribed x a) where
177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -151,41 +185,16 @@ instance HasNodeId (Pull x a) where
151
185
152{-# INLINE showNodeId #-}
186{-# INLINE showNodeId #-}
153showNodeId :: HasNodeId a => a -> String
187showNodeId :: HasNodeId a => a -> String
154−showNodeId = ("#"<>) . show . getNodeId
188+showNodeId = showNodeId' . getNodeId
155−
189+
156−showSubscriberType :: Subscriber x a -> String
190+showNodeId' :: Int -> String
157−showSubscriberType = \case
191+showNodeId' = ("#"<>) . show
158− SubscriberPush _ _ -> "SubscriberPush"
192+
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"
182
193
183#else
194#else
184
195
185debugPropagate = False
196debugPropagate = False
186−
187debugInvalidateHeight = False
197debugInvalidateHeight = False
188−
189debugInvalidate = False
198debugInvalidate = False
190
199
191-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -193,6 +202,10 @@ debugInvalidate = False
193showNodeId :: a -> String
202showNodeId :: a -> String
194showNodeId _ = ""
203showNodeId _ = ""
195
204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
196#endif
209#endif
197
210
198#ifdef DEBUG_NODEIDS
211#ifdef DEBUG_NODEIDS
@@ -202,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
202
215
203newNodeId :: IO Int
216newNodeId :: IO Int
204newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
205−
206−{-# NOINLINE unsafeNodeId #-}
207−unsafeNodeId :: a -> Int
208−unsafeNodeId a = unsafePerformIO $ do
209− touch a
210− newNodeId
211#endif
218#endif
212
219
213--------------------------------------------------------------------------------
220--------------------------------------------------------------------------------
@@ -246,7 +253,7 @@ subscribeAndRead = unEvent
246{-# INLINE [1] pushCheap #-}
253{-# INLINE [1] pushCheap #-}
247pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
248pushCheap !f e = Event $ \sub -> do
255pushCheap !f e = Event $ \sub -> do
249− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
250 { subscriberPropagate = \a -> do
257 { subscriberPropagate = \a -> do
251 mb <- f a
258 mb <- f a
252 mapM_ (subscriberPropagate sub) mb
259 mapM_ (subscriberPropagate sub) mb
@@ -265,10 +272,10 @@ terminalSubscriber p = Subscriber
265
272
266-- | Subscribe to an Event only for the duration of one occurrence
273-- | Subscribe to an Event only for the duration of one occurrence
267{-# INLINE subscribeAndReadHead #-}
274{-# 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)
269subscribeAndReadHead e sub = do
276subscribeAndReadHead e sub = do
270 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
271− (subscription, occ) <- subscribeAndRead e $ sub
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
272 { subscriberPropagate = \a -> do
279 { subscriberPropagate = \a -> do
273 liftIO $ unsubscribe =<< readIORef subscriptionRef
280 liftIO $ unsubscribe =<< readIORef subscriptionRef
274 subscriberPropagate sub a
281 subscriberPropagate sub a
@@ -279,24 +286,42 @@ subscribeAndReadHead e sub = do
279 return (subscription, occ)
286 return (subscription, occ)
280
287
281--TODO: Make this lazy in its input event
288--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)
283headE originalE = do
290headE originalE = do
284 parent <- liftIO $ newIORef $ Just originalE
291 parent <- liftIO $ newIORef $ Just originalE
285 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
286 let clearParent = liftIO $ writeIORef parent Nothing
293 let clearParent = liftIO $ writeIORef parent Nothing
287− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
288 when (isJust occ) clearParent
295 when (isJust occ) clearParent
289− return $ Event $ \sub -> do
296+ return $ Event $ \sub ->
290 liftIO (readIORef parent) >>= \case
297 liftIO (readIORef parent) >>= \case
291− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
298+ Nothing -> subscribeAndReadNever
292 Just e -> subscribeAndReadHead e sub
299 Just e -> subscribeAndReadHead e sub
293
300
294data CacheSubscribed x a
301data CacheSubscribed x a
295 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
296 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
297 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
298 }
308 }
299
309
310+nowSpiderEventM :: (HasSpiderTimeline x) => EventM x (R.Event (SpiderTimeline x) ())
311+nowSpiderEventM =
312+ SpiderEvent <$> now
313+
314+now :: (MonadIO m, Defer (Some Clear) m, HasSpiderTimeline x
315+ ) => m (Event x ())
316+now = do
317+ nowOrNot <- liftIO $ newIORef $ Just ()
318+ scheduleClear nowOrNot
319+ return . Event $ \_ -> do
320+ occ <- liftIO . readIORef $ nowOrNot
321+ return ( EventSubscription (return ()) eventSubscribedNow
322+ , occ
323+ )
324+
300-- | Construct an 'Event' whose value is guaranteed not to be recomputed
325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
301-- repeatedly
326-- repeatedly
302--
327--
@@ -311,27 +336,33 @@ cacheEvent e =
311#else
336#else
312 Event $
337 Event $
313#endif
338#endif
339+ unsafePerformIO $ do
314− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
315− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
341+ <- newIORef emptyFastWeak
316− in \sub -> {-# SCC "cacheEvent" #-} do
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
317#ifdef DEBUG_TRACE_EVENTS
343#ifdef DEBUG_TRACE_EVENTS
318 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
319#endif
345#endif
320 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
321 Just subscribedTicket -> return subscribedTicket
347 Just subscribedTicket -> return subscribedTicket
322 Nothing -> do
348 Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
323 subscribers <- liftIO FastWeakBag.empty
352 subscribers <- liftIO FastWeakBag.empty
324 occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
353 occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
354+#ifdef DEBUG_NODEIDS
355+ (parentSub, occ) <- subscribeAndRead e $ debugSubscriber' ("cacheEvent" <> showNodeId' nodeId) $ Subscriber
356+#else
325 (parentSub, occ) <- subscribeAndRead e $ Subscriber
357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
358+#endif
326− { subscriberPropagate = \a -> do
359+ { subscriberPropagate = \a -> do
327− liftIO $ writeIORef occRef $ Just a
360+ liftIO $ writeIORef occRef (Just a)
328− scheduleClear occRef
361+ scheduleClear occRef
329− propagateFast a subscribers
362+ propagateFast a subscribers
330− , subscriberInvalidateHeight = \old -> do
331− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
363+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
332− , subscriberRecalculateHeight = \new -> do
333− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
364+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
334− }
365+ }
335 when (isJust occ) $ do
366 when (isJust occ) $ do
336 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
337 scheduleClear occRef
368 scheduleClear occRef
@@ -339,29 +370,45 @@ cacheEvent e =
339 { _cacheSubscribed_subscribers = subscribers
370 { _cacheSubscribed_subscribers = subscribers
340 , _cacheSubscribed_parent = parentSub
371 , _cacheSubscribed_parent = parentSub
341 , _cacheSubscribed_occurrence = occRef
372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
342 }
376 }
343 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
344 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
345 return subscribedTicket
379 return subscribedTicket
346− liftIO $ do
380+ liftIO $ cacheSubscription sub mSubscribedRef subscribedTicket
381+
382+cacheSubscription :: Subscriber x a -> IORef (FastWeak (CacheSubscribed x a))
383+ -> FastWeakTicket (CacheSubscribed x a) -> IO (EventSubscription x, Maybe a)
384+cacheSubscription sub mSubscribedRef subscribedTicket = do
347− subscribed <- getFastWeakTicketValue subscribedTicket
385+ subscribed <- getFastWeakTicketValue subscribedTicket
348− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
386+ ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
349− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
387+ occ <- readIORef $ _cacheSubscribed_occurrence subscribed
388+
389+ let parentSub = _cacheSubscribed_parent subscribed
350− let es = EventSubscription
390+ es = EventSubscription
351− { _eventSubscription_unsubscribe = do
391+ { _eventSubscription_unsubscribe = do
352− FastWeakBag.remove ticket
392+ FastWeakBag.remove ticket
393+
353− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
394+ isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
354− when isEmpty $ do
395+ when isEmpty $ do
355− writeIORef mSubscribedRef emptyFastWeak
396+ writeIORef mSubscribedRef emptyFastWeak
356− unsubscribe $ _cacheSubscribed_parent subscribed
397+ unsubscribe parentSub
357− touch ticket
398+ touch ticket
358− touch subscribedTicket
399+ touch subscribedTicket
359− , _eventSubscription_subscribed = EventSubscribed
400+ , _eventSubscription_subscribed = EventSubscribed
360− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
401+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
361− , eventSubscribedRetained = toAny subscribedTicket
402+ , eventSubscribedRetained = toAny subscribedTicket
403+#ifdef DEBUG_CYCLES
404+ , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
405+ , eventSubscribedHasOwnHeightRef = False
406+ , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
407+#endif
362− }
408+ }
363− }
409+ }
364− return (es, occ)
410+ return (es, occ)
411+
365
412
366subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
367subscribe e s = fst <$> subscribeAndRead e s
414subscribe e s = fst <$> subscribeAndRead e s
@@ -373,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
373 let es = tag subd
420 let es = tag subd
374 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
375
422
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
377eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
378
425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
379eventNever :: Event x a
429eventNever :: Event x a
380−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
381
431
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)
383eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
384
434
385eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -388,7 +438,7 @@ eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
388eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
438eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
389eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
439eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
390
440
391−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
441+eventHold :: Hold x p -> Event x p
392eventHold !h = Event $ subscribeHoldEvent h
442eventHold !h = Event $ subscribeHoldEvent h
393
443
394eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
444eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
@@ -414,16 +464,6 @@ data Subscriber x a = Subscriber
414 , subscriberRecalculateHeight :: !(Height -> IO ())
464 , subscriberRecalculateHeight :: !(Height -> IO ())
415 }
465 }
416
466
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−
427newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
428newSubscriberHold h = return $ Subscriber
468newSubscriberHold h = return $ Subscriber
429 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -431,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
431 , subscriberRecalculateHeight = \_ -> return ()
471 , subscriberRecalculateHeight = \_ -> return ()
432 }
472 }
433
473
434−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
474+newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
435−newSubscriberFan subscribed = return $ Subscriber
475+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
436 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
437 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
477 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"
439 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
440 scheduleClear $ fanSubscribedOccurrence subscribed
480 scheduleClear $ fanSubscribedOccurrence subscribed
441− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
442 propagate v $ _fanSubscribedChildren_list subsubs
482 propagate v $ _fanSubscribedChildren_list subsubs
443 return $ Constant ()
483 return $ Constant ()
444 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
445 return ()
485 return ()
446 , subscriberInvalidateHeight = \old -> do
486 , subscriberInvalidateHeight = \old -> do
447− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
448 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
449− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
450− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
451 , subscriberRecalculateHeight = \new -> do
489 , subscriberRecalculateHeight = \new -> do
452− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
453 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
454− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
455− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
456 }
492 }
457
493
458newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
459−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
460 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
461− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
462 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
463 scheduleClear $ switchSubscribedOccurrence subscribed
498 scheduleClear $ switchSubscribedOccurrence subscribed
464 propagate a $ switchSubscribedSubscribers subscribed
499 propagate a $ switchSubscribedSubscribers subscribed
465 , subscriberInvalidateHeight = \_ -> do
500 , subscriberInvalidateHeight = \_ -> do
466− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
467 oldHeight <- readIORef $ switchSubscribedHeight subscribed
501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
468 when (oldHeight /= invalidHeight) $ do
502 when (oldHeight /= invalidHeight) $ do
469 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
470− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
471− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
472− , subscriberRecalculateHeight = \new -> do
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
473− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
474− updateSwitchHeight new subscribed
475− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
476− }
506+ }
477
507
478newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
479−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
480 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
481− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
482 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
483 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
484 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
485 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
486 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
487 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
488 scheduleClear $ coincidenceSubscribedInnerParent subscribed
518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
489 case occ of
519 case occ of
490− Nothing -> do
520+ Nothing ->
491 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
492 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
493− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
494− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
495 Just o -> do -- Since it's already firing, no need to adjust height
525 Just o -> do -- Since it's already firing, no need to adjust height
496 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
497 scheduleClear $ coincidenceSubscribedOccurrence subscribed
527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
498 propagate o $ coincidenceSubscribedSubscribers subscribed
528 propagate o $ coincidenceSubscribedSubscribers subscribed
499− , subscriberInvalidateHeight = \_ -> do
500− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
501− invalidateCoincidenceHeight subscribed
529+ , subscriberInvalidateHeight = \_ -> 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
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
506− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
507 }
531 }
508
532
509newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
510−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
511 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
512− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
513 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
514 case occ of
537 case occ of
515 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -517,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
517 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
518 scheduleClear $ coincidenceSubscribedOccurrence subscribed
541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
519 propagate a $ coincidenceSubscribedSubscribers subscribed
542 propagate a $ coincidenceSubscribedSubscribers subscribed
520− , subscriberInvalidateHeight = \_ -> do
521− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
522− invalidateCoincidenceHeight subscribed
543+ , subscriberInvalidateHeight = \_ -> 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
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
527− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
528 }
545 }
529
546
530invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -534,18 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
534recalculateSubscriberHeight = flip subscriberRecalculateHeight
551recalculateSubscriberHeight = flip subscriberRecalculateHeight
535
552
536-- | Propagate everything at the current height
553-- | Propagate everything at the current height
537−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
554+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
538−propagate a subscribers = withIncreasedDepth $ do
555+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
539 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
556 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
540 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
557 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
541− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
542
559
543-- | Propagate everything at the current height
560-- | Propagate everything at the current height
544−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
561+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
545−propagateFast a subscribers = withIncreasedDepth $ do
562+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
546 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
563 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
547 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
548− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
549
566
550--------------------------------------------------------------------------------
567--------------------------------------------------------------------------------
551-- EventSubscribed
568-- EventSubscribed
@@ -554,11 +571,16 @@ propagateFast a subscribers = withIncreasedDepth $ do
554toAny :: a -> Any
571toAny :: a -> Any
555toAny = unsafeCoerce
572toAny = unsafeCoerce
556
573
574+-- Why do we use Any here, instead of just giving eventSubscribedRetained an
575+-- existential type? Sadly, GHC does not currently know how to unbox types
576+-- with existentially quantified fields. So instead we just coerce values
577+-- to type Any on the way in. Since we never coerce them back, this is
578+-- perfectly safe.
557data EventSubscribed x = EventSubscribed
579data EventSubscribed x = EventSubscribed
558 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
559 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
560#ifdef DEBUG_CYCLES
582#ifdef DEBUG_CYCLES
561− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
562 , eventSubscribedHasOwnHeightRef :: !Bool
584 , eventSubscribedHasOwnHeightRef :: !Bool
563 , eventSubscribedWhoCreated :: !(IO [String])
585 , eventSubscribedWhoCreated :: !(IO [String])
564#endif
586#endif
@@ -585,13 +607,23 @@ eventSubscribedNever = EventSubscribed
585 , eventSubscribedWhoCreated = return ["never"]
607 , eventSubscribedWhoCreated = return ["never"]
586#endif
608#endif
587 }
609 }
610+eventSubscribedNow :: EventSubscribed x
611+eventSubscribedNow = EventSubscribed
612+ { eventSubscribedHeightRef = zeroRef
613+ , eventSubscribedRetained = toAny ()
614+#ifdef DEBUG_CYCLES
615+ , eventSubscribedGetParents = return []
616+ , eventSubscribedHasOwnHeightRef = False
617+ , eventSubscribedWhoCreated = return ["now"]
618+#endif
619+ }
588
620
589−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
590eventSubscribedFan !subscribed = EventSubscribed
622eventSubscribedFan !subscribed = EventSubscribed
591 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
592 , eventSubscribedRetained = toAny subscribed
624 , eventSubscribedRetained = toAny subscribed
593#ifdef DEBUG_CYCLES
625#ifdef DEBUG_CYCLES
594− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
595 , eventSubscribedHasOwnHeightRef = False
627 , eventSubscribedHasOwnHeightRef = False
596 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
597#endif
629#endif
@@ -604,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
604#ifdef DEBUG_CYCLES
636#ifdef DEBUG_CYCLES
605 , eventSubscribedGetParents = do
637 , eventSubscribedGetParents = do
606 s <- readIORef $ switchSubscribedCurrentParent subscribed
638 s <- readIORef $ switchSubscribedCurrentParent subscribed
607− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
608 , eventSubscribedHasOwnHeightRef = True
640 , eventSubscribedHasOwnHeightRef = True
609 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
610#endif
642#endif
@@ -617,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
617#ifdef DEBUG_CYCLES
649#ifdef DEBUG_CYCLES
618 , eventSubscribedGetParents = do
650 , eventSubscribedGetParents = do
619 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
620− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
621− innerParents = maybeToList $ fmap Some.This innerSubscription
653+ innerParents = maybeToList $ innerSubscription
622 return $ outerParent : innerParents
654 return $ outerParent : innerParents
623 , eventSubscribedHasOwnHeightRef = True
655 , eventSubscribedHasOwnHeightRef = True
624 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -632,20 +664,20 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
632whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
633whoCreatedEventSubscribed = eventSubscribedWhoCreated
665whoCreatedEventSubscribed = eventSubscribedWhoCreated
634
666
635−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
636walkInvalidHeightParents s0 = do
668walkInvalidHeightParents 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
638 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
639 when (h == invalidHeight) $ do
671 when (h == invalidHeight) $ do
640 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
641− modify (Some.This s :)
673+ modify (s :)
642 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
643− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
644 return subscribers
676 return subscribers
645#endif
677#endif
646
678
647{-# INLINE subscribeHoldEvent #-}
679{-# 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)
649subscribeHoldEvent = subscribeAndRead . holdEvent
681subscribeHoldEvent = subscribeAndRead . holdEvent
650
682
651--------------------------------------------------------------------------------
683--------------------------------------------------------------------------------
@@ -668,7 +700,7 @@ behaviorPull !p = Behavior $ do
668 val <- liftIO $ readIORef $ pullValue p
700 val <- liftIO $ readIORef $ pullValue p
669 case val of
701 case val of
670 Just subscribed -> do
702 Just subscribed -> do
671− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
672 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
673 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
674 return $ pullSubscribedValue subscribed
706 return $ pullSubscribedValue subscribed
@@ -677,7 +709,7 @@ behaviorPull !p = Behavior $ do
677 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
678 parentsRef <- liftIO $ newIORef []
710 parentsRef <- liftIO $ newIORef []
679 holdInits <- askBehaviorHoldInits
711 holdInits <- askBehaviorHoldInits
680− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
681 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
682 parents <- liftIO $ readIORef parentsRef
714 parents <- liftIO $ readIORef parentsRef
683 let subscribed = PullSubscribed
715 let subscribed = PullSubscribed
@@ -687,7 +719,7 @@ behaviorPull !p = Behavior $ do
687 , pullSubscribedParents = parents
719 , pullSubscribedParents = parents
688 }
720 }
689 liftIO $ writeIORef (pullValue p) $ Just subscribed
721 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)) :))
691 return a
723 return a
692
724
693behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -698,7 +730,8 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
698readHoldTracked h = do
730readHoldTracked h = do
699 result <- liftIO $ readIORef $ holdValue h
731 result <- liftIO $ readIORef $ holdValue h
700 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
732 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
702 return result
735 return result
703
736
704{-# INLINABLE readBehaviorUntracked #-}
737{-# INLINABLE readBehaviorUntracked #-}
@@ -711,42 +744,46 @@ readBehaviorUntracked b = do
711-- Dynamic
744-- Dynamic
712--------------------------------------------------------------------------------
745--------------------------------------------------------------------------------
713
746
747+type DynamicS x p = Dynamic x (PatchTarget p) p
748+
714−data Dynamic x p = Dynamic
749+data Dynamic x target p = Dynamic
715− { dynamicCurrent :: !(Behavior x (PatchTarget p))
750+ { dynamicCurrent :: !(Behavior x target)
716− , dynamicUpdated :: !(Event x p)
751+ , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
717 }
752 }
718
753
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
720dynamicHold !h = Dynamic
760dynamicHold !h = Dynamic
721 { dynamicCurrent = behaviorHold h
761 { dynamicCurrent = behaviorHold h
722 , dynamicUpdated = eventHold h
762 , dynamicUpdated = eventHold h
723 }
763 }
724
764
725−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
726dynamicHoldIdentity = dynamicHold
766dynamicHoldIdentity = dynamicHold
727
767
728−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
729dynamicConst !a = Dynamic
769dynamicConst !a = Dynamic
730 { dynamicCurrent = behaviorConst a
770 { dynamicCurrent = behaviorConst a
731 , dynamicUpdated = eventNever
771 , dynamicUpdated = eventNever
732 }
772 }
733
773
734−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
735dynamicDyn !d = Dynamic
775dynamicDyn !d = Dynamic
736 { dynamicCurrent = behaviorDyn d
776 { dynamicCurrent = behaviorDyn d
737 , dynamicUpdated = eventDyn d
777 , dynamicUpdated = eventDyn d
738 }
778 }
739
779
740−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
741dynamicDynIdentity = dynamicDyn
781dynamicDynIdentity = dynamicDyn
742
782
743--------------------------------------------------------------------------------
783--------------------------------------------------------------------------------
744-- Combinators
784-- Combinators
745--------------------------------------------------------------------------------
785--------------------------------------------------------------------------------
746
786
747−--TODO: Figure out why certain things are not 'representational', then make them
748−--representational so we can use coerce
749−
750--type role Hold representational
787--type role Hold representational
751data Hold x p
788data Hold x p
752 = Hold { holdValue :: !(IORef (PatchTarget p))
789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -758,9 +795,7 @@ data Hold x p
758#endif
795#endif
759 }
796 }
760
797
761−-- | A statically allocated 'SpiderTimeline'; this is the only instance of
798+-- | A statically allocated 'SpiderTimeline'
762−-- 'SpiderTimeline' that can used when using
763−-- -fspecialize-to-spidertimeline-global.
764data Global
799data Global
765
800
766{-# NOINLINE globalSpiderTimelineEnv #-}
801{-# NOINLINE globalSpiderTimelineEnv #-}
@@ -769,30 +804,27 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
769
804
770-- | Stores all global data relevant to a particular Spider timeline; only one
805-- | Stores all global data relevant to a particular Spider timeline; only one
771-- value should exist for each type @x@
806-- value should exist for each type @x@
807+newtype SpiderTimelineEnv x = STE {unSTE :: SpiderTimelineEnv' x}
808+-- We implement SpiderTimelineEnv with a newtype wrapper so
809+-- we can get the coercions we want safely.
810+type role SpiderTimelineEnv nominal
811+
772−data SpiderTimelineEnv x = SpiderTimelineEnv
812+data SpiderTimelineEnv' x = SpiderTimelineEnv
773 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
774 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
775#ifdef DEBUG
815#ifdef DEBUG
776 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
777#endif
817#endif
778 }
818 }
779−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
780
820
781instance Eq (SpiderTimelineEnv x) where
821instance Eq (SpiderTimelineEnv x) where
782 _ == _ = True -- Since only one exists of each type
822 _ == _ = True -- Since only one exists of each type
783
823
784instance GEq SpiderTimelineEnv where
824instance 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)
793 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
794 else Nothing
827 else Nothing
795−#endif
796
828
797data EventEnv x
829data EventEnv x
798 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
830 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
@@ -800,9 +832,9 @@ data EventEnv x
800 , eventEnvDynInits :: !(IORef [SomeDynInit x])
832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
801 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
802 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
803− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
804− , eventEnvIntClears :: !(IORef [SomeIntClear])
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
805− , eventEnvRootClears :: !(IORef [SomeRootClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
806 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
807 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
808 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -813,7 +845,7 @@ runEventM :: EventM x a -> IO a
813runEventM = unEventM
845runEventM = unEventM
814
846
815asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
847asksEventEnv :: 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))
817
849
818class MonadIO m => Defer a m where
850class MonadIO m => Defer a m where
819 getDeferralQueue :: m (IORef [a])
851 getDeferralQueue :: m (IORef [a])
@@ -862,11 +894,7 @@ instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
862 delayedRef <- asksEventEnv eventEnvDelayedMerges
894 delayedRef <- asksEventEnv eventEnvDelayedMerges
863 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
895 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
864
896
865−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
866−class x ~ Global => HasSpiderTimeline x where
867−#else
868class HasSpiderTimeline x where
897class HasSpiderTimeline x where
869−#endif
870 -- | Retrieve the current SpiderTimelineEnv
898 -- | Retrieve the current SpiderTimelineEnv
871 spiderTimeline :: SpiderTimelineEnv x
899 spiderTimeline :: SpiderTimelineEnv x
872
900
@@ -878,29 +906,29 @@ putCurrentHeight h = do
878 heightRef <- asksEventEnv eventEnvCurrentHeight
906 heightRef <- asksEventEnv eventEnvCurrentHeight
879 liftIO $ writeIORef heightRef $! h
907 liftIO $ writeIORef heightRef $! h
880
908
881−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
882 {-# INLINE getDeferralQueue #-}
910 {-# INLINE getDeferralQueue #-}
883 getDeferralQueue = asksEventEnv eventEnvClears
911 getDeferralQueue = asksEventEnv eventEnvClears
884
912
885{-# INLINE scheduleClear #-}
913{-# INLINE scheduleClear #-}
886−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
887−scheduleClear r = defer $ SomeClear r
915+scheduleClear r = defer $ Some $ Clear r
888
916
889−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
890 {-# INLINE getDeferralQueue #-}
918 {-# INLINE getDeferralQueue #-}
891 getDeferralQueue = asksEventEnv eventEnvIntClears
919 getDeferralQueue = asksEventEnv eventEnvIntClears
892
920
893{-# INLINE scheduleIntClear #-}
921{-# INLINE scheduleIntClear #-}
894−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
895−scheduleIntClear r = defer $ SomeIntClear r
923+scheduleIntClear r = defer $ Some $ IntClear r
896
924
897−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
898 {-# INLINE getDeferralQueue #-}
926 {-# INLINE getDeferralQueue #-}
899 getDeferralQueue = asksEventEnv eventEnvRootClears
927 getDeferralQueue = asksEventEnv eventEnvRootClears
900
928
901{-# INLINE scheduleRootClear #-}
929{-# INLINE scheduleRootClear #-}
902−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
903−scheduleRootClear r = defer $ SomeRootClear r
931+scheduleRootClear r = defer $ Some $ RootClear r
904
932
905instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
906 {-# INLINE getDeferralQueue #-}
934 {-# INLINE getDeferralQueue #-}
@@ -955,9 +983,9 @@ getHoldEventSubscription h = do
955
983
956type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
957
985
958−--type role BehaviorM representational
959-- BehaviorM can sample behaviors
986-- 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))
961
989
962instance Monad (BehaviorM x) where
990instance Monad (BehaviorM x) where
963 {-# INLINE (>>=) #-}
991 {-# INLINE (>>=) #-}
@@ -966,14 +994,16 @@ instance Monad (BehaviorM x) where
966 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
967 {-# INLINE return #-}
995 {-# INLINE return #-}
968 return x = BehaviorM $ return x
996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
969 {-# INLINE fail #-}
998 {-# INLINE fail #-}
970 fail s = BehaviorM $ fail s
999 fail s = BehaviorM $ fail s
1000+#endif
971
1001
972data BehaviorSubscribed x a
1002data BehaviorSubscribed x a
973 = forall p. BehaviorSubscribedHold (Hold x p)
1003 = forall p. BehaviorSubscribedHold (Hold x p)
974 | BehaviorSubscribedPull (PullSubscribed x a)
1004 | BehaviorSubscribedPull (PullSubscribed x a)
975
1005
976−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
977
1007
978--type role PullSubscribed representational
1008--type role PullSubscribed representational
979data PullSubscribed x a
1009data PullSubscribed x a
@@ -1008,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
1008#endif
1038#endif
1009 }
1039 }
1010
1040
1011−data Root x (k :: * -> *)
1041+data Root x k
1012 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1013 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1014 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
1044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -1027,7 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
1027newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1028
1058
1029-- EventM can do everything BehaviorM can, plus create holds
1059-- 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)
1031
1061
1032newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1033
1063
@@ -1052,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
1052heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1053
1083
1054heightBagAdd :: Height -> HeightBag -> HeightBag
1084heightBagAdd :: 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
1056
1087
1057heightBagRemove :: Height -> HeightBag -> HeightBag
1088heightBagRemove :: Height -> HeightBag -> HeightBag
1058heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
1089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1061,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
1061 0 -> IntMap.delete h c
1092 0 -> IntMap.delete h c
1062 _ -> IntMap.insert h (pred old) c
1093 _ -> IntMap.insert h (pred old) c
1063
1094
1095+heightBagRemoveMaybe :: Height -> HeightBag -> Maybe HeightBag
1096+heightBagRemoveMaybe (Height h) b@(HeightBag s c) = heightBagVerify . removed <$> IntMap.lookup h c where
1097+ removed old = HeightBag (pred s) $ case old of
1098+ 0 -> IntMap.delete h c
1099+ _ -> IntMap.insert h (pred old) c
1100+
1101+
1064heightBagMax :: HeightBag -> Height
1102heightBagMax :: HeightBag -> Height
1065heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1066 Just ((h, _), _) -> Height h
1104 Just ((h, _), _) -> Height h
@@ -1078,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
1078heightBagVerify = id
1116heightBagVerify = id
1079#endif
1117#endif
1080
1118
1081−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1119+data FanSubscribedChildren x k v a = FanSubscribedChildren
1082− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1120+ { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1083− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1121+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1084− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
1122+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
1085 }
1123 }
1086
1124
1087−data FanSubscribed (x :: *) k
1125+data FanSubscribed x k v
1088− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1126+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1089− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1127+ , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1090− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
1128+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
1091 , fanSubscribedParent :: !(EventSubscription x)
1129 , fanSubscribedParent :: !(EventSubscription x)
1092#ifdef DEBUG_NODEIDS
1130#ifdef DEBUG_NODEIDS
1093 , fanSubscribedNodeId :: Int
1131 , fanSubscribedNodeId :: Int
1094#endif
1132#endif
1095 }
1133 }
1096
1134
1097−data Fan x k
1135+data Fan x k v
1098− = Fan { fanParent :: !(Event x (DMap k Identity))
1136+ = Fan { fanParent :: !(Event x (DMap k v))
1099− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1137+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1100 }
1138 }
1101
1139
1102data SwitchSubscribed x a
1140data SwitchSubscribed x a
@@ -1150,20 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
1150newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1151newInvalidatorPull p = return $! InvalidatorPull p
1189newInvalidatorPull p = return $! InvalidatorPull p
1152
1190
1153−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1154− fmapMaybe f = push $ return . f
1192+ mapMaybe f = push $ return . f
1155
1193
1156instance HasSpiderTimeline x => Align (Event x) where
1194instance HasSpiderTimeline x => Align (Event x) where
1157 nil = eventNever
1195 nil = eventNever
1196+#if MIN_VERSION_these(0, 8, 0)
1197+instance HasSpiderTimeline x => Semialign (Event x) where
1198+#endif
1199+ align ea eb = mapMaybe dmapToThese $ mergeG coerce $ dynamicConst $
1158− align ea eb = fmapMaybe dmapToThese $ merge $ dynamicConst $ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1200+ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1201+
1202+#ifdef MIN_VERSION_semialign
1203+#if MIN_VERSION_semialign(1,1,0)
1204+instance HasSpiderTimeline x => Zip (Event x) where
1205+#endif
1206+ zip x y = mapMaybe justThese $ align x y
1207+#endif
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)
1159
1212
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) }
1161
1214
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)
1163newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1164
1217
1165--TODO: Avoid the duplication between this and R.zipDynWith
1218--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)
1167zipDynWith f da db =
1220zipDynWith f da db =
1168 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1169 ec = flip push eab $ \o -> do
1222 ec = flip push eab $ \o -> do
@@ -1178,26 +1231,20 @@ zipDynWith f da db =
1178 return $ Just $ Identity $ f a b
1231 return $ Just $ Identity $ f a b
1179 in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1232 in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1180
1233
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)
1182buildDynamic readV0 v' = do
1235buildDynamic readV0 v' = do
1183− result <- liftIO $ newIORef $ Left (readV0, v')
1236+ result <- liftIO $ newIORef $ BuildDyn (readV0, v')
1184 let !d = Dyn result
1237 let !d = Dyn result
1185 defer $ SomeDynInit d
1238 defer $ SomeDynInit d
1186 return d
1239 return d
1187
1240
1188unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1189−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1242+unsafeBuildDynamic readV0 v' =
1190− where x = (readV0, v')
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
1191
1244
1192-- ResultM can read behaviors and events
1245-- ResultM can read behaviors and events
1193type ResultM = EventM
1246type ResultM = EventM
1194
1247
1195−{-# NOINLINE unsafeNewIORef #-}
1196−unsafeNewIORef :: a -> b -> IORef b
1197−unsafeNewIORef a b = unsafePerformIO $ do
1198− touch a
1199− newIORef b
1200−
1201instance HasSpiderTimeline x => Functor (Event x) where
1248instance HasSpiderTimeline x => Functor (Event x) where
1202 fmap f = push $ return . Just . f
1249 fmap f = push $ return . Just . f
1203
1250
@@ -1210,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
1210
1257
1211{-# INLINABLE pull #-}
1258{-# INLINABLE pull #-}
1212pull :: BehaviorM x a -> Behavior x a
1259pull :: BehaviorM x a -> Behavior x a
1213−pull a = behaviorPull $ Pull
1260+pull a = unsafePerformIO $ do
1214− { pullCompute = a
1261+ ref <- newIORef Nothing
1215− , pullValue = unsafeNewIORef a Nothing
1216#ifdef DEBUG_NODEIDS
1262#ifdef DEBUG_NODEIDS
1217− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
1218#endif
1264#endif
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1219− }
1271+ }
1220
1272
1221{-# INLINABLE switch #-}
1273{-# INLINABLE switch #-}
1222switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1223−switch a = eventSwitch $ Switch
1277+ pure $ eventSwitch $ Switch
1224− { switchParent = a
1278+ { switchParent = a
1225− , switchSubscribed = unsafeNewIORef a Nothing
1279+ , switchSubscribed = ref
1226− }
1280+ }
1227
1281
1228coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1229−coincidence a = eventCoincidence $ Coincidence
1285+ pure $ eventCoincidence $ Coincidence
1230− { coincidenceParent = a
1286+ { coincidenceParent = a
1231− , coincidenceSubscribed = unsafeNewIORef a Nothing
1287+ , coincidenceSubscribed = ref
1232− }
1288+ }
1233
1289
1234-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1235run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1236run roots after = do
1292run roots after = do
1237 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1238− t <- SpiderHost ask
1294+ let t = spiderTimeline :: SpiderTimelineEnv x
1239− result <- SpiderHost $ lift $ withMVar (_spiderTimeline_lock t) $ \_ -> flip runReaderT t $ unSpiderHost $ runFrame $ do
1295+ result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
1240 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1241 occBefore <- liftIO $ do
1297 occBefore <- liftIO $ do
1242 occBefore <- readIORef occRef
1298 occBefore <- readIORef occRef
@@ -1274,11 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1274 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1275 EQ -> a
1331 EQ -> a
1276
1332
1277−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
1278
1334
1279−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
1280
1336
1281−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
1282
1338
1283data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1284
1340
@@ -1290,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
1290 x' <- evaluate x
1346 x' <- evaluate x
1291 mkWeakPtr x' $
1347 mkWeakPtr x' $
1292 if debugFinalize
1348 if debugFinalize
1293− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
1294 else Nothing
1350 else Nothing
1295
1351
1296type WeakList a = [Weak a]
1352type WeakList a = [Weak a]
1297
1353
1298−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
1299#ifdef DEBUG
1359#ifdef DEBUG
1360+
1361+debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1362+debugSubscriber description = return . debugSubscriber' description
1363+
1364+debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1365+debugSubscriber' description subscribed = Subscriber
1366+ {
1367+ subscriberPropagate = \m -> do
1368+ tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1369+ subscriberPropagate subscribed m
1370+ , subscriberInvalidateHeight = \old -> do
1371+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1372+ subscriberInvalidateHeight subscribed old
1373+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1374+ , subscriberRecalculateHeight = \new -> do
1375+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1376+ subscriberRecalculateHeight subscribed new
1377+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1378+ }
1379+
1380+
1300−withIncreasedDepth :: CanTrace x m => m a -> m a
1381+{-# INLINE withIncreasedDepth #-}
1382+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1301−withIncreasedDepth a = do
1383+withIncreasedDepth _ a = do
1302− spiderTimeline <- askSpiderTimelineEnv
1303− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
1384+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
1304 result <- a
1385 result <- a
1305− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
1306 return result
1387 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)
1313
1388
1314{-# INLINE tracePropagate #-}
1389{-# INLINE tracePropagate #-}
1315tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1316−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
1317
1392
1318{-# INLINE traceInvalidate #-}
1393{-# INLINE traceInvalidate #-}
1319traceInvalidate :: String -> IO ()
1394traceInvalidate :: String -> IO ()
1320−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1395+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
1321
1396
1322−{-# INLINE traceWhen #-}
1397+{-# INLINE traceInvalidateHeight #-}
1323−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1398+traceInvalidateHeight :: String -> IO ()
1324−traceWhen p b message = traceMWhen p b $ return message
1399+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
1325
1400
1326−{-# INLINE traceMWhen #-}
1401+{-# INLINE trace #-}
1327−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
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 ()
1328−traceMWhen _ b getMessage = when b $ do
1407+traceM _ getMessage = do
1329 message <- getMessage
1408 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+
1333#else
1412#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+
1335#endif
1448#endif
1336− liftIO $ putStrLn $ replicate d ' ' <> message
1337
1449
1338whoCreatedIORef :: IORef a -> IO [String]
1450whoCreatedIORef :: IORef a -> IO [String]
1339whoCreatedIORef (IORef a) = whoCreated $! a
1451whoCreatedIORef (IORef a) = whoCreated $! a
1340
1452
1341−#ifdef DEBUG_CYCLES
1342groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1343groupByHead = \case
1454groupByHead = \case
1344 [] -> []
1455 [] -> []
@@ -1349,20 +1460,54 @@ groupByHead = \case
1349 | otherwise -> (x, xs :| []) : l
1460 | otherwise -> (x, xs :| []) : l
1350
1461
1351listsToForest :: Eq a => [[a]] -> Forest a
1462listsToForest :: 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+
1353#endif
1495#endif
1354
1496
1497+
1355{-# INLINE propagateSubscriberHold #-}
1498{-# INLINE propagateSubscriberHold #-}
1356propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1357propagateSubscriberHold h a = do
1500propagateSubscriberHold h a = do
1358− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
1359 invalidators <- liftIO $ readIORef $ holdInvalidators h
1502 invalidators <- liftIO $ readIORef $ holdInvalidators h
1360 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
1361 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1362 case {-# SCC "apply" #-} apply a v of
1506 case {-# SCC "apply" #-} apply a v of
1363 Nothing -> return ()
1507 Nothing -> return ()
1364 Just v' -> do
1508 Just v' -> do
1509+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1365− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1510+ tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
1366 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1367 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1368 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1370,25 +1515,25 @@ propagateSubscriberHold h a = do
1370data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1371
1516
1372runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1373−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
1374
1519
1375askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1376askInvalidator = do
1521askInvalidator = do
1377− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
1378 case m of
1523 case m of
1379 Nothing -> return Nothing
1524 Nothing -> return Nothing
1380 Just (!wi, _) -> return $ Just wi
1525 Just (!wi, _) -> return $ Just wi
1381
1526
1382askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1383askParentsRef = do
1528askParentsRef = do
1384− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
1385 case m of
1530 case m of
1386 Nothing -> return Nothing
1531 Nothing -> return Nothing
1387 Just (_, !p) -> return $ Just p
1532 Just (_, !p) -> return $ Just p
1388
1533
1389askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1390askBehaviorHoldInits = do
1535askBehaviorHoldInits = do
1391− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
1392 return his
1537 return his
1393
1538
1394{-# INLINE getDynHold #-}
1539{-# INLINE getDynHold #-}
@@ -1396,20 +1541,27 @@ getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
1396getDynHold d = do
1541getDynHold d = do
1397 mh <- liftIO $ readIORef $ unDyn d
1542 mh <- liftIO $ readIORef $ unDyn d
1398 case mh of
1543 case mh of
1399− Right h -> return h
1544+ HoldDyn h -> return h
1400− Left (readV0, v') -> do
1545+ UnsafeDyn (readV0, v') -> do
1401 holdInits <- getDeferralQueue
1546 holdInits <- getDeferralQueue
1402 v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1547 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
1403 h <- hold v0 v'
1554 h <- hold v0 v'
1404− liftIO $ writeIORef (unDyn d) $ Right h
1555+ liftIO $ writeIORef (unDyn d) $ HoldDyn h
1405 return h
1556 return h
1406
1557
1558+
1407-- Always refers to 0
1559-- Always refers to 0
1408{-# NOINLINE zeroRef #-}
1560{-# NOINLINE zeroRef #-}
1409zeroRef :: IORef Height
1561zeroRef :: IORef Height
1410zeroRef = unsafePerformIO $ newIORef zeroHeight
1562zeroRef = unsafePerformIO $ newIORef zeroHeight
1411
1563
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)
1413getRootSubscribed k r sub = do
1565getRootSubscribed k r sub = do
1414 mSubscribed <- readIORef $ rootSubscribed r
1566 mSubscribed <- readIORef $ rootSubscribed r
1415 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1423,9 +1575,14 @@ getRootSubscribed k r sub = do
1423 let !cached = rootSubscribed r
1575 let !cached = rootSubscribed r
1424 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1425 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1578+
1426− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
1427 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1428 writeIORef uninitRef $! uninit
1582 writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
1429 let !subscribed = RootSubscribed
1586 let !subscribed = RootSubscribed
1430 { rootSubscribedKey = k
1587 { rootSubscribedKey = k
1431 , rootSubscribedCachedSubscribed = cached
1588 , rootSubscribedCachedSubscribed = cached
@@ -1434,7 +1591,7 @@ getRootSubscribed k r sub = do
1434 , rootSubscribedUninit = uninit
1591 , rootSubscribedUninit = uninit
1435 , rootSubscribedWeakSelf = weakSelf
1592 , rootSubscribedWeakSelf = weakSelf
1436#ifdef DEBUG_NODEIDS
1593#ifdef DEBUG_NODEIDS
1437− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
1438#endif
1595#endif
1439 }
1596 }
1440 -- If we die at the same moment that all our children die, they will
1597 -- If we die at the same moment that all our children die, they will
@@ -1470,6 +1627,9 @@ data FanInt x a = FanInt
1470 { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1627 { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1471 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1472 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
1473 }
1633 }
1474
1634
1475newFanInt :: IO (FanInt x a)
1635newFanInt :: IO (FanInt x a)
@@ -1477,38 +1637,39 @@ newFanInt = do
1477 subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1637 subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1478 subscriptionRef <- newIORef $ error "fanInt: no subscription"
1638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
1479 occRef <- newIORef $ error "fanInt: no occurrence"
1639 occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
1480 return $ FanInt
1643 return $ FanInt
1481 { _fanInt_subscribers = subscribers
1644 { _fanInt_subscribers = subscribers
1482 , _fanInt_subscriptionRef = subscriptionRef
1645 , _fanInt_subscriptionRef = subscriptionRef
1483 , _fanInt_occRef = occRef
1646 , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
1484 }
1650 }
1485
1651
1486−{-# NOINLINE unsafeNewFanInt #-}
1487−unsafeNewFanInt :: b -> FanInt x a
1488−unsafeNewFanInt b = unsafePerformIO $ do
1489− touch b
1490− newFanInt
1491−
1492fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1493−fanInt p =
1653+fanInt p = unsafePerformIO $ do
1494− let self = unsafeNewFanInt p
1654+ self <- newFanInt
1495− in EventSelectorInt $ \k -> Event $ \sub -> do
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
1496 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1497 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1498− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
1499 { subscriberPropagate = \m -> do
1660 { subscriberPropagate = \m -> do
1500 liftIO $ writeIORef (_fanInt_occRef self) m
1661 liftIO $ writeIORef (_fanInt_occRef self) m
1501 scheduleIntClear $ _fanInt_occRef self
1662 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?
1663+ FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1503− FastWeakBag.traverse b $ \s -> do
1664+ FastWeakBag.traverse_ b $ \s ->
1504 subscriberPropagate s v
1665 subscriberPropagate s v
1505− , subscriberInvalidateHeight = \old -> do
1666+ , subscriberInvalidateHeight = \old ->
1506− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1507− FastWeakBag.traverse b $ \s -> do
1668+ FastWeakBag.traverse_ b $ \s ->
1508 subscriberInvalidateHeight s old
1669 subscriberInvalidateHeight s old
1509− , subscriberRecalculateHeight = \new -> do
1670+ , subscriberRecalculateHeight = \new ->
1510− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1511− FastWeakBag.traverse b $ \s -> do
1672+ FastWeakBag.traverse_ b $ \s ->
1512 subscriberRecalculateHeight s new
1673 subscriberRecalculateHeight s new
1513 }
1674 }
1514 liftIO $ do
1675 liftIO $ do
@@ -1522,13 +1683,28 @@ fanInt p =
1522 FastMutableIntMap.insert (_fanInt_subscribers self) k b
1683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
1523 return b
1684 return b
1524 Just b -> return b
1685 Just b -> return b
1525− t <- liftIO $ FastWeakBag.insert sub b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
1526 currentOcc <- readIORef (_fanInt_occRef self)
1687 currentOcc <- readIORef (_fanInt_occRef self)
1527− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1688+
1689+ subscribed <- fanIntSubscribed ticket self
1528− return (EventSubscription (FastWeakBag.remove t) $! EventSubscribed heightRef $! toAny (_fanInt_subscriptionRef self, t), IntMap.lookup k currentOcc)
1690+ return (EventSubscription (FastWeakBag.remove ticket) subscribed, IntMap.lookup k currentOcc)
1691+
1692+fanIntSubscribed :: FastWeakBagTicket k -> FanInt x a -> IO (EventSubscribed x)
1693+fanIntSubscribed ticket self = do
1694+ subscribedParent <- _eventSubscription_subscribed <$> readIORef (_fanInt_subscriptionRef self)
1695+ return $ EventSubscribed
1696+ { eventSubscribedHeightRef = eventSubscribedHeightRef subscribedParent
1697+ , eventSubscribedRetained = toAny (_fanInt_subscriptionRef self, ticket)
1698+#ifdef DEBUG_CYCLES
1699+ , eventSubscribedGetParents = return [subscribedParent]
1700+ , eventSubscribedHasOwnHeightRef = False
1701+ , eventSubscribedWhoCreated = whoCreatedIORef $ _fanInt_subscriptionRef self
1702+#endif
1703+ }
1704+
1529
1705
1530{-# INLINABLE getFanSubscribed #-}
1706{-# 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))
1532getFanSubscribed k f sub = do
1708getFanSubscribed k f sub = do
1533 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1534 case mSubscribed of
1710 case mSubscribed of
@@ -1546,13 +1722,16 @@ getFanSubscribed k f sub = do
1546 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1547 occRef <- liftIO $ newIORef parentOcc
1723 occRef <- liftIO $ newIORef parentOcc
1548 when (isJust parentOcc) $ scheduleClear occRef
1724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
1549 let subscribed = FanSubscribed
1728 let subscribed = FanSubscribed
1550 { fanSubscribedCachedSubscribed = fanSubscribed f
1729 { fanSubscribedCachedSubscribed = fanSubscribed f
1551 , fanSubscribedOccurrence = occRef
1730 , fanSubscribedOccurrence = occRef
1552 , fanSubscribedParent = subscription
1731 , fanSubscribedParent = subscription
1553 , fanSubscribedSubscribers = subscribersRef
1732 , fanSubscribedSubscribers = subscribersRef
1554#ifdef DEBUG_NODEIDS
1733#ifdef DEBUG_NODEIDS
1555− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
1556#endif
1735#endif
1557 }
1736 }
1558 let !self = (k, subscribed)
1737 let !self = (k, subscribed)
@@ -1562,7 +1741,7 @@ getFanSubscribed k f sub = do
1562 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1563 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1564
1743
1565−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
1566cleanupFanSubscribed (k, subscribed) = do
1745cleanupFanSubscribed (k, subscribed) = do
1567 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1568 let reducedSubscribers = DMap.delete k subscribers
1747 let reducedSubscribers = DMap.delete k subscribers
@@ -1574,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
1574 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1575
1754
1576{-# INLINE subscribeFanSubscribed #-}
1755{-# 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
1578subscribeFanSubscribed k subscribed sub = do
1757subscribeFanSubscribed k subscribed sub = do
1579 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1580 case DMap.lookup k subscribers of
1759 case DMap.lookup k subscribers of
@@ -1612,6 +1791,9 @@ getSwitchSubscribed s sub = do
1612 when (isJust parentOcc) $ scheduleClear occRef
1791 when (isJust parentOcc) $ scheduleClear occRef
1613 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1614 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
1615 let !subscribed = SwitchSubscribed
1797 let !subscribed = SwitchSubscribed
1616 { switchSubscribedCachedSubscribed = switchSubscribed s
1798 { switchSubscribedCachedSubscribed = switchSubscribed s
1617 , switchSubscribedOccurrence = occRef
1799 , switchSubscribedOccurrence = occRef
@@ -1624,7 +1806,7 @@ getSwitchSubscribed s sub = do
1624 , switchSubscribedCurrentParent = subscriptionRef
1806 , switchSubscribedCurrentParent = subscriptionRef
1625 , switchSubscribedWeakSelf = weakSelf
1807 , switchSubscribedWeakSelf = weakSelf
1626#ifdef DEBUG_NODEIDS
1808#ifdef DEBUG_NODEIDS
1627− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
1628#endif
1810#endif
1629 }
1811 }
1630 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1669,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
1669 scheduleClear innerSubdRef
1851 scheduleClear innerSubdRef
1670 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1671 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
1672 let subscribed = CoincidenceSubscribed
1857 let subscribed = CoincidenceSubscribed
1673 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1674 , coincidenceSubscribedOccurrence = occRef
1859 , coincidenceSubscribedOccurrence = occRef
@@ -1679,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
1679 , coincidenceSubscribedInnerParent = innerSubdRef
1864 , coincidenceSubscribedInnerParent = innerSubdRef
1680 , coincidenceSubscribedWeakSelf = weakSelf
1865 , coincidenceSubscribedWeakSelf = weakSelf
1681#ifdef DEBUG_NODEIDS
1866#ifdef DEBUG_NODEIDS
1682− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
1683#endif
1868#endif
1684 }
1869 }
1685 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1696,57 +1881,72 @@ cleanupCoincidenceSubscribed subscribed = do
1696subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1697subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1698
1883
1699−{-# INLINE merge #-}
1884+{-# INLINE mergeG #-}
1700−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1885+mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
1886+ => (forall a. q a -> Event x (v a))
1887+ -> DynamicS x (PatchDMap k q) -> Event x (DMap k v)
1701−merge d = cacheEvent (mergeCheap d)
1888+mergeG nt d = cacheEvent (mergeCheap nt d)
1702
1889
1703{-# INLINE mergeWithMove #-}
1890{-# INLINE mergeWithMove #-}
1704−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1891+mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
1892+ => (forall a. q a -> Event x (v a))
1893+ -> DynamicS x (PatchDMapWithMove k q) -> Event x (DMap k v)
1705−mergeWithMove d = cacheEvent (mergeCheapWithMove d)
1894+mergeWithMove nt d = cacheEvent (mergeCheapWithMove nt d)
1706
1895
1707{-# INLINE [1] mergeCheap #-}
1896{-# INLINE [1] mergeCheap #-}
1897+mergeCheap
1708−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1898+ :: forall k x q v. (HasSpiderTimeline x, GCompare k)
1899+ => (forall a. q a -> Event x (v a))
1900+ -> DynamicS x (PatchDMap k q)
1901+ -> Event x (DMap k v)
1709−mergeCheap = mergeCheap' getInitialSubscribers updateMe destroy
1902+mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
1710 where
1903 where
1711− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
1712 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1713 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1714 (mOldSubd, newPs) <- case me of
1907 (mOldSubd, newPs) <- case me of
1715 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1716 Just e -> do
1909 Just e -> do
1717 let s = subscriber $ return k
1910 let s = subscriber $ return k
1718− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
1719 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1720 let newParent = MergeSubscribedParent subscription
1913 let newParent = MergeSubscribedParent subscription
1721 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1722 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1723 forM_ mOldSubd $ \oldSubd -> do
1916 forM_ mOldSubd $ \oldSubd -> do
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1724− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
1725 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1726 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1727 foldM f ([], oldParents) $ DMap.toList p
1922 foldM f ([], oldParents) $ DMap.toList p
1923+
1728− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
1729 getInitialSubscribers initialParents subscriber = do
1925 getInitialSubscribers initialParents subscriber = do
1730 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1731 let s = subscriber $ return k
1927 let s = subscriber $ return k
1732− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1733 height <- liftIO $ getEventSubscribedHeight parentSubd
1929 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)
1735 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1736 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1737 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1738 )
1934 )
1935+
1739 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1740 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1741
1938
1742{-# INLINE [1] mergeCheapWithMove #-}
1939{-# INLINE [1] mergeCheapWithMove #-}
1743−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1940+mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
1941+ => (forall a. q a -> Event x (v a))
1942+ -> DynamicS x (PatchDMapWithMove k q)
1943+ -> Event x (DMap k v)
1744−mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1944+mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
1745 where
1945 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)
1747 updateMe subscriber heightBagRef oldParents p = do
1947 updateMe subscriber heightBagRef oldParents p = do
1748 -- Prepare new parents for insertion
1948 -- 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)
1750 subscribeParent k e = do
1950 subscribeParent k e = do
1751 keyRef <- liftIO $ newIORef k
1951 keyRef <- liftIO $ newIORef k
1752 let s = subscriber $ liftIO $ readIORef keyRef
1952 let s = subscriber $ liftIO $ readIORef keyRef
@@ -1755,73 +1955,82 @@ mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1755 newParentHeight <- getEventSubscribedHeight subd
1955 newParentHeight <- getEventSubscribedHeight subd
1756 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1757 return $ MergeSubscribedParentWithMove subscription keyRef
1957 return $ MergeSubscribedParentWithMove subscription keyRef
1758− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
1759 -- Collect old parents for deletion and update the keys of moved parents
1959 -- Collect old parents for deletion and update the keys of moved parents
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
1761 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1762 Nothing -> do
1962 Nothing -> do
1763− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
1764 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1765 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1766 Just toKey -> do
1968 Just toKey -> do
1767 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1768 return Nothing
1970 return Nothing
1971+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1769− toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1972+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1973+
1770 return (toDelete, applyAlways p' oldParents)
1974 return (toDelete, applyAlways p' oldParents)
1771− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
1772 getInitialSubscribers initialParents subscriber = do
1976 getInitialSubscribers initialParents subscriber = do
1773 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1774 keyRef <- liftIO $ newIORef k
1978 keyRef <- liftIO $ newIORef k
1775 let s = subscriber $ liftIO $ readIORef keyRef
1979 let s = subscriber $ liftIO $ readIORef keyRef
1776− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1777 height <- liftIO $ getEventSubscribedHeight parentSubd
1981 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)
1779 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1780 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1781 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1782 )
1986 )
1987+
1783 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1784 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1785
1990
1786−type MergeUpdateFunc k x p s
1991+type MergeUpdateFunc k v x p s
1787− = (forall a. EventM x (k a) -> Subscriber x a)
1992+ = (forall a. EventM x (k a) -> Subscriber x (v a))
1788 -> IORef HeightBag
1993 -> IORef HeightBag
1789 -> DMap k s
1994 -> DMap k s
1790 -> p
1995 -> p
1791 -> EventM x ([EventSubscription x], DMap k s)
1996 -> EventM x ([EventSubscription x], DMap k s)
1792
1997
1998+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1999+
1793−type MergeInitFunc k x s
2000+type MergeInitFunc k v q x s
1794− = DMap k (Event x)
2001+ = DMap k q
1795− -> (forall a. EventM x (k a) -> Subscriber x a)
2002+ -> (forall a. EventM x (k a) -> Subscriber x (v a))
1796− -> EventM x (DMap k Identity, [Height], DMap k s)
2003+ -> EventM x (DMap k v, [Height], DMap k s)
1797
2004
1798type MergeDestroyFunc k s
2005type MergeDestroyFunc k s
1799 = DMap k s
2006 = DMap k s
1800 -> IO ()
2007 -> IO ()
1801
2008
1802−data Merge x k s = Merge
2009+data Merge x k v s = Merge
1803 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
2010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
1804 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
2011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
1805 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
2012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1806− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
1807− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
1808 }
2015 }
1809
2016
1810−invalidateMergeHeight :: Merge x k s -> IO ()
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
1811invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
2018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
1812
2019
1813invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
2020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
1814invalidateMergeHeight' heightRef sub = do
2021invalidateMergeHeight' heightRef sub = do
1815 oldHeight <- readIORef heightRef
2022 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
1817 writeIORef heightRef $! invalidHeight
2025 writeIORef heightRef $! invalidHeight
1818 subscriberInvalidateHeight sub oldHeight
2026 subscriberInvalidateHeight sub oldHeight
1819
2027
1820−
1821−revalidateMergeHeight :: Merge x k s -> IO ()
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
1822revalidateMergeHeight m = do
2029revalidateMergeHeight m = do
1823 currentHeight <- readIORef $ _merge_heightRef m
2030 currentHeight <- readIORef $ _merge_heightRef m
2031+
1824− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2032+ -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2033+ when (currentHeight == invalidHeight) $ do
1825 heights <- readIORef $ _merge_heightBagRef m
2034 heights <- readIORef $ _merge_heightBagRef m
1826 parents <- readIORef $ _merge_parentsRef m
2035 parents <- readIORef $ _merge_parentsRef m
1827 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
2036 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
@@ -1829,44 +2038,53 @@ revalidateMergeHeight m = do
1829 LT -> return ()
2038 LT -> return ()
1830 EQ -> do
2039 EQ -> do
1831 let height = succHeight $ heightBagMax heights
2040 let height = succHeight $ heightBagMax heights
1832− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
1833 writeIORef (_merge_heightRef m) $! height
2042 writeIORef (_merge_heightRef m) $! height
1834 subscriberRecalculateHeight (_merge_sub m) height
2043 subscriberRecalculateHeight (_merge_sub m) height
1835 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
2044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
1836
2045
1837−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
1838scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
2047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
1839 vals <- liftIO $ readIORef $ _merge_accumRef m
2048 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
1841 --TODO: Assert that m is not empty
2052 --TODO: Assert that m is not empty
1842 subscriberPropagate (_merge_sub m) vals
2053 subscriberPropagate (_merge_sub m) vals
1843
2054
2055+checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2056+checkCycle subscribed = liftIO $ do
2057+ height <- readIORef (eventSubscribedHeightRef subscribed)
2058+
2059+ -- currentHeight <- getCurrentHeight
2060+ -- when (height <= currentHeight) $ if height /= invalidHeight
2061+ -- then do
2062+ -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2063+ -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2064+ -- else liftIO $
2065+ when (height == invalidHeight) $
2066+#ifdef DEBUG_CYCLES
2067+ do
2068+ nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2069+ stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2070+ throwIO (EventLoopException stacks)
2071+#else
2072+ throwIO EventLoopException
2073+#endif
2074+
2075+
1844−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
2076+mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
1845−mergeSubscriber m getKey = Subscriber
2077+mergeSubscriber subscribed m getKey = Subscriber
1846 { subscriberPropagate = \a -> do
2078 { subscriberPropagate = \a -> do
1847 oldM <- liftIO $ readIORef $ _merge_accumRef m
2079 oldM <- liftIO $ readIORef $ _merge_accumRef m
1848 k <- getKey
2080 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
1850 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
2082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
1851 liftIO $ writeIORef (_merge_accumRef m) $! newM
2083 liftIO $ writeIORef (_merge_accumRef m) $! newM
1852 when (DMap.null oldM) $ do -- Only schedule the firing once
2084 when (DMap.null oldM) $ do -- Only schedule the firing once
1853 height <- liftIO $ readIORef $ _merge_heightRef m
2085 height <- liftIO $ readIORef $ _merge_heightRef m
1854− --TODO: assertions about height
2086+ checkCycle subscribed
1855− currentHeight <- getCurrentHeight
2087+
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
1870 scheduleMergeSelf m height
2088 scheduleMergeSelf m height
1871 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
2089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
1872 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
2090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1877,30 +2095,45 @@ mergeSubscriber m getKey = Subscriber
1877 }
2095 }
1878
2096
1879--TODO: Be able to run as much of this as possible promptly
2097--TODO: Be able to run as much of this as possible promptly
1880−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k s -> MergeUpdateFunc k x p s -> p -> SomeMergeUpdate x
2098+updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
1881−updateMerge m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2099+updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
1882 where updateMe = do
2100 where updateMe = do
1883 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
2101 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
1885 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
2103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
1886 return subscriptionsToKill
2104 return subscriptionsToKill
1887
2105
1888−{-# INLINE mergeCheap' #-}
2106+{-# INLINE mergeGCheap' #-}
2107+mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
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)
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)
1890−mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
2109+mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
1891 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
1892 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
2111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
1893 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
2112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
1894 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
2113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
1895 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
2114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
2115+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2116+
2117+ let subscribed = EventSubscribed
2118+ { eventSubscribedHeightRef = heightRef
2119+ , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
2120+#ifdef DEBUG_CYCLES
2121+ , eventSubscribedGetParents = do
2122+ let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
2123+ fmap getParent' . DMap.toList <$> readIORef parentsRef
2124+ , eventSubscribedHasOwnHeightRef = False
2125+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2126+#endif
2127+ }
2128+
1896− let m = Merge
2129+ m = Merge
1897 { _merge_parentsRef = parentsRef
2130 { _merge_parentsRef = parentsRef
1898 , _merge_heightBagRef = heightBagRef
2131 , _merge_heightBagRef = heightBagRef
1899 , _merge_heightRef = heightRef
2132 , _merge_heightRef = heightRef
1900 , _merge_sub = sub
2133 , _merge_sub = sub
1901 , _merge_accumRef = accumRef
2134 , _merge_accumRef = accumRef
1902 }
2135 }
1903− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
1904 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
2137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1905 myHeight = if invalidHeight `elem` heights
2138 myHeight = if invalidHeight `elem` heights
1906 then invalidHeight
2139 then invalidHeight
@@ -1909,50 +2142,57 @@ mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
1909 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
2142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1910 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
2143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1911 else (Nothing, dm)
2144 else (Nothing, dm)
1912− unless (DMap.null accum) $ do
1913− scheduleMergeSelf m myHeight
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
1914 liftIO $ writeIORef accumRef $! accum
2146 liftIO $ writeIORef accumRef $! accum
1915 liftIO $ writeIORef heightRef $! myHeight
2147 liftIO $ writeIORef heightRef $! myHeight
1916 liftIO $ writeIORef heightBagRef $! myHeightBag
2148 liftIO $ writeIORef heightBagRef $! myHeightBag
1917− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1918 liftIO $ writeIORef parentsRef $! initialParentState
2149 liftIO $ writeIORef parentsRef $! initialParentState
1919 defer $ SomeMergeInit $ do
2150 defer $ SomeMergeInit $ do
1920− let s = Subscriber
2151+ let changeSubscriber = Subscriber
1921 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1922− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
1923− defer $ updateMerge m updateFunc a
2154+ defer $ updateMerge subscribed m updateFunc a
1924 , subscriberInvalidateHeight = \_ -> return ()
2155 , subscriberInvalidateHeight = \_ -> return ()
1925 , subscriberRecalculateHeight = \_ -> return ()
2156 , subscriberRecalculateHeight = \_ -> return ()
1926 }
2157 }
1927− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2158+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
1928− forM_ change $ \c -> defer $ updateMerge m updateFunc c
2159+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
1929 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
1930 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
1931 -- its subscription.
2162 -- its subscription.
1932− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
1933 let unsubscribeAll = destroy =<< readIORef parentsRef
2164 let unsubscribeAll = destroy =<< readIORef parentsRef
1934− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1935− , occ
1936− )
1937
2165
2166+ return (EventSubscription unsubscribeAll subscribed, occ)
2167+
2168+
1938−mergeInt :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2169+mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
1939mergeInt = cacheEvent . mergeIntCheap
2170mergeInt = cacheEvent . mergeIntCheap
1940
2171
1941{-# INLINABLE mergeIntCheap #-}
2172{-# 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)
1943mergeIntCheap d = Event $ \sub -> do
2174mergeIntCheap d = Event $ \sub -> do
1944 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
1945 accum <- liftIO $ FastMutableIntMap.newEmpty
2176 accum <- liftIO $ FastMutableIntMap.newEmpty
1946 heightRef <- liftIO $ newIORef zeroHeight
2177 heightRef <- liftIO $ newIORef zeroHeight
1947 heightBagRef <- liftIO $ newIORef heightBagEmpty
2178 heightBagRef <- liftIO $ newIORef heightBagEmpty
1948 parents <- liftIO $ FastMutableIntMap.newEmpty
2179 parents <- liftIO $ FastMutableIntMap.newEmpty
2180+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2181+ let subscribed = EventSubscribed
2182+ { eventSubscribedHeightRef = heightRef
2183+ , eventSubscribedRetained = toAny (parents, changeSubdRef)
2184+#ifdef DEBUG_CYCLES
2185+ , eventSubscribedGetParents = fmap (_eventSubscription_subscribed . snd) <$> FastMutableIntMap.toList parents
2186+ , eventSubscribedHasOwnHeightRef = False
2187+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2188+#endif
2189+ }
1949 let scheduleSelf = do
2190 let scheduleSelf = do
1950 height <- liftIO $ readIORef $ heightRef
2191 height <- liftIO $ readIORef $ heightRef
1951 scheduleMerge' height heightRef $ do
2192 scheduleMerge' height heightRef $ do
1952 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
2193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
1953 subscriberPropagate sub vals
2194 subscriberPropagate sub vals
1954− invalidateMyHeight = do
1955− invalidateMergeHeight' heightRef sub
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
1956 recalculateMyHeight = do
2196 recalculateMyHeight = do
1957 currentHeight <- readIORef heightRef
2197 currentHeight <- readIORef heightRef
1958 when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
2198 when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
@@ -1962,12 +2202,14 @@ mergeIntCheap d = Event $ \sub -> do
1962 LT -> return ()
2202 LT -> return ()
1963 EQ -> do
2203 EQ -> do
1964 let height = succHeight $ heightBagMax heights
2204 let height = succHeight $ heightBagMax heights
1965− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
1966 writeIORef heightRef $! height
2206 writeIORef heightRef $! height
1967 subscriberRecalculateHeight sub height
2207 subscriberRecalculateHeight sub height
1968 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
2208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
1969 mySubscriber k = Subscriber
2209 mySubscriber k = Subscriber
1970 { subscriberPropagate = \a -> do
2210 { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
1971 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
1972 liftIO $ FastMutableIntMap.insert accum k a
2214 liftIO $ FastMutableIntMap.insert accum k a
1973 when wasEmpty scheduleSelf
2215 when wasEmpty scheduleSelf
@@ -2001,7 +2243,6 @@ mergeIntCheap d = Event $ \sub -> do
2001 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2002 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2003 return Nothing
2245 return Nothing
2004− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2005 defer $ SomeMergeInit $ do
2246 defer $ SomeMergeInit $ do
2006 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2007 where
2248 where
@@ -2015,35 +2256,39 @@ mergeIntCheap d = Event $ \sub -> do
2015 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2016 liftIO $ for_ oldParents $ \oldParent -> do
2257 liftIO $ for_ oldParents $ \oldParent -> do
2017 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
2018 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2019 return $ IntMap.elems oldParents
2262 return $ IntMap.elems oldParents
2020− let s = Subscriber
2263+ let changeSubscriber = Subscriber
2021 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2022 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2023 defer $ updateMe a
2266 defer $ updateMe a
2024 , subscriberInvalidateHeight = \_ -> return ()
2267 , subscriberInvalidateHeight = \_ -> return ()
2025 , subscriberRecalculateHeight = \_ -> return ()
2268 , subscriberRecalculateHeight = \_ -> return ()
2026 }
2269 }
2027− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2028 forM_ change $ \c -> defer $ updateMe c
2271 forM_ change $ \c -> defer $ updateMe c
2029 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2030 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2031 -- its subscription.
2274 -- its subscription.
2032− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2033 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2277+
2278+
2034− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
2035− , occ
2036− )
2037
2280
2038newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2281newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2282+newtype EventSelectorG x k v = EventSelectorG { selectG :: forall a. k a -> Event x (v a) }
2039
2283
2040−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2284+fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
2041−fan e =
2285+fanG e = unsafePerformIO $ do
2286+ ref <- newIORef Nothing
2042 let f = Fan
2287 let f = Fan
2043 { fanParent = e
2288 { fanParent = e
2044− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
2045 }
2290 }
2046− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
2047
2292
2048runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2049runHoldInits holdInitRef dynInitRef mergeInitRef = do
2294runHoldInits holdInitRef dynInitRef mergeInitRef = do
@@ -2096,37 +2341,37 @@ clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeI
2096
2341
2097-- | Run an event action outside of a frame
2342-- | Run an event action outside of a frame
2098runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2099−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2344+runFrame a = SpiderHost $ do
2100− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
2101 let go = do
2346 let go = do
2102 result <- a
2347 result <- a
2103 runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
2348 runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
2104 return result
2349 return result
2105 result <- runEventM go
2350 result <- runEventM go
2106 toClear <- readIORef $ eventEnvClears env
2351 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
2108 toClearInt <- readIORef $ eventEnvIntClears env
2353 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
2110 toClearRoot <- readIORef $ eventEnvRootClears env
2355 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
2112 toAssign <- readIORef $ eventEnvAssignments env
2357 toAssign <- readIORef $ eventEnvAssignments env
2113 toReconnectRef <- newIORef []
2358 toReconnectRef <- newIORef []
2114 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2115 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2116 writeIORef vRef v
2361 writeIORef vRef v
2117− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
2118 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2119 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2120 writeIORef (eventEnvMergeUpdates env) []
2365 writeIORef (eventEnvMergeUpdates env) []
2121− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
2122 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2123− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
2124 toReconnect <- readIORef toReconnectRef
2369 toReconnect <- readIORef toReconnectRef
2125 clearEventEnv env
2370 clearEventEnv env
2126 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2127 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2128 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2129− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2130 finalize wi
2375 finalize wi
2131 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2132 wi' <- mkWeakPtrWithDebug i "wi'"
2377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2137,10 +2382,10 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2137 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
2382 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
2138 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
2383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
2139 sub <- newSubscriberSwitch subscribed
2384 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
2141 {-
2386 {-
2142 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2387 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
2144 EventRoot _ -> "EventRoot"
2389 EventRoot _ -> "EventRoot"
2145 EventNever -> "EventNever"
2390 EventNever -> "EventNever"
2146 _ -> "something else"
2391 _ -> "something else"
@@ -2155,7 +2400,7 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2155 myHeight <- readIORef $ switchSubscribedHeight subscribed
2400 myHeight <- readIORef $ switchSubscribedHeight subscribed
2156 when (parentHeight /= myHeight) $ do
2401 when (parentHeight /= myHeight) $ do
2157 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2158− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2159 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
2404 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
2160 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2161 unsubscribe subscription
2406 unsubscribe subscription
@@ -2196,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
2196 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2197 when (oldHeight /= invalidHeight) $ do
2442 when (oldHeight /= invalidHeight) $ do
2198 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2199− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2200
2445
2201updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2202updateSwitchHeight new subscribed = do
2447updateSwitchHeight new subscribed = do
@@ -2204,7 +2449,7 @@ updateSwitchHeight new subscribed = do
2204 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2205 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2206 writeIORef (switchSubscribedHeight subscribed) $! new
2451 writeIORef (switchSubscribedHeight subscribed) $! new
2207− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2208
2453
2209recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2210recalculateCoincidenceHeight subscribed = do
2455recalculateCoincidenceHeight subscribed = do
@@ -2213,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
2213 height <- calculateCoincidenceHeight subscribed
2458 height <- calculateCoincidenceHeight subscribed
2214 when (height /= invalidHeight) $ do
2459 when (height /= invalidHeight) $ do
2215 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2216− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2217
2462
2218calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2219calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
2464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -2252,14 +2497,219 @@ invalidate toReconnectRef wis = do
2252-- Reflex integration
2497-- Reflex integration
2253--------------------------------------------------------------------------------
2498--------------------------------------------------------------------------------
2254
2499
2255−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2500+-- | Designates the default, global Spider timeline
2256−-- When we're specializing, we include this from Reflex.Class instead, because
2501+data SpiderTimeline x
2257−-- it needs access to these types; when we're not, we want them here, so our
2502+type role SpiderTimeline nominal
2258−-- instance isn't an orphan instance.
2503+
2259−#include "SpiderTimeline.include.hs"
2504+-- | The default, global Spider environment
2260−#include "SpiderTimelineHost.include.hs"
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'"
2261#endif
2560#endif
2262
2561
2562+{-# INLINABLE newJoinDyn #-}
2563+newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
2564+newJoinDyn d =
2565+ let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2566+ eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
2567+ eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
2568+ eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
2569+ v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
2570+ in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
2571+
2572+instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
2573+ fmap = mapDynamicSpider
2574+ x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
2575+
2576+mapDynamicSpider :: HasSpiderTimeline x => (a -> b) -> Reflex.Class.Dynamic (SpiderTimeline x) a -> Reflex.Class.Dynamic (SpiderTimeline x) b
2577+mapDynamicSpider f = SpiderDynamic . newMapDyn f . unSpiderDynamic
2578+{-# INLINE [1] mapDynamicSpider #-}
2579+
2580+instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
2581+ pure = SpiderDynamic . dynamicConst
2582+#if MIN_VERSION_base(4,10,0)
2583+ liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
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+
2263unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
2713unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
2264unsafeNewSpiderTimelineEnv = do
2714unsafeNewSpiderTimelineEnv = do
2265 lock <- newMVar ()
2715 lock <- newMVar ()
@@ -2267,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
2267#ifdef DEBUG
2717#ifdef DEBUG
2268 depthRef <- newIORef 0
2718 depthRef <- newIORef 0
2269#endif
2719#endif
2270− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
2271 { _spiderTimeline_lock = lock
2721 { _spiderTimeline_lock = lock
2272 , _spiderTimeline_eventEnv = env
2722 , _spiderTimeline_eventEnv = env
2273#ifdef DEBUG
2723#ifdef DEBUG
@@ -2275,43 +2725,40 @@ unsafeNewSpiderTimelineEnv = do
2275#endif
2725#endif
2276 }
2726 }
2277
2727
2278−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2279-- | Create a new SpiderTimelineEnv
2728-- | Create a new SpiderTimelineEnv
2280newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2281−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
2282
2731
2283−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
2284
2733
2285instance Reifies s (SpiderTimelineEnv x) =>
2734instance Reifies s (SpiderTimelineEnv x) =>
2286 HasSpiderTimeline (LocalSpiderTimeline x s) where
2735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2287− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
2288
2737
2289localSpiderTimeline
2738localSpiderTimeline
2290− :: Proxy s
2739+ :: proxy s
2291 -> SpiderTimelineEnv x
2740 -> SpiderTimelineEnv x
2292 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2293−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
2294
2743
2295-- | Pass a new timeline to the given function.
2744-- | Pass a new timeline to the given function.
2296withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2297withSpiderTimeline k = do
2746withSpiderTimeline k = do
2298 env <- unsafeNewSpiderTimelineEnv
2747 env <- unsafeNewSpiderTimelineEnv
2299 reify env $ \s -> k $ localSpiderTimeline s env
2748 reify env $ \s -> k $ localSpiderTimeline s env
2300−#endif
2301
2749
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)
2303
2751
2304type ComputeM = EventM
2752type ComputeM = EventM
2305
2753
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)
2307
2755
2308−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2309instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2310 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2311 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2312 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2759 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)
2760+ newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2314− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
2761+ newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
2315 type PullM (SpiderTimeline x) = SpiderPullM x
2762 type PullM (SpiderTimeline x) = SpiderPullM x
2316 type PushM (SpiderTimeline x) = SpiderPushM x
2763 type PushM (SpiderTimeline x) = SpiderPushM x
2317 {-# INLINABLE never #-}
2764 {-# INLINABLE never #-}
@@ -2324,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2324 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2325 {-# INLINABLE pull #-}
2772 {-# INLINABLE pull #-}
2326 pull = SpiderBehavior . pull . coerce
2773 pull = SpiderBehavior . pull . coerce
2327− {-# INLINABLE merge #-}
2774+ {-# INLINABLE fanG #-}
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))
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
2331 {-# INLINABLE switch #-}
2783 {-# INLINABLE switch #-}
2332 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2333 {-# INLINABLE coincidence #-}
2785 {-# INLINABLE coincidence #-}
@@ -2335,15 +2787,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2335 {-# INLINABLE current #-}
2787 {-# INLINABLE current #-}
2336 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2337 {-# INLINABLE updated #-}
2789 {-# INLINABLE updated #-}
2338− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
2339 {-# INLINABLE unsafeBuildDynamic #-}
2791 {-# INLINABLE unsafeBuildDynamic #-}
2340 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2341 {-# INLINABLE unsafeBuildIncremental #-}
2793 {-# INLINABLE unsafeBuildIncremental #-}
2342 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2343− {-# INLINABLE mergeIncremental #-}
2795+ {-# INLINABLE mergeIncrementalG #-}
2344− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2796+ mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2345− {-# INLINABLE mergeIncrementalWithMove #-}
2797+ {-# INLINABLE mergeIncrementalWithMoveG #-}
2346− mergeIncrementalWithMove = SpiderEvent . mergeWithMove . (unsafeCoerce :: Dynamic x (PatchDMapWithMove k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMapWithMove k (Event x))) . unSpiderIncremental
2798+ mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
2347 {-# INLINABLE currentIncremental #-}
2799 {-# INLINABLE currentIncremental #-}
2348 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2349 {-# INLINABLE updatedIncremental #-}
2801 {-# INLINABLE updatedIncremental #-}
@@ -2354,12 +2806,12 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2354 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2355 eventCoercion Coercion = Coercion
2807 eventCoercion Coercion = Coercion
2356 behaviorCoercion Coercion = Coercion
2808 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
2358 {-# INLINABLE mergeIntIncremental #-}
2811 {-# 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
2360 {-# INLINABLE fanInt #-}
2813 {-# INLINABLE fanInt #-}
2361 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2362−#endif
2363
2815
2364data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2816data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2365
2817
@@ -2382,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
2382 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2383
2835
2384-- | The monad for actions that manipulate a Spider timeline identified by @x@
2836-- | The monad for actions that manipulate a Spider timeline identified by @x@
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)
2386
2838
2387instance Monad (SpiderHost x) where
2839instance Monad (SpiderHost x) where
2388 {-# INLINABLE (>>=) #-}
2840 {-# INLINABLE (>>=) #-}
@@ -2391,22 +2843,27 @@ instance Monad (SpiderHost x) where
2391 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2392 {-# INLINABLE return #-}
2844 {-# INLINABLE return #-}
2393 return x = SpiderHost $ return x
2845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
2394 {-# INLINABLE fail #-}
2847 {-# INLINABLE fail #-}
2848+ fail = MonadFail.fail
2849+#endif
2850+
2851+instance MonadFail (SpiderHost x) where
2852+ {-# INLINABLE fail #-}
2395− fail s = SpiderHost $ fail s
2853+ fail s = SpiderHost $ MonadFail.fail s
2396
2854
2397-- | Run an action affecting the global Spider timeline; this will be guarded by
2855-- | Run an action affecting the global Spider timeline; this will be guarded by
2398-- a mutex for that timeline
2856-- a mutex for that timeline
2399runSpiderHost :: SpiderHost Global a -> IO a
2857runSpiderHost :: SpiderHost Global a -> IO a
2400−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimelineEnv
2858+runSpiderHost (SpiderHost a) = a
2401
2859
2402−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2403-- | Run an action affecting a given Spider timeline; this will be guarded by a
2860-- | Run an action affecting a given Spider timeline; this will be guarded by a
2404-- mutex for that timeline
2861-- mutex for that timeline
2405runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2406−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2863+runSpiderHostForTimeline (SpiderHost a) _ = a
2407−#endif
2408
2864
2865+newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2409−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2866+ deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2410
2867
2411instance Monad (SpiderHostFrame x) where
2868instance Monad (SpiderHostFrame x) where
2412 {-# INLINABLE (>>=) #-}
2869 {-# INLINABLE (>>=) #-}
@@ -2415,15 +2872,21 @@ instance Monad (SpiderHostFrame x) where
2415 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2416 {-# INLINABLE return #-}
2873 {-# INLINABLE return #-}
2417 return x = SpiderHostFrame $ return x
2874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
2418 {-# INLINABLE fail #-}
2876 {-# INLINABLE fail #-}
2419 fail s = SpiderHostFrame $ fail s
2877 fail s = SpiderHostFrame $ fail s
2878+#endif
2420
2879
2880+instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2881+ notReadyUntil _ = pure ()
2882+ notReady = pure ()
2883+
2421−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2884+newEventWithTriggerIO :: forall x a. HasSpiderTimeline x => (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2422newEventWithTriggerIO f = do
2885newEventWithTriggerIO f = do
2423 es <- newFanEventWithTriggerIO $ \Refl -> f
2886 es <- newFanEventWithTriggerIO $ \Refl -> f
2424 return $ select es Refl
2887 return $ select es Refl
2425
2888
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)
2427newFanEventWithTriggerIO f = do
2890newFanEventWithTriggerIO f = do
2428 occRef <- newIORef DMap.empty
2891 occRef <- newIORef DMap.empty
2429 subscribedRef <- newIORef DMap.empty
2892 subscribedRef <- newIORef DMap.empty
@@ -2457,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
2457instance PrimMonad (SpiderHostFrame x) where
2920instance PrimMonad (SpiderHostFrame x) where
2458 type PrimState (SpiderHostFrame x) = PrimState IO
2921 type PrimState (SpiderHostFrame x) = PrimState IO
2459 primitive = SpiderHostFrame . EventM . primitive
2922 primitive = SpiderHostFrame . EventM . primitive
2923+
2924+instance NotReady (SpiderTimeline x) (SpiderHost x) where
2925+ notReadyUntil _ = return ()
2926+ notReady = return ()
2927+
2928+instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
2929+ notReadyUntil _ = return ()
2930+ notReady = return ()
src/Reflex/Spider/SpiderTimeline.include.hsdeleted−152
@@ -1,152 +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 (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
23−
24−instance (
25−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
26− x ~ Global
27−#endif
28− ) => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
29− {-# INLINABLE sample #-}
30− sample = coerce . readBehaviorTracked . unSpiderBehavior
31−
32−instance (
33−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
34− x ~ Global
35−#else
36− HasSpiderTimeline x
37−#endif
38− ) => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
39− {-# INLINABLE sample #-}
40− sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
41−
42−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
43− {-# INLINABLE hold #-}
44− hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
45− {-# INLINABLE holdDyn #-}
46− holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
47− {-# INLINABLE holdIncremental #-}
48− holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
49− {-# INLINABLE buildDynamic #-}
50− buildDynamic getV0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce e
51− {-# INLINABLE headE #-}
52− headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
53−
54−instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
55− {-# INLINE return #-}
56− return = pure
57− {-# INLINE (>>=) #-}
58− x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
59− {-# INLINE (>>) #-}
60− _ >> y = y
61− {-# INLINE fail #-}
62− fail _ = error "Dynamic does not support 'fail'"
63−
64−{-# INLINABLE newJoinDyn #-}
65−newJoinDyn :: HasSpiderTimeline x => Reflex.Spider.Internal.Dynamic x (Identity (Reflex.Spider.Internal.Dynamic x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
66−newJoinDyn d =
67− let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
68− eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
69− eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
70− eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
71− v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
72− in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
73−
74−instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
75− fmap f = SpiderDynamic . newMapDyn f . unSpiderDynamic
76− x <$ _ = pure x
77−
78−instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
79− pure = SpiderDynamic . dynamicConst
80−#if MIN_VERSION_base(4,10,0)
81− liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
82−#endif
83− SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
84− _ *> b = b
85− a <* _ = a --TODO: The semantics of *>, <*, and <$ might not be quite right - they drop changes
86−
87−holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
88−holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
89−
90−holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
91−holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
92−
93−holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
94−holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
95−
96−buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPullM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
97−buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
98−
99−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
100− {-# INLINABLE hold #-}
101− hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
102− {-# INLINABLE holdDyn #-}
103− holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
104− {-# INLINABLE holdIncremental #-}
105− holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
106− {-# INLINABLE buildDynamic #-}
107− buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
108− {-# INLINABLE headE #-}
109− headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
110−
111−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
112− sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
113−
114−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
115− {-# INLINABLE hold #-}
116− hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
117− {-# INLINABLE holdDyn #-}
118− holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
119− {-# INLINABLE holdIncremental #-}
120− holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
121− {-# INLINABLE buildDynamic #-}
122− buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
123− {-# INLINABLE headE #-}
124− headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
125−
126−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
127− {-# INLINABLE sample #-}
128− sample = runFrame . readBehaviorUntracked . unSpiderBehavior
129−
130−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
131− {-# INLINABLE sample #-}
132− sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
133−
134−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
135− {-# INLINABLE hold #-}
136− hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
137− {-# INLINABLE holdDyn #-}
138− holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
139− {-# INLINABLE holdIncremental #-}
140− holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
141− {-# INLINABLE buildDynamic #-}
142− buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
143− {-# INLINABLE headE #-}
144− headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
145−
146−--------------------------------------------------------------------------------
147−-- Deprecated items
148−--------------------------------------------------------------------------------
149−
150−-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
151−{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
152−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
13 , EventTriggerRef (..)
13 , EventTriggerRef (..)
14 ) where
14 ) where
15
15
16+import Control.Applicative (liftA2)
16import Control.Concurrent
17import Control.Concurrent
17import Control.Monad.Exception
18import Control.Monad.Exception
18import Control.Monad.Primitive
19import Control.Monad.Primitive
@@ -21,7 +22,10 @@ import Control.Monad.Ref
21import Data.Coerce
22import Data.Coerce
22import Data.Dependent.Sum
23import Data.Dependent.Sum
23import Data.IORef
24import Data.IORef
25+import Data.Monoid ((<>))
26+import qualified Data.Semigroup as S
24import Reflex.Class
27import Reflex.Class
28+import Reflex.Adjustable.Class
25import Reflex.Host.Class
29import Reflex.Host.Class
26import Reflex.PerformEvent.Class
30import Reflex.PerformEvent.Class
27import Reflex.PostBuild.Class
31import Reflex.PostBuild.Class
@@ -118,8 +122,10 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
118 buildDynamic a0 = lift . buildDynamic a0
122 buildDynamic a0 = lift . buildDynamic a0
119 {-# INLINABLE headE #-}
123 {-# INLINABLE headE #-}
120 headE = lift . headE
124 headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
121
127
122−instance MonadAdjust t m => MonadAdjust t (TriggerEventT t m) where
128+instance Adjustable t m => Adjustable t (TriggerEventT t m) where
123 {-# INLINABLE runWithReplace #-}
129 {-# INLINABLE runWithReplace #-}
124 runWithReplace (TriggerEventT a0) a' = TriggerEventT $ runWithReplace a0 (coerceEvent a')
130 runWithReplace (TriggerEventT a0) a' = TriggerEventT $ runWithReplace a0 (coerceEvent a')
125 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
131 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
@@ -129,6 +135,15 @@ instance MonadAdjust t m => MonadAdjust t (TriggerEventT t m) where
129 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
135 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
130 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = TriggerEventT $ traverseDMapWithKeyWithAdjustWithMove (coerce . f) dm0 dm'
136 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = TriggerEventT $ traverseDMapWithKeyWithAdjustWithMove (coerce . f) dm0 dm'
131
137
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+
132-- | Retrieve the current 'Chan'; event trigger invocations pushed into it will
147-- | Retrieve the current 'Chan'; event trigger invocations pushed into it will
133-- be fired.
148-- be fired.
134askEvents :: Monad m => TriggerEventT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
149askEvents :: Monad m => TriggerEventT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
src/Reflex/TriggerEvent/Class.hs+6−1
@@ -2,7 +2,6 @@
2-- new 'Event's that can be triggered from 'IO'.
2-- new 'Event's that can be triggered from 'IO'.
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE UndecidableInstances #-}
5{-# LANGUAGE UndecidableInstances #-}
7module Reflex.TriggerEvent.Class
6module Reflex.TriggerEvent.Class
8 ( TriggerEvent (..)
7 ( TriggerEvent (..)
@@ -13,6 +12,7 @@ import Reflex.Class
13import Control.Monad.Reader
12import Control.Monad.Reader
14import Control.Monad.State
13import Control.Monad.State
15import qualified Control.Monad.State.Strict as Strict
14import qualified Control.Monad.State.Strict as Strict
15+import Control.Monad.Trans.Maybe (MaybeT)
16
16
17--TODO: Shouldn't have IO hard-coded
17--TODO: Shouldn't have IO hard-coded
18-- | 'TriggerEvent' represents actions that can create 'Event's that can be
18-- | 'TriggerEvent' represents actions that can create 'Event's that can be
@@ -48,3 +48,8 @@ instance TriggerEvent t m => TriggerEvent t (Strict.StateT s m) where
48 newTriggerEvent = lift newTriggerEvent
48 newTriggerEvent = lift newTriggerEvent
49 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
49 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
50 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
50 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
51+
52+instance TriggerEvent t m => TriggerEvent t (MaybeT m) where
53+ newTriggerEvent = lift newTriggerEvent
54+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
55+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
src/Reflex/Widget/Basic.hs+4−2
@@ -10,8 +10,10 @@ module Reflex.Widget.Basic where
10
10
11import Control.Monad.Fix (MonadFix)
11import Control.Monad.Fix (MonadFix)
12import Data.Map (Map)
12import Data.Map (Map)
13+
13import Reflex.Class
14import Reflex.Class
15+import Reflex.Adjustable.Class
14−import Reflex.Patch.MapWithMove
16+import Data.Patch.MapWithMove
15
17
16
18
17-- | Build sortable content in such a way that re-sorting it can cause minimal
19-- | Build sortable content in such a way that re-sorting it can cause minimal
@@ -30,7 +32,7 @@ import Reflex.Patch.MapWithMove
30-- > (\k v -> text $ "\n" ++ show k ++ " " ++ v) -- show each element on a new line
32-- > (\k v -> text $ "\n" ++ show k ++ " " ++ v) -- show each element on a new line
31-- > (Map.fromList $ zip [0..] [(3, "a"), (2, "b"), (1, "c")])
33-- > (Map.fromList $ zip [0..] [(3, "a"), (2, "b"), (1, "c")])
32-- > sortEvent
34-- > 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)
34 => (k -> v -> m a) -- ^ Function to render the content for each key/value pair
36 => (k -> v -> m a) -- ^ Function to render the content for each key/value pair
35 -> Map k v -- ^ The sortable list with an initial ordering determined by the @Map@ keys in ascending order
37 -> Map k v -- ^ The sortable list with an initial ordering determined by the @Map@ keys in ascending order
36 -> Event t (v -> v -> Ordering) -- ^ An event carrying a sort function for the list
38 -> 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 CPP #-}
2+{-# LANGUAGE BangPatterns #-}
1−{-# LANGUAGE FlexibleContexts, GADTs #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
2module Main where
7module Main where
3
8
4import Control.Lens
9import Control.Lens
5import Control.Monad
10import 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
6import Data.These
15import Data.These
7
16
17+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
18+import Data.These.Lens
19+#endif
20+
8import Reflex
21import Reflex
9−import Reflex.EventWriter
22+import Reflex.EventWriter.Base
10import Test.Run
23import Test.Run
11
24
12main :: IO ()
25main :: IO ()
@@ -23,6 +36,15 @@ main = do
23 , These () ()
36 , These () ()
24 ]
37 ]
25 print os2
38 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
26 return ()
48 return ()
27
49
28unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
50unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
@@ -31,14 +53,82 @@ unwrapApp x appIn = do
31 return e
53 return e
32
54
33testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
55testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
34−testOrdering pulse = do
35− forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
56+testOrdering pulse = forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
36− return ()
37
57
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 ()
39testSimultaneous pulse = do
59testSimultaneous pulse = do
40 let e0 = fmapMaybe (^? here) pulse
60 let e0 = fmapMaybe (^? here) pulse
41 e1 = fmapMaybe (^? there) pulse
61 e1 = fmapMaybe (^? there) pulse
42 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
62 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
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)
43 return ()
120 return ()
44
121
122+delayedPulse
123+ :: forall t m
124+ . ( Reflex t
125+ , Adjustable t m
126+ , MonadHold t m
127+ , MonadFix m
128+ )
129+ => Event t ()
130+ -> EventWriterT t [Int] m ()
131+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
132+ -- This has the effect of delaying pulse' from pulse
133+ (_, pulse') <- runWithReplace (pure ()) $ pure [1] <$ pulse
134+ tellEvent pulse'
test/GC.hs+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 #-}
2module Main where
7module Main where
3
8
4import Control.Monad
9import Control.Monad
@@ -13,15 +18,17 @@ import Data.GADT.Compare
13import Data.IORef
18import Data.IORef
14import Data.Semigroup
19import Data.Semigroup
15import Data.These
20import Data.These
21+import Data.Type.Equality ((:~:)(Refl))
16
22
17import Data.Functor.Misc
23import Data.Functor.Misc
18−import Reflex.Patch
24+import Data.Patch
19
25
20−import qualified Reflex.Spider.Internal as S
21import qualified Reflex.Host.Class as Host
26import qualified Reflex.Host.Class as Host
27+import qualified Reflex.Spider.Internal as S
22
28
23−import System.Mem
24import System.Exit
29import System.Exit
30+import System.Mem
31+import Data.Coerce
25
32
26main :: IO ()
33main :: IO ()
27main = do
34main = do
@@ -41,7 +48,7 @@ hostPerf ref = S.runSpiderHost $ do
41 eventToPerform <- Host.runHostFrame $ do
48 eventToPerform <- Host.runHostFrame $ do
42 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
49 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
43 <- S.SpiderHostFrame
50 <- S.SpiderHostFrame
44− $ fmap ( S.merge
51+ $ fmap ( S.mergeG coerce
45 . S.dynamicHold)
52 . S.dynamicHold)
46 $ S.hold DMap.empty
53 $ S.hold DMap.empty
47 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
54 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
@@ -50,8 +57,8 @@ hostPerf ref = S.runSpiderHost $ do
50 { S.subscriberPropagate = S.subscriberPropagate sub
57 { S.subscriberPropagate = S.subscriberPropagate sub
51 }
58 }
52 return (s, o))
59 return (s, o))
53− $ runIdentity <$> S.select
60+ $ runIdentity . runIdentity <$> S.selectG
54− (S.fan $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
61+ (S.fanG $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
55 (WrapArg Request)
62 (WrapArg Request)
56 return $ alignWith (mergeThese (<>))
63 return $ alignWith (mergeThese (<>))
57 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
64 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
@@ -77,7 +84,6 @@ hostPerf ref = S.runSpiderHost $ do
77 Nothing -> []
84 Nothing -> []
78 Host.fireEventsAndRead followupEventTriggers $ return ()
85 Host.fireEventsAndRead followupEventTriggers $ return ()
79 return ()
86 return ()
80− return ()
81
87
82data Tell a where
88data Tell a where
83 Action :: Tell ()
89 Action :: Tell ()
test/Headless.hsnew file+10
@@ -0,0 +1,10 @@
1+module Main where
2+
3+import Reflex
4+import Reflex.Host.Headless (runHeadlessApp)
5+
6+main :: IO ()
7+main = do
8+ runHeadlessApp $ do
9+ pb <- getPostBuild
10+ performEvent (pure <$> pb)
test/QueryT.hs+24−22
@@ -1,24 +1,30 @@
1+{-# LANGUAGE CPP #-}
1{-# LANGUAGE DeriveFunctor #-}
2{-# LANGUAGE DeriveFunctor #-}
2{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE TypeFamilies #-}
4{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5{-# LANGUAGE LambdaCase #-}
5{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE OverloadedStrings #-}
7{-# LANGUAGE RankNTypes #-}
6{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
8
10
9import Control.Lens
11import Control.Lens
10import Control.Monad.Fix
12import Control.Monad.Fix
11import Data.Align
13import Data.Align
12−import Data.AppendMap (AppendMap)
13import qualified Data.AppendMap as AMap
14import qualified Data.AppendMap as AMap
14import Data.Functor.Misc
15import Data.Functor.Misc
15import Data.Map (Map)
16import Data.Map (Map)
16import qualified Data.Map as Map
17import qualified Data.Map as Map
18+import Data.Map.Monoidal (MonoidalMap)
17import Data.Semigroup
19import Data.Semigroup
18import Data.These
20import Data.These
19
21
22+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
23+import Data.These.Lens
24+#endif
25+
20import Reflex
26import Reflex
21−import Reflex.Patch.MapWithMove
27+import Data.Patch.MapWithMove
22import Test.Run
28import Test.Run
23
29
24newtype MyQuery = MyQuery SelectedCount
30newtype MyQuery = MyQuery SelectedCount
@@ -28,14 +34,18 @@ instance Query MyQuery where
28 type QueryResult MyQuery = ()
34 type QueryResult MyQuery = ()
29 crop _ _ = ()
35 crop _ _ = ()
30
36
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
32 type QueryResult (Selector k a) = Selector k (QueryResult a)
38 type QueryResult (Selector k a) = Selector k (QueryResult a)
33 crop q r = undefined
39 crop q r = undefined
34
40
35−newtype Selector k a = Selector { unSelector :: AppendMap k a }
41+newtype Selector k a = Selector { unSelector :: MonoidalMap k a }
36 deriving (Show, Read, Eq, Ord, Functor)
42 deriving (Show, Read, Eq, Ord, Functor)
37
43
44+#if !(MIN_VERSION_monoidal_containers(0,4,1))
45+deriving instance Ord k => Align (MonoidalMap k)
46+#endif
47+
38−instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
48+instance (Ord k, Eq a, Monoid a, Align (MonoidalMap k)) => Semigroup (Selector k a) where
39 (Selector a) <> (Selector b) = Selector $ fmapMaybe id $ f a b
49 (Selector a) <> (Selector b) = Selector $ fmapMaybe id $ f a b
40 where
50 where
41 f = alignWith $ \case
51 f = alignWith $ \case
@@ -45,14 +55,14 @@ instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
45 let z = x `mappend` y
55 let z = x `mappend` y
46 in if z == mempty then Nothing else Just z
56 in if z == mempty then Nothing else Just z
47
57
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
49 mempty = Selector AMap.empty
59 mempty = Selector AMap.empty
50 mappend = (<>)
60 mappend = (<>)
51
61
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
53 negateG = fmap negateG
63 negateG = fmap negateG
54
64
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)
56
66
57main :: IO ()
67main :: IO ()
58main = do
68main = do
@@ -82,7 +92,7 @@ testQueryT w (AppIn _ pulse) = do
82 }
92 }
83
93
84testRunWithReplace :: ( Reflex t
94testRunWithReplace :: ( Reflex t
85− , MonadAdjust t m
95+ , Adjustable t m
86 , MonadHold t m
96 , MonadHold t m
87 , MonadFix m
97 , MonadFix m
88 , MonadQuery t (Selector Int MyQuery) m)
98 , MonadQuery t (Selector Int MyQuery) m)
@@ -97,7 +107,7 @@ testRunWithReplace replace increment = do
97 return ()
107 return ()
98
108
99testSequenceDMapWithAdjust :: ( Reflex t
109testSequenceDMapWithAdjust :: ( Reflex t
100− , MonadAdjust t m
110+ , Adjustable t m
101 , MonadHold t m
111 , MonadHold t m
102 , MonadFix m
112 , MonadFix m
103 , MonadQuery t (Selector Int MyQuery) m)
113 , MonadQuery t (Selector Int MyQuery) m)
@@ -111,7 +121,7 @@ testSequenceDMapWithAdjust replace increment = do
111 return ()
121 return ()
112
122
113testSequenceDMapWithAdjustWithMove :: ( Reflex t
123testSequenceDMapWithAdjustWithMove :: ( Reflex t
114− , MonadAdjust t m
124+ , Adjustable t m
115 , MonadHold t m
125 , MonadHold t m
116 , MonadFix m
126 , MonadFix m
117 , MonadQuery t (Selector Int MyQuery) m)
127 , MonadQuery t (Selector Int MyQuery) m)
@@ -124,16 +134,8 @@ testSequenceDMapWithAdjustWithMove replace increment = do
124 queryDyn $ zipDynWith (\x y -> Selector (AMap.singleton (x :: Int) y)) n $ pure $ MyQuery $ SelectedCount 1
134 queryDyn $ zipDynWith (\x y -> Selector (AMap.singleton (x :: Int) y)) n $ pure $ MyQuery $ SelectedCount 1
125 return ()
135 return ()
126
136
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−
135-- scam it out to test traverseDMapWithAdjustWithMove
137-- 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))
137listHoldWithKeyWithMove m0 m' f = do
139listHoldWithKeyWithMove m0 m' f = do
138 (n0, n') <- mapMapWithAdjustWithMove f m0 $ ffor m' $ PatchMapWithMove . Map.map (\v -> NodeInfo (maybe From_Delete From_Insert v) Nothing)
140 (n0, n') <- mapMapWithAdjustWithMove f m0 $ ffor m' $ PatchMapWithMove . Map.map (\v -> NodeInfo (maybe From_Delete From_Insert v) Nothing)
139 incrementalToDynamic <$> holdIncremental n0 n'
141 incrementalToDynamic <$> holdIncremental n0 n'
test/Reflex/Bench/Focused.hs+13−1
@@ -130,6 +130,16 @@ mapDynChain = iterM (return . fmap (+1))
130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
132
132
133+holdDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134+holdDynChain = iterM (\d -> sample (current d) >>= flip holdDyn (updated d))
135+
136+buildDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
137+buildDynChain = iterM (\d -> do
138+ let b = fmap (+1) (current d)
139+ e = fmap (*2) (updated d)
140+ buildDynamic (sample b) e)
141+
142+
133combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
143combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
144combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
135
145
@@ -184,7 +194,7 @@ switchMergeBehaviors mapChanges = pull . joinMap <$> holdMap mapChanges
184
194
185-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
195-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
186holdMapDyn :: (Reflex t, MonadHold t m, MonadFix m, Ord k) => UpdatedMap t k a -> m (Dynamic t (Map k a))
196holdMapDyn :: (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
188
198
189 where
199 where
190 modify k Nothing items = Map.delete k items
200 modify k Nothing items = Map.delete k items
@@ -308,6 +318,8 @@ dynamics :: Word -> [(String, TestCase)]
308dynamics n =
318dynamics n =
309 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
319 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
310 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
320 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
321+ , testE "holdDynChain" $ fmap updated $ holdDynChain n =<< d
322+ , testE "buildDynChain" $ fmap updated $ buildDynChain n =<< d
311 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
323 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
312 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
324 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
313 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
325 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
test/Reflex/Plan/Pure.hs+5−4
@@ -41,6 +41,7 @@ instance MonadHold (Pure Int) PurePlan where
41 holdIncremental initial = liftPlan . holdIncremental initial
41 holdIncremental initial = liftPlan . holdIncremental initial
42 buildDynamic getInitial = liftPlan . buildDynamic getInitial
42 buildDynamic getInitial = liftPlan . buildDynamic getInitial
43 headE = liftPlan . headE
43 headE = liftPlan . headE
44+ now = liftPlan now
44
45
45instance MonadSample (Pure Int) PurePlan where
46instance MonadSample (Pure Int) PurePlan where
46 sample = liftPlan . sample
47 sample = liftPlan . sample
@@ -55,15 +56,15 @@ instance TestPlan (Pure Int) PurePlan where
55runPure :: PurePlan a -> (a, IntSet)
56runPure :: PurePlan a -> (a, IntSet)
56runPure (PurePlan p) = runStateT p mempty $ 0
57runPure (PurePlan p) = runStateT p mempty $ 0
57
58
58−relavantTimes :: IntSet -> IntSet
59+relevantTimes :: IntSet -> IntSet
59−relavantTimes occs = IntSet.fromList [0..l + 1]
60+relevantTimes occs = IntSet.fromList [0..l + 1]
60 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
61 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
61
62
62testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63−testBehavior (b, occs) = IntMap.fromSet (sample b) (relavantTimes occs)
64+testBehavior (b, occs) = IntMap.fromSet (sample b) (relevantTimes occs)
64
65
65testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66−testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relavantTimes occs)
67+testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relevantTimes occs)
67
68
68
69
69
70
test/Reflex/Plan/Reflex.hs+2−2
@@ -74,13 +74,13 @@ deriving instance ReflexHost t => MonadFix (Plan t)
74
74
75
75
76instance (ReflexHost t, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO) => TestPlan t (Plan t) where
76instance (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
78 (e, ref) <- newEventWithTriggerRef
78 (e, ref) <- newEventWithTriggerRef
79 modify (IntMap.unionWith mappend (firings ref))
79 modify (IntMap.unionWith mappend (firings ref))
80 return e
80 return e
81
81
82 where
82 where
83− firings ref = IntMap.fromList (makeFiring ref <$> occurances)
83+ firings ref = IntMap.fromList (makeFiring ref <$> occurrences)
84 makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
84 makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
85
85
86
86
test/Reflex/Test/CrossImpl.hs+37−28
@@ -12,7 +12,6 @@
12{-# LANGUAGE TypeFamilies #-}
12{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE TypeOperators #-}
14{-# LANGUAGE UndecidableInstances #-}
14{-# LANGUAGE UndecidableInstances #-}
15−module Reflex.Test.CrossImpl (test) where
16
15
17import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
16import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
18
17
@@ -20,27 +19,23 @@ import Control.Monad.Ref
20import Reflex.Class
19import Reflex.Class
21import Reflex.Dynamic
20import Reflex.Dynamic
22import Reflex.Host.Class
21import Reflex.Host.Class
23−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
24import qualified Reflex.Pure as P
22import qualified Reflex.Pure as P
25import qualified Reflex.Spider.Internal as S
23import qualified Reflex.Spider.Internal as S
24+import qualified Reflex.Profiled as Prof
26
25
27import Control.Arrow (second, (&&&))
26import Control.Arrow (second, (&&&))
28import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
27import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
29import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28import 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 (..))
29+import Data.Dependent.Sum (DSum (..))
32−import qualified Data.Dependent.Map as DMap
33import Data.Foldable
30import Data.Foldable
34−import Data.Functor.Misc
35import Data.Map.Strict (Map)
31import Data.Map.Strict (Map)
36import qualified Data.Map.Strict as Map
32import qualified Data.Map.Strict as Map
37import qualified Data.Set as Set
33import qualified Data.Set as Set
34+import Data.Monoid
38import Data.Traversable
35import Data.Traversable
39import System.Exit
36import System.Exit
40import System.Mem
37import System.Mem
41
38
42−import System.IO.Unsafe
43−
44mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
39mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
45mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
40mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
46 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
41 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
@@ -77,11 +72,14 @@ instance MapMSignals (Event t a) (Event t' a) t t' where
77instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
72instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
78 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
73 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
79
74
75+testTimeline
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)
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))
81−testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
79+testTimeline builder (bMap, eMap) = do
82 (re, reTrigger) <- newEventWithTriggerRef
80 (re, reTrigger) <- newEventWithTriggerRef
83 (rb, rbTrigger) <- newEventWithTriggerRef
81 (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
85 (b', e') <- runHostFrame $ builder (b, re)
83 (b', e') <- runHostFrame $ builder (b, re)
86 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
84 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
87 let times = relevantTestingTimes (bMap, eMap)
85 let times = relevantTestingTimes (bMap, eMap)
@@ -106,9 +104,11 @@ testAgreement :: (Eq c, Eq d, Show c, Show d) => (forall m t. TestCaseConstraint
106testAgreement builder inputs = do
104testAgreement builder inputs = do
107 let identityResult = testPure builder inputs
105 let identityResult = testPure builder inputs
108 tracePerf "---------" $ return ()
106 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
110 tracePerf "---------" $ return ()
110 tracePerf "---------" $ return ()
111− let resultsAgree = identityResult == spiderResult
111+ let resultsAgree = identityResult == spiderResult && identityResult == profiledResult
112 if resultsAgree
112 if resultsAgree
113 then do --putStrLn "Success:"
113 then do --putStrLn "Success:"
114 --print identityResult
114 --print identityResult
@@ -116,6 +116,7 @@ testAgreement builder inputs = do
116 else do putStrLn "Failure:"
116 else do putStrLn "Failure:"
117 putStrLn $ "Pure result: " <> show identityResult
117 putStrLn $ "Pure result: " <> show identityResult
118 putStrLn $ "Spider result: " <> show spiderResult
118 putStrLn $ "Spider result: " <> show spiderResult
119+ putStrLn $ "Profiled result: " <> show profiledResult
119 return resultsAgree
120 return resultsAgree
120
121
121type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
122type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
@@ -155,35 +156,35 @@ testCases =
155 let e' = leftmost [e, e]
156 let e' = leftmost [e, e]
156 e'' <- switch <$> hold e' (fmap (const e) e)
157 e'' <- switch <$> hold e' (fmap (const e) e)
157 return (b, e'')
158 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
159 let e' = fmap (const e) e
160 let e' = fmap (const e) e
160− e'' <- switchPromptly never e'
161+ e'' <- switchHoldPromptly never e'
161 return (b, e'')
162 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
163 let e' = fmap (const e) e
164 let e' = fmap (const e) e
164− e'' <- switchPromptly never $ leftmost [e', e']
165+ e'' <- switchHoldPromptly never $ leftmost [e', e']
165 return (b, e'')
166 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
167 let e' = leftmost [e, e]
168 let e' = leftmost [e, e]
168− e'' <- switchPromptly never (fmap (const e) e')
169+ e'' <- switchHoldPromptly never (fmap (const e) e')
169 return (b, e'')
170 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
171 let e' = leftmost [e, e]
172 let e' = leftmost [e, e]
172− e'' <- switchPromptly never (fmap (const e') e)
173+ e'' <- switchHoldPromptly never (fmap (const e') e)
173 return (b, e'')
174 return (b, e'')
174 , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175 , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175 let e' = leftmost [e, e]
176 let e' = leftmost [e, e]
176 e'' <- switch <$> hold never (fmap (const e') e)
177 e'' <- switch <$> hold never (fmap (const e') e)
177 return (b, e'')
178 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
179 let e' = flip push e $ \_ -> do
180 let e' = flip push e $ \_ -> do
180 Just <$> headE e
181 Just <$> headE e
181− e'' <- switchPromptly never e'
182+ e'' <- switchHoldPromptly never e'
182 return (b, e'')
183 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
184 let e' = flip pushAlways e $ \_ -> do
185 let e' = flip pushAlways e $ \_ -> do
185− switchPromptly e never
186+ switchHoldPromptly e never
186− e'' <- switchPromptly never e'
187+ e'' <- switchHoldPromptly never e'
187 return (b, e'')
188 return (b, e'')
188 , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
189 , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
189 let e' = flip pushAlways e $ \_ -> return e
190 let e' = flip pushAlways e $ \_ -> return e
@@ -222,6 +223,11 @@ testCases =
222 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
223 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
223 let b' = pull $ sample =<< sample bb
224 let b' = pull $ sample =<< sample bb
224 return (b', e)
225 return (b', e)
226+ , (,) "foldDynWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(_, e) -> do
227+ d <- foldDyn (:) [] $
228+ pushAlways (\a -> foldDyn (:) [a] e) e
229+ let b = current (join (fmap distributeListOverDynPure d))
230+ return (b, e)
225 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
231 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
226 bb <- hold "b" e
232 bb <- hold "b" e
227 bd <- hold never . fmap (const e) =<< headE e
233 bd <- hold never . fmap (const e) =<< headE e
@@ -233,6 +239,9 @@ testCases =
233 rec result <- holdUniqDyn d
239 rec result <- holdUniqDyn d
234 d <- holdDyn (0 :: Int) e
240 d <- holdDyn (0 :: Int) e
235 return (current result, updated result)
241 return (current result, updated result)
242+
243+
244+
236 {-
245 {-
237 , (,) "mergeIncrementalWithMove" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, PatchDMapWithMove.moveDMapKey LeftTag RightTag), (2, mempty)]) $ \(b, e :: Event t (PatchDMapWithMove (EitherTag () ()) (Const2 () ()))) -> do
246 , (,) "mergeIncrementalWithMove" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, PatchDMapWithMove.moveDMapKey LeftTag RightTag), (2, mempty)]) $ \(b, e :: Event t (PatchDMapWithMove (EitherTag () ()) (Const2 () ()))) -> do
238 x <- holdIncremental (DMap.singleton LeftTag $ void e) $ PatchDMapWithMove.mapPatchDMapWithMove (\(Const2 _) -> void e) <$> e
247 x <- holdIncremental (DMap.singleton LeftTag $ void e) $ PatchDMapWithMove.mapPatchDMapWithMove (\(Const2 _) -> void e) <$> e
@@ -248,8 +257,8 @@ splitRecombineEvent e =
248 in leftmost [ea, eb]
257 in leftmost [ea, eb]
249
258
250
259
251−test :: IO ()
260+main :: IO ()
252−test = do
261+main = do
253 results <- forM testCases $ \(name, TestCase inputs builder) -> do
262 results <- forM testCases $ \(name, TestCase inputs builder) -> do
254 putStrLn $ "Test: " <> name
263 putStrLn $ "Test: " <> name
255 testAgreement builder inputs
264 testAgreement builder inputs
test/Reflex/Test/Micro.hs+84−17
@@ -3,6 +3,7 @@
3{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE GADTs #-}
5{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
@@ -23,6 +24,24 @@ import Data.Monoid
23
24
24import Prelude
25import Prelude
25
26
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+
26{-# ANN testCases "HLint: ignore Functor law" #-}
45{-# ANN testCases "HLint: ignore Functor law" #-}
27testCases :: [(String, TestCase)]
46testCases :: [(String, TestCase)]
28testCases =
47testCases =
@@ -128,36 +147,36 @@ testCases =
128 return $ coincidence $ flip pushAlways e $ const $ do
147 return $ coincidence $ flip pushAlways e $ const $ do
129 switch <$> hold ("x" <$ e) (e <$ e)
148 switch <$> hold ("x" <$ e) (e <$ e)
130
149
131− , testE "switchPromptly-1" $ do
150+ , testE "switchHoldPromptly-1" $ do
132 e <- events1
151 e <- events1
133 let e' = e <$ e
152 let e' = e <$ e
134− switchPromptly never $ e <$ e'
153+ switchHoldPromptly never $ e <$ e'
135
154
136− , testE "switchPromptly-2" $ do
155+ , testE "switchHoldPromptly-2" $ do
137 e <- events1
156 e <- events1
138− switchPromptly never $ deep (e <$ e)
157+ switchHoldPromptly never $ deep (e <$ e)
139
158
140− , testE "switchPromptly-3" $ do
159+ , testE "switchHoldPromptly-3" $ do
141 e <- events1
160 e <- events1
142− switchPromptly never $ (e <$ deep e)
161+ switchHoldPromptly never $ (e <$ deep e)
143
162
144− , testE "switchPromptly-4" $ do
163+ , testE "switchHoldPromptly-4" $ do
145 e <- events1
164 e <- events1
146− switchPromptly never $ (deep e <$ e)
165+ switchHoldPromptly never $ (deep e <$ e)
147
166
148 , testE "switch-5" $ do
167 , testE "switch-5" $ do
149 e <- events1
168 e <- events1
150 switch <$> hold never (deep e <$ e)
169 switch <$> hold never (deep e <$ e)
151
170
152− , testE "switchPromptly-5" $ do
171+ , testE "switchHoldPromptly-5" $ do
153 e <- events1
172 e <- events1
154− switchPromptly never $ flip push e $
173+ switchHoldPromptly never $ flip push e $
155 const (Just <$> headE e)
174 const (Just <$> headE e)
156
175
157− , testE "switchPromptly-6" $ do
176+ , testE "switchHoldPromptly-6" $ do
158 e <- events1
177 e <- events1
159− switchPromptly never $ flip pushAlways e $
178+ switchHoldPromptly never $ flip pushAlways e $
160− const (switchPromptly e never)
179+ const (switchHoldPromptly e never)
161
180
162 , testE "coincidence-1" $ do
181 , testE "coincidence-1" $ do
163 e <- events1
182 e <- events1
@@ -201,6 +220,14 @@ testCases =
201 bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
220 bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
202 return $ pull $ sample =<< sample bb
221 return $ pull $ sample =<< sample bb
203
222
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+
204 , testE "joinDyn" $ do
231 , testE "joinDyn" $ do
205 e <- events1
232 e <- events1
206 bb <- hold "b" e
233 bb <- hold "b" e
@@ -223,6 +250,38 @@ testCases =
223 d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
250 d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
224
251
225 return $ current $ zipDynWith (<>) d1 d2
252 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+
226 , testE "fan-1" $ do
285 , testE "fan-1" $ do
227 e <- fmap toMap <$> events1
286 e <- fmap toMap <$> events1
228 let es = select (fanMap e) . Const2 <$> values
287 let es = select (fanMap e) . Const2 <$> values
@@ -263,15 +322,25 @@ testCases =
263 let e = never <$ switch b
322 let e = never <$ switch b
264 return $ void e
323 return $ void e
265 lazyHold
324 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
267 ] where
333 ] where
268
334
269 events1, events2, events3 :: TestPlan t m => m (Event t String)
335 events1, events2, events3 :: TestPlan t m => m (Event t String)
270 events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
336 events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
271 events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
337 events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
272−
273 events3 = liftA2 mappend events1 events2
338 events3 = liftA2 mappend events1 events2
274
339
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+
275 values = "abcde"
344 values = "abcde"
276 toMap str = Map.fromList $ map (\c -> (c, c)) str
345 toMap str = Map.fromList $ map (\c -> (c, c)) str
277
346
@@ -281,5 +350,3 @@ testCases =
281
350
282 deep e = leftmost [e, e]
351 deep e = leftmost [e, e]
283 leftmost2 e1 e2 = leftmost [e1, e2]
352 leftmost2 e1 e2 = leftmost [e1, e2]
284−
285−
test/Reflex/TestPlan.hs+2−2
@@ -26,8 +26,8 @@ import Reflex.Class
26import Prelude
26import Prelude
27
27
28class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
28class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
29− -- | Speicify a plan of an input Event firing
29+ -- | Specify a plan of an input Event firing
30− -- Occurances must be in the future (i.e. Time > 0)
30+ -- Occurrences must be in the future (i.e. Time > 0)
31 -- Initial specification is
31 -- Initial specification is
32
32
33 plan :: [(Word, a)] -> m (Event t a)
33 plan :: [(Word, a)] -> m (Event t a)
test/RequesterT.hs+186−16
@@ -1,11 +1,40 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE LambdaCase #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE RecursiveDo #-}
1−{-# LANGUAGE FlexibleContexts, GADTs, RankNTypes, ScopedTypeVariables #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeApplications #-}
12+{-# LANGUAGE TypeFamilies #-}
2module Main where
13module Main where
3
14
4−import Control.Lens
15+import Control.Lens hiding (has)
5import Control.Monad
16import Control.Monad
17+import Control.Monad.Fix
18+import Control.Monad.IO.Class (MonadIO)
19+import Data.Constraint.Extras
20+import Data.Constraint.Extras.TH
21+import Data.Constraint.Forall
6import qualified Data.Dependent.Map as DMap
22import qualified Data.Dependent.Map as DMap
7import Data.Dependent.Sum
23import Data.Dependent.Sum
24+import Data.Functor.Misc
25+import Data.List (words)
26+import Data.Map (Map)
27+import qualified Data.Map as M
28+#if !MIN_VERSION_these(4,11,0)
29+import Data.Semigroup ((<>))
30+#endif
31+import Data.Text (Text)
8import Data.These
32import Data.These
33+import Text.Read (readMaybe)
34+
35+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
36+import Data.These.Lens
37+#endif
9
38
10import Reflex
39import Reflex
11import Reflex.Requester.Base
40import Reflex.Requester.Base
@@ -17,18 +46,38 @@ data RequestInt a where
17
46
18main :: IO ()
47main :: IO ()
19main = do
48main = do
20− os1@[[Just [10,9,8,7,6,5,4,3,2,1]]] <- runApp' (unwrapApp testOrdering) $
49+ os1 <- runApp' (unwrapApp testOrdering) $
21 [ Just ()
50 [ Just ()
22 ]
51 ]
23 print os1
52 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 $
53+ os2 <- runApp' (unwrapApp testSimultaneous) $ map Just $
26− [ This ()
54+ [ This ()
27− , That ()
55+ , That ()
28− , This ()
56+ , This ()
29− , These () ()
57+ , These () ()
30− ]
58+ ]
31 print os2
59 print os2
60+ os3 <- runApp' (unwrapApp testMoribundRequest) [Just ()]
61+ print os3
62+ os4 <- runApp' (unwrapApp testMoribundRequestDMap) [Just ()]
63+ print os4
64+ os5 <- runApp' (unwrapApp testLiveRequestDMap) [Just ()]
65+ print os5
66+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
67+ print os6
68+ os7 <- runApp' testMatchRequestsWithResponses [ Just $ TestRequest_Increment 1 ]
69+ print os7
70+ os8 <- runApp' testMatchRequestsWithResponses [ Just $ TestRequest_Reverse "yoyo" ]
71+ print os8
72+ let ![[Just [1,2,3,4,5,6,7,8,9,10]]] = os1 -- The order is reversed here: see the documentation for 'runRequesterT'
73+ let ![[Just [9,7,5,3,1]],[Nothing,Nothing],[Just [10,8,6,4,2]],[Just [10,8,6,4,2],Nothing]] = os2
74+ let ![[Nothing, Just [2]]] = os3
75+ let ![[Nothing, Just [2]]] = os4
76+ let ![[Nothing, Just [1, 2]]] = os5
77+ -- let ![[Nothing, Nothing]] = os6 -- TODO re-enable this test after issue #233 has been resolved
78+ let !(Just [(1,"2")]) = M.toList <$> head (head os7)
79+ let !(Just [(1,"oyoy")]) = M.toList <$> head (head os8)
80+
32 return ()
81 return ()
33
82
34unwrapRequest :: DSum tag RequestInt -> Int
83unwrapRequest :: DSum tag RequestInt -> Int
@@ -40,22 +89,21 @@ unwrapApp :: ( Reflex t, Monad m )
40 -> m (Event t [Int])
89 -> m (Event t [Int])
41unwrapApp x appIn = do
90unwrapApp x appIn = do
42 ((), e) <- runRequesterT (x appIn) never
91 ((), e) <- runRequesterT (x appIn) never
43− return $ fmap (map unwrapRequest . DMap.toList) e
92+ return $ fmap (map unwrapRequest . requesterDataToList) e
44
93
45testOrdering :: ( Response m ~ Identity
94testOrdering :: ( Response m ~ Identity
46 , Request m ~ RequestInt
95 , Request m ~ RequestInt
47 , Requester t m
96 , Requester t m
48− , MonadAdjust t m)
97+ , Adjustable t m)
49 => Event t ()
98 => Event t ()
50 -> m ()
99 -> m ()
51−testOrdering pulse = do
100+testOrdering pulse = forM_ [10,9..1] $ \i ->
52− forM_ [10,9..1] $ \i -> requestingIdentity (RequestInt i <$ pulse)
101+ requestingIdentity (RequestInt i <$ pulse)
53− return ()
54
102
55testSimultaneous :: ( Response m ~ Identity
103testSimultaneous :: ( Response m ~ Identity
56 , Request m ~ RequestInt
104 , Request m ~ RequestInt
57 , Requester t m
105 , Requester t m
58− , MonadAdjust t m)
106+ , Adjustable t m)
59 => Event t (These () ())
107 => Event t (These () ())
60 -> m ()
108 -> m ()
61testSimultaneous pulse = do
109testSimultaneous pulse = do
@@ -63,3 +111,125 @@ testSimultaneous pulse = do
63 switchE = fmapMaybe (^? there) pulse
111 switchE = fmapMaybe (^? there) pulse
64 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
112 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
65 requestingIdentity (RequestInt (i+1) <$ tellE)
113 requestingIdentity (RequestInt (i+1) <$ tellE)
114+
115+-- | Test that a widget requesting and event which fires at the same time it has been replaced
116+-- doesn't count along with the new widget.
117+testMoribundRequest
118+ :: forall t m
119+ . ( Reflex t
120+ , Adjustable t m
121+ , MonadHold t m
122+ , MonadFix m
123+ , Response m ~ Identity
124+ , Request m ~ RequestInt
125+ , Requester t m
126+ )
127+ => Event t ()
128+ -> m ()
129+testMoribundRequest pulse = do
130+ rec let requestIntOnReplace x = requestingIdentity $ RequestInt x <$ rwrFinished
131+ (_, rwrFinished) <- runWithReplace (requestIntOnReplace 1) $ requestIntOnReplace 2 <$ pulse
132+ return ()
133+
134+-- | The equivalent of 'testMoribundRequest' for 'traverseDMapWithKeyWithAdjust'.
135+testMoribundRequestDMap
136+ :: forall t m
137+ . ( Reflex t
138+ , Adjustable t m
139+ , MonadHold t m
140+ , MonadFix m
141+ , Response m ~ Identity
142+ , Request m ~ RequestInt
143+ , Requester t m
144+ )
145+ => Event t ()
146+ -> m ()
147+testMoribundRequestDMap pulse = do
148+ rec let requestIntOnReplace :: Int -> m ()
149+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
150+ (_, rwrFinished :: Event t (PatchDMap (Const2 () Int) Identity)) <-
151+ traverseDMapWithKeyWithAdjust
152+ (\(Const2 ()) (Identity v) -> Identity . const v <$> requestIntOnReplace v)
153+ (mapToDMap $ M.singleton () 1)
154+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton () 2) <$ pulse)
155+ return ()
156+
157+-- | Ensures that elements which are _not_ removed can still fire requests
158+-- during the same frame as other elements are updated.
159+testLiveRequestDMap
160+ :: forall t m
161+ . ( Reflex t
162+ , Adjustable t m
163+ , MonadHold t m
164+ , MonadFix m
165+ , Response m ~ Identity
166+ , Request m ~ RequestInt
167+ , Requester t m
168+ )
169+ => Event t ()
170+ -> m ()
171+testLiveRequestDMap pulse = do
172+ rec let requestIntOnReplace :: Int -> m ()
173+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
174+ (_, rwrFinished :: Event t (PatchDMap (Const2 Int ()) Identity)) <-
175+ traverseDMapWithKeyWithAdjust
176+ (\(Const2 k) (Identity ()) -> Identity <$> requestIntOnReplace k)
177+ (mapToDMap $ M.singleton 1 ())
178+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
179+ return ()
180+
181+delayedPulse
182+ :: forall t m
183+ . ( Reflex t
184+ , Adjustable t m
185+ , MonadHold t m
186+ , MonadFix m
187+ , Response m ~ Identity
188+ , Request m ~ RequestInt
189+ , PerformEvent t m
190+ , Requester t m
191+ )
192+ => Event t ()
193+ -> m ()
194+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
195+ -- This has the effect of delaying pulse' from pulse
196+ (_, pulse') <- runWithReplace (pure ()) $ pure (RequestInt 1) <$ pulse
197+ requestingIdentity pulse'
198+
199+data TestRequest a where
200+ TestRequest_Reverse :: String -> TestRequest String
201+ TestRequest_Increment :: Int -> TestRequest Int
202+
203+testMatchRequestsWithResponses
204+ :: forall m t req a
205+ . ( MonadFix m
206+ , MonadHold t m
207+ , Reflex t
208+ , PerformEvent t m
209+ , MonadIO (Performable m)
210+ , ForallF Show req
211+ , Has Read req
212+ )
213+ => Event t (req a) -> m (Event t (Map Int String))
214+testMatchRequestsWithResponses pulse = mdo
215+ (_, requests) <- runRequesterT (requesting pulse) responses
216+ let rawResponses = M.map (\v ->
217+ case words v of
218+ ["reverse", str] -> reverse str
219+ ["increment", i] -> show $ succ $ (read i :: Int)
220+ ) <$> rawRequestMap
221+ (rawRequestMap, responses) <- matchResponsesWithRequests reqEncoder requests (head . M.toList <$> rawResponses)
222+ pure rawResponses
223+ where
224+ reqEncoder :: forall a. req a -> (String, String -> Maybe a)
225+ reqEncoder r =
226+ ( whichever @Show @req @a $ show r
227+ , \x -> has @Read r $ readMaybe x
228+ )
229+
230+deriveArgDict ''TestRequest
231+
232+instance Show (TestRequest a) where
233+ show = \case
234+ TestRequest_Reverse str -> "reverse " <> str
235+ TestRequest_Increment i -> "increment " <> show i
test/Test/Run.hs+8
@@ -64,3 +64,11 @@ runApp' :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
64runApp' app input = do
64runApp' app input = do
65 let app' = fmap (AppOut (pure ())) . app
65 let app' = fmap (AppOut (pure ())) . app
66 map (map snd) <$> runApp (app' . _appIn_event) () (map (fmap That) input)
66 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 @@
1module Main where
1module Main where
2
2
3import Control.Monad
3import Control.Monad
4−import Language.Haskell.HLint3 (hlint)
4+import Language.Haskell.HLint (hlint)
5import System.Directory
5import System.Directory
6import System.Exit (exitFailure, exitSuccess)
6import System.Exit (exitFailure, exitSuccess)
7−import System.FilePath.Find
8import System.FilePath
7import System.FilePath
8+import System.FilePath.Find
9
9
10main :: IO ()
10main :: IO ()
11main = do
11main = do
@@ -20,7 +20,10 @@ main = do
20 , "--ignore=Use >=>"
20 , "--ignore=Use >=>"
21 , "--ignore=Use ."
21 , "--ignore=Use ."
22 , "--ignore=Use unless"
22 , "--ignore=Use unless"
23+ , "--ignore=Reduce duplication"
23 , "--cpp-define=USE_TEMPLATE_HASKELL"
24 , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--cpp-define=DEBUG"
26+ , "--ignore=Use tuple-section"
24 ]
27 ]
25 recurseInto = and <$> sequence
28 recurseInto = and <$> sequence
26 [ fileType ==? Directory
29 [ fileType ==? Directory
@@ -28,16 +31,9 @@ main = do
28 ]
31 ]
29 matchFile = and <$> sequence
32 matchFile = and <$> sequence
30 [ extension ==? ".hs"
33 [ extension ==? ".hs"
31− , let notElem' = liftOp notElem
32− in filePath `notElem'` filePathExceptions pwd
33 ]
34 ]
34− files <- find recurseInto matchFile pwd
35+ files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
35 ideas <- fmap concat $ forM files $ \f -> do
36 ideas <- fmap concat $ forM files $ \f -> do
36 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
37 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
37 runHlint f
38 runHlint f
38 if null ideas then exitSuccess else exitFailure
39 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
2import Control.Concurrent
1import Control.Concurrent
2+import Control.Monad
3+import Data.IORef
3import Reflex
4import Reflex
4import Reflex.Host.Class
5import Reflex.Host.Class
5−import System.Mem
6−import Data.IORef
7import System.Exit
6import System.Exit
7+import System.Mem
8
8
9main :: IO ()
9main :: IO ()
10main = do
10main = do
test/semantics.hs−2
@@ -45,5 +45,3 @@ main = do
45 ]
45 ]
46
46
47 makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
47 makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
48−
49−