on develop help sign in
55 files changed+2264−7121
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+47 .gitignore+2 .stylish-haskell.yaml+2−3 .travis.yml−26 CONTRIBUTING.md+66 ChangeLog.md+61 Quickref.md−176 README.md+44−11 bench-cbits/checkCapability.c+11−12 bench/Main.hs−109 bench/RunAll.hs−157 cabal.project+1 default.nix−30 dep/reflex-platform/default.nix+8 dep/reflex-platform/github.json+8 patch.cabal+100 reflex.cabal−138 release.nix+49 src/Data/Functor/Misc.hs+119−59 src/Data/Monoid/DecidablyEmpty.hs+115 src/Data/Patch.hs+95 src/Data/Patch/Class.hs+45 src/Data/Patch/DMap.hs+93 src/Data/Patch/DMapWithMove.hs+371 src/Data/Patch/IntMap.hs+76 src/Data/Patch/Map.hs+72 src/Data/Patch/MapWithMove.hs+312 src/Data/Patch/MapWithPatchingMove.hs+432 src/Data/Semigroup/Additive.hs+54 src/Data/WeakBag.hs−118 src/Reflex.hs−12 src/Reflex/Class.hs−894 src/Reflex/Dynamic.hs−562 src/Reflex/Dynamic/TH.hs−89 src/Reflex/Dynamic/Uniq.hs−102 src/Reflex/DynamicWriter.hs−194 src/Reflex/Host/Class.hs−283 src/Reflex/Optimizer.hs−33 src/Reflex/PerformEvent/Base.hs−288 src/Reflex/PerformEvent/Class.hs−93 src/Reflex/PostBuild/Class.hs−103 src/Reflex/Pure.hs−172 src/Reflex/Spider.hs−16 src/Reflex/Spider/Internal.hs−2165 stylize+4 test/Reflex/Bench/Focused.hs−369 test/Reflex/Plan/Pure.hs−70 test/Reflex/Plan/Reflex.hs−135 test/Reflex/Test.hs−66 test/Reflex/Test/CrossImpl.hs−244 test/Reflex/Test/Micro.hs−280 test/Reflex/TestPlan.hs−52 test/hlint.hs+34−11 test/semantics.hs−49 test/tests.hs+43
.github/workflows/haskell.ymlnew file+47
@@ -0,0 +1,47 @@
1+name: github-action
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+ strategy:
8+ matrix:
9+ ghc: ['8.0.2', '8.2.2', '8.4.4', '8.6.5', '8.8.4', '8.10.2']
10+ os: ['ubuntu-latest', 'macos-latest']
11+ exclude:
12+ # There are some linker warnings in 802 on darwin that
13+ # cause compilation to fail
14+ # See https://github.com/NixOS/nixpkgs/issues/25139
15+ - ghc: '8.0.2'
16+ os: 'macos-latest'
17+ runs-on: ${{ matrix.os }}
18+
19+ name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
20+ steps:
21+ - uses: actions/checkout@v2
22+ - uses: actions/setup-haskell@v1
23+ with:
24+ ghc-version: ${{ matrix.ghc }}
25+ - name: Cache
26+ uses: actions/cache@v1
27+ env:
28+ cache-name: cache-cabal
29+ with:
30+ path: ~/.cabal
31+ key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
32+ restore-keys: |
33+ ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
34+ ${{ runner.os }}-${{ matrix.ghc }}-build-
35+ ${{ runner.os }}-${{ matrix.ghc }}-
36+ ${{ runner.os }}
37+
38+ - name: Install dependencies
39+ run: |
40+ cabal update
41+ cabal build --only-dependencies --enable-tests --enable-benchmarks
42+ - name: Build
43+ run: cabal build --enable-tests --enable-benchmarks all
44+ - name: Run tests
45+ run: cabal test --enable-tests all
46+ - name: Build Docs
47+ run: cabal haddock
.gitignore+2
@@ -1,4 +1,6 @@
11dist
2+cabal.sandbox.config
3+.cabal-sandbox/
24dist-*
35cabal-dev
46*.o
.stylish-haskell.yaml+2−3
@@ -149,6 +149,5 @@ columns: 110
149149# needs to be aware of these, so it can parse the file correctly.
150150#
151151# No language extensions are enabled by default.
152−# language_extensions:
153− # - TemplateHaskell
154− # - QuasiQuotes
152+language_extensions:
153+ - TemplateHaskell
.travis.ymldeleted−26
@@ -1,26 +0,0 @@
1−sudo: false
2−before_install:
3− - travis_retry cabal-$CABALVER update
4− - export PATH=/opt/ghc/$GHCVER/bin:/opt/happy/1.19.5/bin:/opt/alex/3.1.4/bin:$PATH
5−install:
6− - travis_retry cabal-$CABALVER install --only-dependencies -j --enable-tests
7−script:
8− - cabal-$CABALVER configure -v2 --enable-tests
9− - travis_wait cabal-$CABALVER build
10− - cabal-$CABALVER test
11− - cabal-$CABALVER sdist # tests that a source-distribution can be generated
12−# Check that the resulting source distribution can be built & installed.
13−# If there are no other `.tar.gz` files in `dist`, this can be even simpler:
14−# `cabal install --force-reinstalls dist/*-*.tar.gz`
15− - SRC_TGZ=$(cabal-$CABALVER info . | awk '{print $2;exit}').tar.gz &&
16− (cd dist && cabal-$CABALVER install --force-reinstalls "$SRC_TGZ")
17−
18−matrix:
19− include:
20− - env: CABALVER=1.18 GHCVER=7.8.4
21− addons: {apt: {packages: [cabal-install-1.18, ghc-7.8.4, alex-3.1.4, happy-1.19.5], sources: [hvr-ghc]}}
22− - env: CABALVER=1.22 GHCVER=7.10.1
23− addons: {apt: {packages: [cabal-install-1.22, ghc-7.10.1, alex-3.1.4, happy-1.19.5],sources: [hvr-ghc]}}
24− - env: CABALVER=1.24 GHCVER=8.0.1
25− addons: {apt: {packages: [cabal-install-1.24, ghc-8.0.1, alex-3.1.4, happy-1.19.5],sources: [hvr-ghc]}}
26− fast_finish: true
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 patch you were using. If you're using a github checkout, provide the git hash.
19+* Describe how you're building patch (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 patch.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+61
@@ -0,0 +1,61 @@
1+# Revision history for patch
2+
3+## Unreleased
4+
5+* New dep of `data-orphans` for old GHC to get instances honestly instead of
6+ via `monoidal-containers`.
7+
8+## 0.0.5.0 - 2021-12-17
9+
10+* `Additive` now lives in `Data.Semigroup.Additive`, but is still reexported
11+ from `Data.Patch` for compatability.
12+
13+* Rewrite `PatchMapWithMove` in terms of `PatchMapWithPatchingMove`.
14+ Care is taken to make this not a breaking change.
15+ In particular, `PatchMapWithMove` is a newtype of `PatchMapWithPatchingMove`, as is the `NodeInfo` and `From` of `PatchMapWithPatchingMove`'s versions of those.
16+ There are complete constructor and field patterns too, and everything is
17+ exported under the newtype as real constructors and fields would be.
18+
19+## 0.0.4.0 - 2021-04-20
20+
21+* Enable PolyKinds
22+
23+## 0.0.3.2 - 2020-11-06
24+
25+* Update version bounds
26+
27+## 0.0.3.1 - 2020-02-05
28+
29+* Replace `fromJust` with something easier to debug.
30+
31+## 0.0.3.0 - 2020-02-05
32+
33+* Create `PatchMapWithPatchingMove` variant which supports moves with a patch.
34+
35+* Create `DecidablyEmpty` subclass of `Monoid`.
36+
37+## 0.0.2.0 - 2020-01-17
38+
39+* Consistently provide:
40+
41+ - `Wrapped` instances
42+
43+ - `*WithIndex` instances
44+
45+ - `un*` newtype unwrappers
46+
47+ for `PatchMap`, `PatchIntMap`, and `PatchMapWithMove`.
48+
49+## 0.0.1.0 - 2020-01-09
50+
51+* Support older GHCs with `split-these` flag.
52+
53+* Additional instances for the `Group` class for basic types.
54+
55+## 0.0.0.1 - 2020-01-08
56+
57+* Remove unneeded dependencies
58+
59+## 0.0.0.0 - 2020-01-08
60+
61+* Extract patching functionality from Reflex.
Quickref.mddeleted−176
@@ -1,176 +0,0 @@
1−# Reflex Quick(ish) Reference
2−
3−## Typeclasses
4−
5−Many Reflex functions operate in monadic context `m a`, where the monad 'm' supports various additional typeclasses such as MonadWidget, MonadHold, or MonadSample in addition to Monad itself. The actual 'm' in use will be determined by the top-level entry point of the FRP host (such as Reflex-Dom -- see the bottom of the Reflex-Dom quick reference for details).
6−
7−The function signatures here have been simplified by removing many typeclass constraints and adding simple annotations to each function. Also the ubiquitous 't' type parameter has been removed.
8−
9−Some of these functions are *pure*: They operate on Events, Behaviors, or Dynamics uniformly without regard to the "current time". Other functions must operate in some monadic context, because they produce a result "as of now" (e.g., any function that takes an "initial" value, or returns a "current" value). Annotations are used to distinguish these cases:
10−
11−```haskell
12−[ ] -- Pure function
13−[S] -- Function runs in any monad supporting MonadSample
14−[H] -- Function runs in any monad supporting MonadHold
15−```
16−
17−Since MonadHold depends on MonadSample, any [S] function also runs in [H] context.
18−
19−## Functions producing Event
20−
21−```haskell
22−-- Trivial Event
23−[ ] never :: Event a
24−
25−-- Extract Event from Dynamic
26−[ ] updated :: Dynamic a -> Event a
27−
28−-- Transform Event to Event using function
29−[ ] fmap :: (a -> b) -> Event a -> Event b
30−[ ] fmapMaybe :: (a -> Maybe b) -> Event a -> Event b
31−[ ] ffilter :: (a -> Bool) -> Event a -> Event a
32−[ ] ffor :: Event a -> (a -> b) -> Event b
33−[ ] fforMaybe :: Event a -> (a -> Maybe b) -> Event b
34−
35−-- Event to identical Event with debug trace. (Only prints if Event is ultimately used.)
36−[ ] traceEvent :: Show a => String -> Event a -> Event a
37−[ ] traceEventWith :: (a -> String) -> Event a -> Event a
38−
39−-- Transform Event to Event by sampling Behavior or Dynamic
40−[ ] gate :: Behavior Bool -> Event a -> Event a
41−[ ] tag :: Behavior a -> Event b -> Event a
42−[ ] tagPromptlyDyn :: Dynamic a -> Event b -> Event a
43−[ ] attach :: Behavior a -> Event b -> Event (a, b)
44−[ ] attachPromptlyDyn :: Dynamic a -> Event b -> Event (a, b)
45−[ ] attachWith :: (a -> b -> c) -> Behavior 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
48−[ ] attachPromptlyDynWithMaybe :: (a -> b -> Maybe c) -> Dynamic a -> Event b -> Event c
49−
50−-- Combine multiple Events
51−[ ] <> :: Monoid a => Event a -> Event a -> Event a
52−[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
53−[ ] leftmost :: [Event a] -> Event a
54−[ ] mergeList :: [Event a] -> Event (NonEmpty a)
55−[ ] merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
56−[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
57−
58−-- Efficient one-to-many fanout
59−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
60−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
61−[ ] select :: EventSelector k -> k a -> Event a
62−
63−-- Event to Event via function that can sample current values
64−[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
65−[ ] pushAlways :: (a -> m b ) -> Event a -> Event b
66− -- Note supplied function operates in [H] context
67−
68−-- Split Event into next occurrence and all other future occurrences, as of now.
69−[H] headE :: Event a -> m (Event a)
70−[H] tailE :: Event a -> m (Event a)
71−[H] headTailE :: Event a -> m (Event a, Event a)
72−```
73−
74−## Functions producing Behavior
75−
76−```haskell
77−-- Trivial Behavior
78−[ ] constant :: a -> Behavior a
79−
80−-- Extract Behavior from Dynamic
81−[ ] current :: Dynamic a -> Behavior a
82−
83−-- Create Behavior with given initial value, updated when the Event fires.
84−[H] hold :: a -> Event a -> m (Behavior a)
85−
86−-- Transform Behavior to Behavior using function
87−[ ] fmap :: (a -> b) -> Behavior a -> Behavior b
88−[ ] ffor :: Behavior a -> (a -> b) -> Behavior b
89−[ ] <*> :: Behavior (a -> b) -> Behavior a -> Behavior b
90−[ ] >>= :: Behavior a -> (a -> Behavior b) -> Behavior b
91−[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
92−-- ... plus many more due to typeclass membership
93−
94−-- Behavior to Behavior by sampling current values
95−[S] sample :: Behavior a -> m a
96−[ ] pull :: m a -> Behavior a
97− -- Note supplied value is in [S] context
98−```
99−
100−## Functions producing Dynamic
101−
102−```haskell
103−-- Trivial Dynamic
104−[ ] constDyn :: a -> Dynamic a
105−
106−-- Create Dynamic with given initial value, updated (various ways) when the Event fires.
107−[H] holdDyn :: a -> Event a -> m (Dynamic a)
108−[H] foldDyn :: (a -> b -> b ) -> b -> Event a -> m (Dynamic b)
109−[H] foldDynMaybe :: (a -> b -> Maybe b ) -> b -> Event a -> m (Dynamic b)
110−[H] foldDynM :: (a -> b -> m' b ) -> b -> Event a -> m (Dynamic b)
111−[H] foldDynMaybeM :: (a -> b -> m' (Maybe b)) -> b -> Event a -> m (Dynamic b)
112− -- Note m' supplies [H] context
113−
114−-- Initial value is 0; counts Event firings from now.
115−[H] count :: Num b => Event a -> m (Dynamic b)
116−-- Initial Bool value is supplied; toggles at each Event firing.
117−[H] toggle :: Bool -> Event a -> m (Dynamic Bool)
118−
119−-- Transform Dynamic to Dynamic using function
120−[ ] ffor :: Dynamic a -> (a -> b) -> Dynamic b
121−[ ] fmap :: (a -> b) -> Dynamic a -> Dynamic b
122−[ ] splitDynPure :: Dynamic (a, b) -> (Dynamic a, Dynamic b)
123−
124−-- Combine multiple Dynamics
125−[ ] mconcat :: Monoid a => [Dynamic a] -> Dynamic a
126−[ ] distributeDMapOverDynPure :: GCompare k => DMap (WrapArg Dynamic k) -> Dynamic (DMap k)
127−[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
128−
129−-- Efficient one-to-many fanout
130−[ ] demux :: Ord k => Dynamic k -> Demux k
131−[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
132−
133−-- Dynamic to Dynamic, removing updates w/o value change
134−[ ] uniqDyn :: Eq a => Dynamic a -> Dynamic a
135−
136−-- Dynamic to identical Dynamic with debug trace. (Only prints if Dynamic is ultimately used.)
137−[ ] traceDyn :: Show a => String -> Dynamic a -> Dynamic a
138−[ ] traceDynWith :: (a -> String) -> Dynamic a -> Dynamic a
139−```
140−
141−## Flattening functions
142−
143−These functions flatten nested types such as Event-of-Event, Behavior-of-Event, Event-of-Behavior etc, removing the outer wrapper.
144−
145−For Events, the returned Event fires whenever the latest Event supplied by the wrapper fires. There are differences in how the functions handle *coincidences* -- situations where the old or new Event fires at the same instant that we switch from old to new. In some cases, the output Event tracks the old Event at the instant of switchover, while in other cases it tracks the new Event.
146−
147−```haskell
148−-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
149−[ ] switch :: Behavior (Event a) -> Event a
150−
151−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
152−[ ] switchPromptlyDyn :: Dynamic (Event a) -> Event a
153−
154−-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
155−[ ] coincidence :: Event (Event a) -> Event a
156−
157−-- Flatten Behavior-of-Behavior to Behavior. Behavior is an instance of Monad,
158−-- so the 'join' function from 'Control.Monad' suffices. The output of 'join' is
159−-- a Behavior whose value is equal to the current value of the current value of
160−-- the input.
161−[ ] join :: Behavior (Behavior a) -> Behavior a
162−
163−
164−-- Flatten Dynamic-of-Dynamic to Dynamic. New Dynamic is used immediately.
165−-- Output updated whenever inner OR outer Dynamic updates.
166−[ ] join :: Dynamic (Dynamic a) -> Dynamic a
167−[ ] joinDynThroughMap :: Ord k => Dynamic (Map k (Dynamic a)) -> Dynamic (Map k a)
168−
169−-- Analogous to 'hold': Create a Behavior that is initially identical to the
170−-- supplied Behavior. Updated to track a new Behavior whenever the Event fires.
171−[H] switcher :: Behavior a -> Event (Behavior a) -> m (Behavior a)
172−
173−-- Similar to above, for Events. Created Event initially tracks the first argument.
174−-- At switchover, the output Event immediately tracks the new Event.
175−[H] switchPromptly :: Event a -> Event (Event a) -> m (Event a)
176−```
README.md+44−11
@@ -1,19 +1,52 @@
1−## Reflex
2−### Practical Functional Reactive Programming
1+# patch
32
4−Reflex is an fully-deterministic, higher-order Functional Reactive Programming (FRP) interface and an engine that efficiently implements that interface.
3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/patch.svg)](https://hackage.haskell.org/package/patch) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/patch/badge)](https://matrix.hackage.haskell.org/#/package/patch) [![Travis CI](https://api.travis-ci.org/reflex-frp/patch.svg?branch=develop)](https://travis-ci.org/reflex-frp/patch) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/patch/LICENSE)
54
6−[Reflex-DOM](https://github.com/reflex-frp/reflex-dom) is a framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
5+Data structures for describing changes to other data structures.
76
8−Comprehensive documentation is still a work in progress, but a tutorial for Reflex and Reflex-DOM is available at https://github.com/reflex-frp/reflex-platform and an introductory talk given at the New York Haskell Meetup is available here: [Part 1](https://www.youtube.com/watch?v=mYvkcskJbc4) / [Part 2](https://www.youtube.com/watch?v=3qfc9XFVo2c).
7+A `Patch` type represents a kind of change made to a data structure.
98
10−A summary of Reflex functions is available in the [quick reference](Quickref.md).
9+```haskell
10+class Patch p where
11+ type PatchTarget p :: *
12+ -- | Apply the patch p a to the value a. If no change is needed, return
13+ -- 'Nothing'.
14+ apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
15+```
1116
12−### Additional resources
13−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
17+## Patching Maps
18+For example, `Data.Patch.Map` defines the `PatchMap` type which can be used to patch `Map`s. A `PatchMap` represents updates to a `Map` that can insert, remove, or replace items in the `Map`. In this example, the `Map` is the `PatchTarget` and the `PatchMap` is the `Patch`. Keep in mind that there are many other possible `Patch`es that can be applied to a `Map` (i.e., `Map` can be the `PatchTarget` for many different `Patch` instances).
1419
15−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
20+`PatchMap` is defined as:
1621
17−[hackage](https://hackage.haskell.org/package/reflex)
22+```haskell
23+newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
24+```
1825
19−[irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
26+The `Maybe` around the value is used to represent insertion/updates or deletion of the element at a given key.
27+
28+Its `Patch` instance begins with:
29+
30+```haskell
31+instance Ord k => Patch (PatchMap k v) where
32+ type PatchTarget (PatchMap k v) = Map k v
33+ ...
34+```
35+
36+When a `PatchMap` is applied to its `PatchTarget`, the following changes can occur:
37+
38+- If the key is present in the `Patch` and the `PatchTarget`...
39+
40+ - And the `Patch` value at that key is `Nothing`: delete that key from the `PatchTarget`.
41+
42+ - And the `Patch` value at that key is `Just x`: update the value at that key in the `PatchTarget` to `x`.
43+
44+- If the key is present in the `Patch` and not present in the `PatchTarget`...
45+
46+ - And the `Patch` value at that key is `Nothing`: do nothing because we're trying to delete a key that doesn't exist in the target in the first place.
47+
48+ - And the `Patch` value at that key is `Just x`: insert the key and the value `x` into the `PatchTarget`
49+
50+- If the key is *not* present in the `Patch` but present in the `PatchTarget`: do nothing.
51+
52+There are, of course, more complicated ways of patching maps involving, for example, moving values from one key to another. You can find the code for that in `Data.Patch.PatchMapWithMove`. Note that the `PatchTarget` type associated with the `PatchMapWithMove` patch instance is still `Map k v`!
bench-cbits/checkCapability.c+11−12
@@ -42,7 +42,7 @@ typedef struct Task_ {
4242 // or just continue immediately. It's a workaround for the fact
4343 // that signalling a condition variable doesn't do anything if the
4444 // thread is already running, but we want it to be sticky.
45− rtsBool wakeup;
45+ HsBool wakeup;
4646#endif
4747
4848 // This points to the Capability that the Task "belongs" to. If
@@ -62,14 +62,14 @@ typedef struct Task_ {
6262 // The current top-of-stack InCall
6363 struct InCall_ *incall;
6464
65− nat n_spare_incalls;
65+ uint32_t n_spare_incalls;
6666 struct InCall_ *spare_incalls;
6767
68− rtsBool worker; // == rtsTrue if this is a worker Task
69− rtsBool stopped; // this task has stopped or exited Haskell
68+ HsBool worker; // == rtsTrue if this is a worker Task
69+ HsBool stopped; // this task has stopped or exited Haskell
7070
7171 // So that we can detect when a finalizer illegally calls back into Haskell
72− rtsBool running_finalizers;
72+ HsBool running_finalizers;
7373
7474 // Links tasks on the returning_tasks queue of a Capability, and
7575 // on spare_workers.
@@ -88,7 +88,7 @@ struct Capability_ {
8888 StgFunTable f;
8989 StgRegTable r;
9090
91− nat no; // capability number.
91+ uint32_t no; // capability number.
9292
9393 // The Task currently holding this Capability. This task has
9494 // exclusive access to the contents of this Capability (apart from
@@ -98,12 +98,12 @@ struct Capability_ {
9898
9999 // true if this Capability is running Haskell code, used for
100100 // catching unsafe call-ins.
101− rtsBool in_haskell;
101+ HsBool in_haskell;
102102
103103 // Has there been any activity on this Capability since the last GC?
104− nat idle;
104+ uint32_t idle;
105105
106− rtsBool disabled;
106+ HsBool disabled;
107107
108108 // The run queue. The Task owning this Capability has exclusive
109109 // access to its run queue, so can wake up threads without
@@ -159,7 +159,7 @@ struct Capability_ {
159159#if defined(THREADED_RTS)
160160 // Worker Tasks waiting in the wings. Singly-linked.
161161 Task *spare_workers;
162− nat n_spare_workers; // count of above
162+ uint32_t n_spare_workers; // count of above
163163
164164 // This lock protects:
165165 // running_task
@@ -192,10 +192,9 @@ struct Capability_ {
192192
193193 // Per-capability STM-related data
194194 StgTVarWatchQueue *free_tvar_watch_queues;
195− StgInvariantCheckQueue *free_invariant_check_queues;
196195 StgTRecChunk *free_trec_chunks;
197196 StgTRecHeader *free_trec_headers;
198− nat transaction_tokens;
197+ uint32_t transaction_tokens;
199198} // typedef Capability is defined in RtsAPI.h
200199 // We never want a Capability to overlap a cache line with anything
201200 // else, so round it up to a cache line size:
bench/Main.hsdeleted−109
@@ -1,109 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE ScopedTypeVariables #-}
4−{-# LANGUAGE TupleSections #-}
5−{-# LANGUAGE TypeFamilies #-}
6−
7−-- The instance for NFData (TVar a) is an orphan, but necessary here
8−{-# OPTIONS_GHC -fno-warn-orphans #-}
9−
10−module Main where
11−
12−import Control.Concurrent.STM
13−import Control.DeepSeq
14−import Control.Exception (evaluate)
15−import Control.Monad.Identity
16−import Control.Monad.IO.Class
17−import Criterion.Main
18−import Data.Dependent.Map (DMap)
19−import qualified Data.Dependent.Map as DMap
20−import Data.Dependent.Sum
21−import Data.Functor.Misc
22−import Data.IORef
23−import Reflex
24−import Reflex.Host.Class
25−
26−main :: IO ()
27−main = defaultMain
28− [ bgroup "micro" micros ]
29−
30−#if !(MIN_VERSION_deepseq(1,4,2))
31−instance NFData (IORef a) where
32− rnf x = seq x ()
33−#endif
34−
35−instance NFData (TVar a) where
36− rnf x = seq x ()
37−
38−newtype WHNF a = WHNF a
39−instance NFData (WHNF a) where
40− rnf (WHNF a) = seq a ()
41−
42−withSetup :: NFData b => String -> SpiderHost Global a -> (a -> SpiderHost Global b) -> Benchmark
43−withSetup name setup action = env (WHNF <$> runSpiderHost setup) $ \ ~(WHNF a) ->
44− bench name . nfIO $ runSpiderHost (action a)
45−
46−withSetupWHNF :: String -> SpiderHost Global a -> (a -> SpiderHost Global b) -> Benchmark
47−withSetupWHNF name setup action = env (WHNF <$> runSpiderHost setup) $ \ ~(WHNF a) ->
48− bench name . whnfIO $ runSpiderHost (action a)
49−
50−micros :: [Benchmark]
51−micros =
52− [ bench "newIORef" $ whnfIO $ void $ newIORef ()
53− , env (newIORef (42 :: Int)) (bench "readIORef" . whnfIO . readIORef)
54− , bench "newTVar" $ whnfIO $ void $ newTVarIO ()
55− , env (newTVarIO (42 :: Int)) (bench "readTVar" . whnfIO . readTVarIO)
56− , bench "newEventWithTrigger" $ whnfIO . void $ runSpiderHost $ newEventWithTrigger $
57− \trigger -> return () <$ evaluate trigger
58− , bench "newEventWithTriggerRef" $ whnfIO . void $ runSpiderHost newEventWithTriggerRef
59− , withSetupWHNF "subscribeEvent" newEventWithTriggerRef $ subscribeEvent . fst
60− , withSetupWHNF "subscribeSwitch"
61− (join $ hold <$> fmap fst newEventWithTriggerRef <*> fmap fst newEventWithTriggerRef)
62− (subscribeEvent . switch)
63− , withSetupWHNF "subscribeMerge(1)" (setupMerge 1) $ \(ev,_) -> subscribeEvent ev
64− , withSetupWHNF "subscribeMerge(100)" (setupMerge 100) (subscribeEvent . fst)
65− , withSetupWHNF "subscribeMerge(10000)" (setupMerge 10000) (subscribeEvent . fst)
66− , bench "runHostFrame" $ whnfIO $ runSpiderHost $ runHostFrame $ return ()
67− , withSetupWHNF "fireEventsAndRead(single/single)"
68− (newEventWithTriggerRef >>= subscribePair)
69− (\(subd, trigger) -> fireAndRead trigger (42 :: Int) subd)
70− , withSetupWHNF "fireEventsOnly"
71− (newEventWithTriggerRef >>= subscribePair)
72− (\(_, trigger) -> do
73− Just key <- liftIO $ readIORef trigger
74− fireEvents [key :=> Identity (42 :: Int)])
75− , withSetupWHNF "fireEventsAndRead(head/merge1)"
76− (setupMerge 1 >>= subscribePair)
77− (\(subd, t:_) -> fireAndRead t (42 :: Int) subd)
78− , withSetupWHNF "fireEventsAndRead(head/merge100)"
79− (setupMerge 100 >>= subscribePair)
80− (\(subd, t:_) -> fireAndRead t (42 :: Int) subd)
81− , withSetupWHNF "fireEventsAndRead(head/merge10000)"
82− (setupMerge 10000 >>= subscribePair)
83− (\(subd, t:_) -> fireAndRead t (42 :: Int) subd)
84− , withSetupWHNF "fireEventsOnly(head/merge100)"
85− (setupMerge 100 >>= subscribePair)
86− (\(_, t:_) -> do
87− Just key <- liftIO $ readIORef t
88− fireEvents [key :=> Identity (42 :: Int)])
89− , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
90− , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
91− ]
92−
93−setupMerge :: Int
94− -> SpiderHost Global ( Event (SpiderEnv Global) (DMap (Const2 Int a) Identity)
95− , [IORef (Maybe (EventTrigger Spider a))]
96− )
97−setupMerge num = do
98− (evs, triggers) <- unzip <$> replicateM num newEventWithTriggerRef
99− let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100− pure (merge m, triggers)
101−
102−subscribePair :: (Event (SpiderEnv Global) a, b) -> SpiderHost Global (EventHandle (SpiderEnv Global) a, b)
103−subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104−
105−fireAndRead :: IORef (Maybe (EventTrigger (SpiderEnv Global) a)) -> a -> EventHandle (SpiderEnv Global) b
106− -> SpiderHost Global (Maybe b)
107−fireAndRead trigger val subd = do
108− Just key <- liftIO $ readIORef trigger
109− fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
bench/RunAll.hsdeleted−157
@@ -1,157 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE ForeignFunctionInterface #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE PatternSynonyms #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TemplateHaskell #-}
13−{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeSynonymInstances #-}
15−{-# LANGUAGE ViewPatterns #-}
16−{-# OPTIONS_GHC -fno-warn-orphans #-}
17−
18−module Main where
19−
20−import Criterion.Main
21−import Criterion.Types
22−
23−import Reflex
24−import Reflex.Host.Class
25−
26−import Reflex.Plan.Reflex
27−import Reflex.TestPlan
28−
29−import qualified Reflex.Bench.Focused as Focused
30−import Reflex.Spider.Internal (SpiderEventHandle)
31−
32−import Control.Applicative
33−import Control.DeepSeq (NFData (..))
34−
35−import Prelude
36−import System.IO
37−import System.Mem
38−
39−import Control.Arrow
40−import Control.Concurrent
41−import Control.Concurrent.STM
42−import Control.Exception
43−import Control.Monad
44−import Control.Monad.Trans
45−import Data.Bool
46−import Data.Function
47−import Data.Int
48−import Data.IORef
49−import Data.Monoid
50−import Data.Time.Clock
51−import Debug.Trace.LocationTH
52−import GHC.Stats
53−import System.Environment
54−import System.Mem.Weak
55−import System.Process
56−import Text.Read
57−
58−import Unsafe.Coerce
59−
60−import Data.Map (Map)
61−import qualified Data.Map as Map
62−
63−type MonadReflexHost' t m = (MonadReflexHost t m, MonadIORef m, MonadIORef (HostFrame t))
64−
65−
66−setupFiring :: (MonadReflexHost t m, MonadIORef m) => Plan t (Event t a) -> m (EventHandle t a, Schedule t)
67−setupFiring p = do
68− (e, s) <- runPlan p
69− h <- subscribeEvent e
70− return (h, s)
71−
72−-- Hack to avoid the NFData constraint for EventHandle which is a synonym
73−newtype Ignore a = Ignore a
74−instance NFData (Ignore a) where
75− rnf !_ = ()
76−
77−instance NFData (SpiderEventHandle x a) where
78− rnf !_ = ()
79−
80−instance NFData (Behavior t a) where
81− rnf !_ = ()
82−
83−instance NFData (Firing t) where
84− rnf !_ = ()
85−
86−-- Measure the running time
87−benchFiring :: forall t m. (MonadReflexHost' t m, MonadSample t m) => (forall a. m a -> IO a) -> TestCase -> Int -> IO ()
88−benchFiring runHost tc n = runHost $ do
89− let runIterations :: m a -> m ()
90− runIterations test = replicateM_ (10*n) $ do
91− result <- test
92− liftIO $ evaluate result
93− case tc of
94− TestE p -> do
95− (h, s) <- setupFiring p
96− runIterations $ readSchedule_ s $ readEvent' h
97− TestB p -> do
98− (b, s) <- runPlan p
99− runIterations $ readSchedule_ (makeDense s) $ sample b
100−
101−waitForFinalizers :: IO ()
102−waitForFinalizers = do
103− performGC
104− x <- getCurrentTime
105− isFinalized <- newIORef False
106− mkWeakPtr x $ Just $ writeIORef isFinalized True
107− performGC
108− fix $ \loop -> do
109− f <- readIORef isFinalized
110− unless f $ do
111− threadDelay 1
112− loop
113−
114−benchmarks :: [(String, Int -> IO ())]
115−benchmarks = implGroup "spider" runSpiderHost cases
116− where
117− implGroup :: (MonadReflexHost' t m, MonadSample t m) => String -> (forall a. m a -> IO a) -> [(String, TestCase)] -> [(String, Int -> IO ())]
118− implGroup name runHost = group name . fmap (second (benchFiring runHost))
119− group name = fmap $ first ((name <> "/") <>)
120− sub n frames = group ("subscribing " ++ show (n, frames)) $ Focused.subscribing n frames
121− firing n = group ("firing " <> show n) $ Focused.firing n
122− merging n = group ("merging " <> show n) $ Focused.merging n
123− dynamics n = group ("dynamics " <> show n) $ Focused.dynamics n
124− cases = concat
125− [ sub 100 40
126− , dynamics 100
127− , dynamics 1000
128− , firing 1000
129− , firing 10000
130− , merging 10
131− , merging 50
132− , merging 100
133− , merging 200
134− ]
135−
136−pattern RunTestCaseFlag = "--run-test-case"
137−
138−spawnBenchmark :: String -> Benchmark
139−spawnBenchmark name = Benchmark name $ Benchmarkable $ \n -> do
140− self <- getExecutablePath
141− callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
142−
143−foreign import ccall unsafe "myCapabilityHasOtherRunnableThreads" myCapabilityHasOtherRunnableThreads :: IO Bool
144−
145−main :: IO ()
146−main = do
147− args <- getArgs
148− case args of
149− RunTestCaseFlag : t -> case t of
150− [name, readMaybe -> Just count] -> do
151− case lookup name benchmarks of
152− Just testCase -> testCase count
153− performGC
154− fix $ \loop -> bool (return ()) (yield >> loop) =<< myCapabilityHasOtherRunnableThreads
155− return ()
156− _ -> $failure "--run-test-case: expected test name and iteration count to follow"
157− _ -> defaultMainWith (defaultConfig { timeLimit = 20, csvFile = Just "dmap-original.csv", reportFile = Just "report.html" }) $ fmap (spawnBenchmark . fst) benchmarks
cabal.projectnew file+1
@@ -0,0 +1 @@
1+packages: .
default.nixdeleted−30
@@ -1,30 +0,0 @@
1−{ mkDerivation, 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−, ghc_reflex ? null
8−}:
9−mkDerivation {
10− pname = "reflex";
11− version = "0.5.0";
12− src = builtins.filterSource (path: type: baseNameOf path != ".git") ./.;
13− libraryHaskellDepends = [
14− base bifunctors containers dependent-map dependent-sum
15− exception-transformers haskell-src-exts haskell-src-meta lens
16− MemoTrie monad-control mtl primitive ref-tf semigroupoids
17− semigroups stm syb template-haskell these transformers
18− transformers-compat prim-uniq
19− ];
20− testHaskellDepends = [
21− base bifunctors containers deepseq dependent-map dependent-sum
22− hlint mtl ref-tf split transformers
23− ];
24− buildDepends = [
25− ghc_reflex
26− ];
27− homepage = "https://github.com/reflex-frp/reflex";
28− description = "Higher-order Functional Reactive Programming";
29− license = stdenv.lib.licenses.bsd3;
30−}
dep/reflex-platform/default.nixnew file+8
@@ -0,0 +1,8 @@
1+# DO NOT HAND-EDIT THIS FILE
2+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3+ if !fetchSubmodules && !private then builtins.fetchTarball {
4+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5+ } else (import <nixpkgs> {}).fetchFromGitHub {
6+ inherit owner repo rev sha256 fetchSubmodules private;
7+ };
8+in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))
dep/reflex-platform/github.jsonnew file+8
@@ -0,0 +1,8 @@
1+{
2+ "owner": "reflex-frp",
3+ "repo": "reflex-platform",
4+ "branch": "master",
5+ "private": false,
6+ "rev": "c9d11db1b98855fe8ab24a3ff6a5dbe0ad902ad9",
7+ "sha256": "0sfzkqdvyah5mwvmli0wq1nl0b8cvk2cmfgfy4rz57wv42x3099y"
8+}
patch.cabalnew file+100
@@ -0,0 +1,100 @@
1+Name: patch
2+Version: 0.0.5.0
3+Synopsis: Data structures for describing changes to other data structures.
4+Description:
5+ Data structures for describing changes to other data structures.
6+ .
7+ In this library, a patch is something which can be applied, analogous to a
8+ function, and which distinguishes returning the argument it was provided from
9+ returning something else.
10+License: BSD3
11+License-file: LICENSE
12+Author: Ryan Trinkle
13+Maintainer: maintainer@obsidian.systems
14+Stability: Experimental
15+Category: FRP
16+Build-type: Simple
17+Cabal-version: >=1.10
18+homepage: https://obsidian.systems
19+bug-reports: https://github.com/reflex-frp/patch/issues
20+extra-source-files:
21+ README.md
22+ ChangeLog.md
23+
24+tested-with:
25+ GHC ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.5 || ==8.8.1
26+ GHCJS ==8.4
27+
28+flag split-these
29+ description: Use split these/semialign packages
30+ manual: False
31+ default: True
32+
33+library
34+ hs-source-dirs: src
35+ default-language: Haskell2010
36+ build-depends: base >= 4.9 && < 4.15
37+ , constraints-extras >= 0.3 && < 0.4
38+ , containers >= 0.6 && < 0.7
39+ , dependent-map >= 0.3 && < 0.5
40+ , dependent-sum >= 0.6 && < 0.8
41+ , lens >= 4.7 && < 5
42+ , semigroupoids >= 4.0 && < 6
43+ , transformers >= 0.5.6.0 && < 0.6
44+ , witherable >= 0.3 && < 0.5
45+
46+ if impl(ghc < 8.6) -- really, if base < 8.12
47+ build-depends: base-orphans >= 0.8 && < 0.9
48+
49+ exposed-modules: Data.Functor.Misc
50+ , Data.Monoid.DecidablyEmpty
51+ , Data.Patch
52+ , Data.Patch.Class
53+ , Data.Patch.DMap
54+ , Data.Patch.DMapWithMove
55+ , Data.Patch.IntMap
56+ , Data.Patch.Map
57+ , Data.Patch.MapWithMove
58+ , Data.Patch.MapWithPatchingMove
59+ , Data.Semigroup.Additive
60+
61+ ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs
62+ default-extensions: PolyKinds
63+
64+ if flag(split-these)
65+ build-depends: these >= 1 && <1.2
66+ , semialign >=1 && <1.2
67+ , monoidal-containers >= 0.6 && < 0.7
68+ else
69+ build-depends: these >= 0.4 && <0.9
70+ , monoidal-containers == 0.4.0.0
71+
72+test-suite tests
73+ default-language: Haskell2010
74+ type: exitcode-stdio-1.0
75+ main-is: tests.hs
76+ hs-source-dirs: test
77+ build-depends: base
78+ , patch
79+ , containers
80+ , hedgehog
81+ , HUnit
82+ if impl(ghcjs)
83+ buildable: False
84+
85+test-suite hlint
86+ default-language: Haskell2010
87+ type: exitcode-stdio-1.0
88+ main-is: hlint.hs
89+ hs-source-dirs: test
90+ build-depends: base
91+ , directory
92+ , filepath
93+ , filemanip
94+ , hlint (< 2.1 || >= 2.2.2) && < 3.3
95+ if impl(ghcjs)
96+ buildable: False
97+
98+source-repository head
99+ type: git
100+ location: https://github.com/reflex-frp/patch
reflex.cabaldeleted−138
@@ -1,138 +0,0 @@
1−Name: reflex
2−Version: 0.5.0
3−Synopsis: Higher-order Functional Reactive Programming
4−Description: Reflex is a high-performance, deterministic, higher-order Functional Reactive Programming system
5−License: BSD3
6−License-file: LICENSE
7−Author: Ryan Trinkle
8−Maintainer: ryan.trinkle@gmail.com
9−Stability: Experimental
10−Category: FRP
11−Build-type: Simple
12−Cabal-version: >=1.9.2
13−homepage: https://github.com/reflex-frp/reflex
14−bug-reports: https://github.com/reflex-frp/reflex/issues
15−
16−library
17− hs-source-dirs: src
18− build-depends:
19− MemoTrie == 0.6.*,
20− base >= 4.7 && < 4.10,
21− bifunctors >= 5.2 && < 5.5,
22− containers == 0.5.*,
23− dependent-map >= 0.2.2 && < 0.3,
24− dependent-sum == 0.3.*,
25− exception-transformers == 0.4.*,
26− haskell-src-exts >= 1.16 && < 1.18,
27− haskell-src-meta == 0.6.*,
28− lens >= 4.7 && < 5,
29− monad-control >= 1.0.1 && < 1.1,
30− mtl >= 2.1 && < 2.3,
31− prim-uniq >= 0.1.0.1 && < 0.2,
32− primitive >= 0.5 && < 0.7,
33− ref-tf == 0.4.*,
34− semigroupoids >= 4.0 && < 6,
35− semigroups >= 0.16 && < 0.19,
36− stm == 2.4.*,
37− syb >= 0.5 && < 0.7,
38− template-haskell >= 2.9 && < 2.12,
39− these >= 0.4 && < 0.8,
40− transformers >= 0.2,
41− transformers-compat >= 0.3
42−
43− exposed-modules:
44− Data.Functor.Misc,
45− Data.WeakBag,
46− Reflex,
47− Reflex.Class,
48− Reflex.Dynamic,
49− Reflex.Dynamic.TH,
50− Reflex.Dynamic.Uniq,
51− Reflex.DynamicWriter,
52− Reflex.Host.Class,
53− Reflex.PerformEvent.Base,
54− Reflex.PerformEvent.Class,
55− Reflex.PostBuild.Class,
56− Reflex.Pure,
57− Reflex.Spider,
58− Reflex.Spider.Internal
59−
60− if !impl(ghcjs)
61− build-depends: ghc
62− exposed-modules: Reflex.Optimizer
63−
64− other-extensions: TemplateHaskell
65− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
66− ghc-prof-options: -auto-all
67−
68−test-suite semantics
69− type: exitcode-stdio-1.0
70− main-is: semantics.hs
71− hs-source-dirs: test
72− ghc-options: -O2 -Wall -rtsopts
73− build-depends:
74− base,
75− bifunctors,
76− containers,
77− deepseq >= 1.3 && < 1.5,
78− dependent-map,
79− dependent-sum,
80− mtl,
81− ref-tf,
82− reflex,
83− split,
84− transformers >= 0.3
85−
86−test-suite hlint
87− type: exitcode-stdio-1.0
88− main-is: hlint.hs
89− hs-source-dirs: test
90− build-depends: base, hlint == 1.9.*
91− if impl(ghcjs)
92− buildable: False
93−
94−benchmark spider-bench
95− type: exitcode-stdio-1.0
96− hs-source-dirs: bench
97− main-is: Main.hs
98− ghc-options: -Wall -O2 -rtsopts
99− build-depends:
100− base,
101− criterion == 1.1.*,
102− deepseq >= 1.3 && < 1.5,
103− dependent-map,
104− dependent-sum,
105− mtl,
106− primitive,
107− reflex,
108− stm,
109− transformers >= 0.3
110−
111−benchmark saulzar-bench
112− type: exitcode-stdio-1.0
113− hs-source-dirs: bench test
114− c-sources: bench-cbits/checkCapability.c
115− main-is: RunAll.hs
116− ghc-options: -Wall -O2 -rtsopts -threaded
117− ghc-prof-options: -auto-all
118− build-depends:
119− base,
120− containers == 0.5.*,
121− criterion == 1.1.*,
122− deepseq >= 1.3 && < 1.5,
123− dependent-map,
124− dependent-sum,
125− loch-th,
126− mtl,
127− primitive,
128− process,
129− ref-tf,
130− reflex,
131− split,
132− stm,
133− time,
134− transformers >= 0.3
135−
136−source-repository head
137− type: git
138− location: https://github.com/reflex-frp/reflex
release.nixnew file+49
@@ -0,0 +1,49 @@
1+{ reflex-platform-fun ? import ./dep/reflex-platform
2+}:
3+
4+let
5+ native-reflex-platform = reflex-platform-fun {};
6+ inherit (native-reflex-platform.nixpkgs) lib;
7+ systems = ["x86_64-linux" "x86_64-darwin"];
8+
9+ perPlatform = lib.genAttrs systems (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+ compilerPkgs = lib.genAttrs compilers (ghc: let
21+ reflex-platform = reflex-platform-fun {
22+ inherit system;
23+ haskellOverlays = [
24+ # Use this package's source for reflex
25+ (self: super: {
26+ _dep = super._dep // {
27+ patch = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [
28+ "release.nix"
29+ ".git"
30+ "dist"
31+ "dist-newstyle"
32+ "cabal.haskell-ci"
33+ "cabal.project"
34+ ".travis.yml"
35+ ])) ./.;
36+ };
37+ })
38+ ];
39+ };
40+ in reflex-platform.${ghc}.patch);
41+ in compilerPkgs // {
42+ cache = reflex-platform.pinBuildInputs "patch-${system}"
43+ (builtins.attrValues compilerPkgs);
44+ });
45+
46+ metaCache = native-reflex-platform.pinBuildInputs "patch-everywhere"
47+ (map (a: a.cache) (builtins.attrValues perPlatform));
48+
49+in perPlatform // { inherit metaCache; }
src/Data/Functor/Misc.hs+119−59
@@ -1,47 +1,55 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveFunctor #-}
24{-# LANGUAGE FlexibleContexts #-}
35{-# LANGUAGE FlexibleInstances #-}
46{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE KindSignatures #-}
7+{-# LANGUAGE LambdaCase #-}
68{-# LANGUAGE MultiParamTypeClasses #-}
79{-# LANGUAGE PolyKinds #-}
810{-# LANGUAGE RankNTypes #-}
911{-# LANGUAGE ScopedTypeVariables #-}
1012{-# LANGUAGE StandaloneDeriving #-}
11−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1213-- | This module provides types and functions with no particular theme, but
1314-- which are relevant to the use of 'Functor'-based datastructures like
1415-- 'Data.Dependent.Map.DMap'.
1516module Data.Functor.Misc
16− ( -- * Const2
17− Const2 (..)
18− , dmapToMap
19− , mapToDMap
20− -- * WrapArg
21− , WrapArg (..)
22− -- * Convenience functions for DMap
23− , mapWithFunctorToDMap
24− , mapKeyValuePairsMonotonic
25− , combineDMapsWithKey
26− -- * Deprecated functions
27− , sequenceDmap
28− , wrapDMap
29− , rewrapDMap
30− , unwrapDMap
31− , unwrapDMapMaybe
32− , extractFunctorDMap
33− ) where
34−
35−import Control.Applicative (Applicative, (<$>))
36−import Control.Monad.Identity
17+ ( -- * Const2
18+ Const2 (..)
19+ , unConst2
20+ , dmapToMap
21+ , dmapToIntMap
22+ , dmapToMapWith
23+ , mapToDMap
24+ , weakenDMapWith
25+ -- * WrapArg
26+ , WrapArg (..)
27+ -- * Convenience functions for DMap
28+ , mapWithFunctorToDMap
29+ , intMapWithFunctorToDMap
30+ , mapKeyValuePairsMonotonic
31+ , combineDMapsWithKey
32+ , EitherTag (..)
33+ , dmapToThese
34+ , eitherToDSum
35+ , dsumToEither
36+ , ComposeMaybe (..)
37+ ) where
38+
39+import Control.Applicative ((<$>))
3740import Data.Dependent.Map (DMap)
3841import qualified Data.Dependent.Map as DMap
3942import Data.Dependent.Sum
43+import Data.Functor.Identity
4044import Data.GADT.Compare
4145import Data.GADT.Show
46+import Data.IntMap (IntMap)
47+import qualified Data.IntMap as IntMap
4248import Data.Map (Map)
4349import qualified Data.Map as Map
50+import Data.Some (Some, mkSome)
4451import Data.These
52+import Data.Type.Equality ((:~:)(Refl))
4553import Data.Typeable hiding (Refl)
4654
4755--------------------------------------------------------------------------------
@@ -54,14 +62,18 @@ data Const2 :: * -> x -> x -> * where
5462 Const2 :: k -> Const2 k v v
5563 deriving (Typeable)
5664
57−deriving instance Show k => Show (Const2 k v v)
65+-- | Extract the value from a Const2
66+unConst2 :: Const2 k v v' -> k
67+unConst2 (Const2 k) = k
68+
69+deriving instance Eq k => Eq (Const2 k v v')
70+deriving instance Ord k => Ord (Const2 k v v')
71+deriving instance Show k => Show (Const2 k v v')
72+deriving instance Read k => Read (Const2 k v v)
5873
5974instance Show k => GShow (Const2 k v) where
6075 gshowsPrec n x@(Const2 _) = showsPrec n x
6176
62−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
63− showTaggedPrec (Const2 _) = showsPrec
64−
6577instance Eq k => GEq (Const2 k v) where
6678 geq (Const2 a) (Const2 b) =
6779 if a == b
@@ -78,6 +90,15 @@ instance Ord k => GCompare (Const2 k v) where
7890dmapToMap :: DMap (Const2 k v) Identity -> Map k v
7991dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
8092
93+-- | Convert a 'DMap' to an 'IntMap'
94+dmapToIntMap :: DMap (Const2 IntMap.Key v) Identity -> IntMap v
95+dmapToIntMap = IntMap.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
96+
97+-- | Convert a 'DMap' to a regular 'Map', applying the given function to remove
98+-- the wrapping 'Functor'
99+dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
100+dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
101+
81102-- | Convert a regular 'Map' to a 'DMap'
82103mapToDMap :: Map k v -> DMap (Const2 k v) Identity
83104mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
@@ -87,6 +108,16 @@ mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v)
87108mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
88109mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
89110
111+-- | Convert a regular 'IntMap', where the values are already wrapped in a
112+-- functor, to a 'DMap'
113+intMapWithFunctorToDMap :: IntMap (f v) -> DMap (Const2 IntMap.Key v) f
114+intMapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . IntMap.toAscList
115+
116+-- | Convert a 'DMap' to a regular 'Map' by forgetting the types associated with
117+-- the keys, using a function to remove the wrapping 'Functor'
118+weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
119+weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (mkSome k, f v)) . DMap.toAscList
120+
90121--------------------------------------------------------------------------------
91122-- WrapArg
92123--------------------------------------------------------------------------------
@@ -97,6 +128,11 @@ mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v
97128data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
98129 WrapArg :: f a -> WrapArg g f (g a)
99130
131+deriving instance Eq (f a) => Eq (WrapArg g f (g' a))
132+deriving instance Ord (f a) => Ord (WrapArg g f (g' a))
133+deriving instance Show (f a) => Show (WrapArg g f (g' a))
134+deriving instance Read (f a) => Read (WrapArg g f (g a))
135+
100136instance GEq f => GEq (WrapArg g f) where
101137 geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
102138
@@ -134,38 +170,62 @@ combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList m
134170 GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
135171 GGT -> (hk :=> f hk (That hv)) : go gs hs'
136172
173+-- | Extract the values of a 'DMap' of 'EitherTag's.
174+dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
175+dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
176+ (Nothing, Nothing) -> Nothing
177+ (Just (Identity a), Nothing) -> Just $ This a
178+ (Nothing, Just (Identity b)) -> Just $ That b
179+ (Just (Identity a), Just (Identity b)) -> Just $ These a b
180+
181+-- | Tag type for 'Either' to use it as a 'DSum'.
182+data EitherTag l r a where
183+ LeftTag :: EitherTag l r l
184+ RightTag :: EitherTag l r r
185+ deriving (Typeable)
186+
187+deriving instance Show (EitherTag l r a)
188+deriving instance Eq (EitherTag l r a)
189+deriving instance Ord (EitherTag l r a)
190+
191+instance GEq (EitherTag l r) where
192+ geq a b = case (a, b) of
193+ (LeftTag, LeftTag) -> Just Refl
194+ (RightTag, RightTag) -> Just Refl
195+ _ -> Nothing
196+
197+instance GCompare (EitherTag l r) where
198+ gcompare a b = case (a, b) of
199+ (LeftTag, LeftTag) -> GEQ
200+ (LeftTag, RightTag) -> GLT
201+ (RightTag, LeftTag) -> GGT
202+ (RightTag, RightTag) -> GEQ
203+
204+instance GShow (EitherTag l r) where
205+ gshowsPrec _ a = case a of
206+ LeftTag -> showString "LeftTag"
207+ RightTag -> showString "RightTag"
208+
209+-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
210+eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
211+eitherToDSum = \case
212+ Left a -> (LeftTag :=> Identity a)
213+ Right b -> (RightTag :=> Identity b)
214+
215+-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
216+dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
217+dsumToEither = \case
218+ (LeftTag :=> Identity a) -> Left a
219+ (RightTag :=> Identity b) -> Right b
220+
137221--------------------------------------------------------------------------------
138−-- Deprecated functions
222+-- ComposeMaybe
139223--------------------------------------------------------------------------------
140224
141−{-# INLINE sequenceDmap #-}
142−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ t -> fmap Identity t)' instead" #-}
143−-- | Run the actions contained in the 'DMap'
144−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
145−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
146−
147−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
148−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
149−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
150−wrapDMap f = DMap.map $ f . runIdentity
151−
152−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
153−-- | Replace one functor for a 'DMap''s values with a different functor
154−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
155−rewrapDMap = DMap.map
156−
157−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
158−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
159−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
160−unwrapDMap f = DMap.map $ Identity . f
161−
162−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
163−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
164−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
165−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
166−
167−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
168−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
169−-- underlying functor
170−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
171−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
225+-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
226+-- make the 'f' parameter have a nominal type role. We need f to be
227+-- representational so that we can use safe 'coerce'.
228+newtype ComposeMaybe f a =
229+ ComposeMaybe { getComposeMaybe :: Maybe (f a) } deriving (Show, Eq, Ord)
230+
231+deriving instance Functor f => Functor (ComposeMaybe f)
src/Data/Monoid/DecidablyEmpty.hsnew file+115
@@ -0,0 +1,115 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DefaultSignatures #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE StandaloneDeriving #-}
5+{-# LANGUAGE TypeOperators #-}
6+
7+-- TODO upstream somwhere else?
8+module Data.Monoid.DecidablyEmpty where
9+
10+import Data.Functor.Identity
11+import Data.Functor.Const
12+import Data.Monoid
13+import Data.Maybe (isNothing)
14+#if MIN_VERSION_base(4,11,0)
15+import Data.Ord
16+#endif
17+import Data.Proxy
18+import Data.Semigroup hiding (First, Last)
19+#if MIN_VERSION_base(4,12,0)
20+import GHC.Generics
21+#endif
22+
23+import qualified Data.IntSet as IntSet
24+import qualified Data.IntMap as IntMap
25+import qualified Data.Map as Map
26+import qualified Data.Sequence as Seq
27+import qualified Data.Set as Set
28+
29+import Data.GADT.Compare
30+import qualified Data.Dependent.Map as DMap
31+
32+-- | A 'DecidablyEmpty' is one where it can be computed whether or not an
33+-- arbitrary value is 'mempty'.
34+--
35+-- By using this class rather than 'Eq', we avoid unnecessary constraining the
36+-- contents of 'Functor's. This makes it possible to efficiently combine and/or
37+-- nest patch maps with 'Eq'-lacking values (e.g. functions) at the leaves.
38+class Monoid a => DecidablyEmpty a where
39+ isEmpty :: a -> Bool
40+ default isEmpty :: Eq a => a -> Bool
41+ isEmpty = (==) mempty
42+
43+-- base
44+
45+instance DecidablyEmpty Ordering
46+instance DecidablyEmpty ()
47+instance DecidablyEmpty Any
48+instance DecidablyEmpty All
49+-- instance DecidablyEmpty Lifetime
50+-- instance DecidablyEmpty Event
51+instance DecidablyEmpty [a] where
52+ isEmpty = null
53+instance
54+#if MIN_VERSION_base(4,11,0)
55+ Semigroup a
56+#else
57+ Monoid a
58+#endif
59+ => DecidablyEmpty (Maybe a) where
60+ isEmpty = isNothing
61+deriving instance (Num a, DecidablyEmpty a) => DecidablyEmpty (Product a)
62+deriving instance (DecidablyEmpty a, Num a) => DecidablyEmpty (Sum a)
63+deriving instance DecidablyEmpty a => DecidablyEmpty (Dual a)
64+instance DecidablyEmpty (First a) where
65+ isEmpty (First a) = isNothing a
66+instance DecidablyEmpty (Last a) where
67+ isEmpty (Last a) = isNothing a
68+deriving instance DecidablyEmpty a => DecidablyEmpty (Identity a)
69+instance Semigroup a => DecidablyEmpty (Option a) where
70+ isEmpty (Option a) = isNothing a
71+deriving instance DecidablyEmpty m => DecidablyEmpty (WrappedMonoid m)
72+instance (Ord a, Bounded a) => DecidablyEmpty (Max a)
73+instance (Ord a, Bounded a) => DecidablyEmpty (Min a)
74+instance DecidablyEmpty (Proxy s)
75+deriving instance DecidablyEmpty a => DecidablyEmpty (Const a b)
76+#if MIN_VERSION_base(4,11,0)
77+deriving instance DecidablyEmpty a => DecidablyEmpty (Down a)
78+#endif
79+#if MIN_VERSION_base(4,12,0)
80+deriving instance DecidablyEmpty p => DecidablyEmpty (Par1 p)
81+instance DecidablyEmpty (U1 p)
82+deriving instance DecidablyEmpty (f p) => DecidablyEmpty (Rec1 f p)
83+deriving instance DecidablyEmpty (f p) => DecidablyEmpty (M1 i c f p)
84+deriving instance DecidablyEmpty c => DecidablyEmpty (K1 i c p)
85+instance (DecidablyEmpty (f p), DecidablyEmpty (g p)) => DecidablyEmpty ((f :*: g) p) where
86+ isEmpty (x :*: y) = isEmpty x && isEmpty y
87+deriving instance DecidablyEmpty (f (g p)) => DecidablyEmpty ((f :.: g) p)
88+#endif
89+
90+instance (DecidablyEmpty a, DecidablyEmpty b) => DecidablyEmpty (a, b) where
91+ isEmpty (a, b) = isEmpty a && isEmpty b
92+instance (DecidablyEmpty a, DecidablyEmpty b, DecidablyEmpty c) => DecidablyEmpty (a, b, c) where
93+ isEmpty (a, b, c) = isEmpty a && isEmpty b && isEmpty c
94+instance (DecidablyEmpty a, DecidablyEmpty b, DecidablyEmpty c, DecidablyEmpty d) => DecidablyEmpty (a, b, c, d) where
95+ isEmpty (a, b, c, d) = isEmpty a && isEmpty b && isEmpty c && isEmpty d
96+instance (DecidablyEmpty a, DecidablyEmpty b, DecidablyEmpty c, DecidablyEmpty d, DecidablyEmpty e) => DecidablyEmpty (a, b, c, d, e) where
97+ isEmpty (a, b, c, d, e) = isEmpty a && isEmpty b && isEmpty c && isEmpty d && isEmpty e
98+
99+-- containers
100+
101+instance DecidablyEmpty IntSet.IntSet where
102+ isEmpty = IntSet.null
103+instance DecidablyEmpty (IntMap.IntMap v) where
104+ isEmpty = IntMap.null
105+instance Ord k => DecidablyEmpty (Map.Map k v) where
106+ isEmpty = Map.null
107+instance DecidablyEmpty (Seq.Seq v) where
108+ isEmpty = Seq.null
109+instance Ord k => DecidablyEmpty (Set.Set k) where
110+ isEmpty = Set.null
111+
112+-- dependent-map
113+
114+instance GCompare k => DecidablyEmpty (DMap.DMap k v) where
115+ isEmpty = DMap.null
src/Data/Patch.hsnew file+95
@@ -0,0 +1,95 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3+{-# LANGUAGE StandaloneDeriving #-}
4+{-# LANGUAGE TypeFamilies #-}
5+{-# LANGUAGE TypeOperators #-}
6+-- |
7+-- Module:
8+-- Data.Patch
9+-- Description:
10+-- This module defines the 'Patch' class.
11+module Data.Patch
12+ ( module Data.Patch
13+ , module X
14+ ) where
15+
16+import Control.Applicative
17+import Data.Functor.Const (Const (..))
18+import Data.Functor.Identity
19+import Data.Map.Monoidal (MonoidalMap)
20+import Data.Proxy
21+#if !MIN_VERSION_base(4,11,0)
22+import Data.Semigroup (Semigroup (..))
23+#endif
24+import GHC.Generics
25+
26+import Data.Semigroup.Additive as X
27+import Data.Patch.Class as X
28+import Data.Patch.DMap as X hiding (getDeletions)
29+import Data.Patch.DMapWithMove as X
30+ ( PatchDMapWithMove, const2PatchDMapWithMoveWith, mapPatchDMapWithMove
31+ , patchDMapWithMoveToPatchMapWithMoveWith
32+ , traversePatchDMapWithMoveWithKey, unPatchDMapWithMove
33+ , unsafePatchDMapWithMove, weakenPatchDMapWithMoveWith
34+ )
35+import Data.Patch.IntMap as X hiding (getDeletions)
36+import Data.Patch.Map as X
37+import Data.Patch.MapWithMove as X
38+ ( PatchMapWithMove, patchMapWithMoveNewElements
39+ , patchMapWithMoveNewElementsMap, unPatchMapWithMove
40+ , unsafePatchMapWithMove
41+ )
42+
43+-- | A 'Group' is a 'Monoid' where every element has an inverse.
44+class (Semigroup q, Monoid q) => Group q where
45+ negateG :: q -> q
46+ (~~) :: q -> q -> q
47+ r ~~ s = r <> negateG s
48+
49+-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
50+newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
51+
52+instance Additive p => Patch (AdditivePatch p) where
53+ type PatchTarget (AdditivePatch p) = p
54+ apply (AdditivePatch p) q = Just $ p <> q
55+
56+instance (Ord k, Group q) => Group (MonoidalMap k q) where
57+ negateG = fmap negateG
58+
59+-- | Trivial group.
60+instance Group () where
61+ negateG _ = ()
62+ _ ~~ _ = ()
63+
64+-- | Product group. A Pair of groups gives rise to a group
65+instance (Group a, Group b) => Group (a, b) where
66+ negateG (a, b) = (negateG a, negateG b)
67+ (a, b) ~~ (c, d) = (a ~~ c, b ~~ d)
68+
69+-- See https://gitlab.haskell.org/ghc/ghc/issues/11135#note_111802 for the reason Compose is not also provided.
70+-- Base does not define Monoid (Compose f g a) so this is the best we can
71+-- really do for functor composition.
72+instance Group (f (g a)) => Group ((f :.: g) a) where
73+ negateG (Comp1 xs) = Comp1 (negateG xs)
74+ Comp1 xs ~~ Comp1 ys = Comp1 (xs ~~ ys)
75+
76+-- | Product of groups, Functor style.
77+instance (Group (f a), Group (g a)) => Group ((f :*: g) a) where
78+ negateG (a :*: b) = negateG a :*: negateG b
79+ (a :*: b) ~~ (c :*: d) = (a ~~ c) :*: (b ~~ d)
80+
81+-- | Trivial group, Functor style
82+instance Group (Proxy x) where
83+ negateG _ = Proxy
84+ _ ~~ _ = Proxy
85+
86+-- | Const lifts groups into a functor.
87+deriving instance Group a => Group (Const a x)
88+
89+-- | Identity lifts groups pointwise (at only one point)
90+deriving instance Group a => Group (Identity a)
91+
92+-- | Functions lift groups pointwise.
93+instance Group b => Group (a -> b) where
94+ negateG f = negateG . f
95+ (~~) = liftA2 (~~)
src/Data/Patch/Class.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
3+{-# LANGUAGE TypeFamilies #-}
4+-- | The interface for types which represent changes made to other types
5+module Data.Patch.Class where
6+
7+import Data.Functor.Identity
8+import Data.Kind (Type)
9+import Data.Maybe
10+#if !MIN_VERSION_base(4,11,0)
11+import Data.Semigroup (Semigroup(..))
12+#endif
13+import Data.Proxy
14+
15+-- | A 'Patch' type represents a kind of change made to a datastructure.
16+--
17+-- If an instance of 'Patch' is also an instance of 'Semigroup', it should obey
18+-- the law that @applyAlways (f <> g) == applyAlways f . applyAlways g@.
19+class Patch p where
20+ type PatchTarget p :: Type
21+ -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
22+ -- 'Nothing'.
23+ apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
24+
25+-- | Apply a 'Patch'; if it does nothing, return the original value
26+applyAlways :: Patch p => p -> PatchTarget p -> PatchTarget p
27+applyAlways p t = fromMaybe t $ apply p t
28+
29+-- | 'Identity' can be used as a 'Patch' that always fully replaces the value
30+instance Patch (Identity a) where
31+ type PatchTarget (Identity a) = a
32+ apply (Identity a) _ = Just a
33+
34+-- | 'Proxy' can be used as a 'Patch' that does nothing.
35+instance forall (a :: Type). Patch (Proxy a) where
36+ type PatchTarget (Proxy a) = a
37+ apply ~Proxy _ = Nothing
38+
39+-- | Like '(.)', but composes functions that return patches rather than
40+-- functions that return new values. The Semigroup instance for patches must
41+-- apply patches right-to-left, like '(.)'.
42+composePatchFunctions :: (Patch p, Semigroup p) => (PatchTarget p -> p) -> (PatchTarget p -> p) -> PatchTarget p -> p
43+composePatchFunctions g f a =
44+ let fp = f a
45+ in g (applyAlways fp a) <> fp
src/Data/Patch/DMap.hsnew file+93
@@ -0,0 +1,93 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3+{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE PolyKinds #-}
5+{-# LANGUAGE Rank2Types #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TypeFamilies #-}
9+
10+-- | 'Patch'es on 'DMap' that consist only of insertions (or overwrites) and deletions.
11+module Data.Patch.DMap where
12+
13+import Data.Patch.Class
14+import Data.Patch.IntMap
15+import Data.Patch.Map
16+
17+import Data.Dependent.Map (DMap)
18+import Data.Dependent.Sum (DSum (..))
19+import Data.GADT.Compare (GCompare (..))
20+import qualified Data.Dependent.Map as DMap
21+import Data.Functor.Constant
22+import Data.Functor.Misc
23+import qualified Data.IntMap as IntMap
24+import qualified Data.Map as Map
25+import Data.Monoid.DecidablyEmpty
26+#if !MIN_VERSION_base(4,11,0)
27+import Data.Semigroup (Semigroup (..))
28+#endif
29+import Data.Some (Some)
30+
31+-- | A set of changes to a 'DMap'. Any element may be inserted/updated or deleted.
32+-- Insertions are represented as @'ComposeMaybe' (Just value)@,
33+-- while deletions are represented as @'ComposeMaybe' Nothing@.
34+newtype PatchDMap k v = PatchDMap { unPatchDMap :: DMap k (ComposeMaybe v) }
35+
36+deriving instance GCompare k => Semigroup (PatchDMap k v)
37+
38+deriving instance GCompare k => Monoid (PatchDMap k v)
39+
40+-- It won't let me derive for some reason
41+instance GCompare k => DecidablyEmpty (PatchDMap k v) where
42+ isEmpty (PatchDMap m) = DMap.null m
43+
44+-- | Apply the insertions or deletions to a given 'DMap'.
45+instance GCompare k => Patch (PatchDMap k v) where
46+ type PatchTarget (PatchDMap k v) = DMap k v
47+ 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?
48+ where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
49+ deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
50+ nothingToJust = \case
51+ Nothing -> Just $ Constant ()
52+ Just _ -> Nothing
53+
54+-- | Map a function @v a -> v' a@ over any inserts/updates in the given
55+-- @'PatchDMap' k v@ to produce a @'PatchDMap' k v'@.
56+mapPatchDMap :: (forall a. v a -> v' a) -> PatchDMap k v -> PatchDMap k v'
57+mapPatchDMap f (PatchDMap p) = PatchDMap $ DMap.map (ComposeMaybe . fmap f . getComposeMaybe) p
58+
59+-- | Map an effectful function @v a -> f (v' a)@ over any inserts/updates in the given
60+-- @'PatchDMap' k v@ to produce a @'PatchDMap' k v'@.
61+traversePatchDMap :: Applicative f => (forall a. v a -> f (v' a)) -> PatchDMap k v -> f (PatchDMap k v')
62+traversePatchDMap f = traversePatchDMapWithKey $ const f
63+
64+-- | Map an effectful function @k a -> v a -> f (v' a)@ over any inserts/updates
65+-- in the given @'PatchDMap' k v@ to produce a @'PatchDMap' k v'@.
66+traversePatchDMapWithKey :: Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
67+traversePatchDMapWithKey f (PatchDMap p) = PatchDMap <$> DMap.traverseWithKey (\k (ComposeMaybe v) -> ComposeMaybe <$> traverse (f k) v) p
68+
69+-- | Weaken a @'PatchDMap' k v@ to a @'PatchMap' (Some k) v'@ using a function
70+-- @v a -> v'@ to weaken each value contained in the patch.
71+weakenPatchDMapWith :: (forall a. v a -> v') -> PatchDMap k v -> PatchMap (Some k) v'
72+weakenPatchDMapWith f (PatchDMap p) = PatchMap $ weakenDMapWith (fmap f . getComposeMaybe) p
73+
74+-- | Convert a weak @'PatchDMap' ('Const2' k a) v@ where the @a@ is known by way of
75+-- the @Const2@ into a @'PatchMap' k v'@ using a rank 1 function @v a -> v'@.
76+patchDMapToPatchMapWith :: (v a -> v') -> PatchDMap (Const2 k a) v -> PatchMap k v'
77+patchDMapToPatchMapWith f (PatchDMap p) = PatchMap $ dmapToMapWith (fmap f . getComposeMaybe) p
78+
79+-- | Convert a @'PatchMap' k v@ into a @'PatchDMap' ('Const2' k a) v'@ using a function @v -> v' a@.
80+const2PatchDMapWith :: forall k v v' a. (v -> v' a) -> PatchMap k v -> PatchDMap (Const2 k a) v'
81+const2PatchDMapWith f (PatchMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
82+ where g :: (k, Maybe v) -> DSum (Const2 k a) (ComposeMaybe v')
83+ g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
84+
85+-- | Convert a @'PatchIntMap' v@ into a @'PatchDMap' ('Const2' Int a) v'@ using a function @v -> v' a@.
86+const2IntPatchDMapWith :: forall v f a. (v -> f a) -> PatchIntMap v -> PatchDMap (Const2 IntMap.Key a) f
87+const2IntPatchDMapWith f (PatchIntMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> IntMap.toAscList p
88+ where g :: (IntMap.Key, Maybe v) -> DSum (Const2 IntMap.Key a) (ComposeMaybe f)
89+ g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
90+
91+-- | Get the values that will be replaced or deleted if the given patch is applied to the given 'DMap'.
92+getDeletions :: GCompare k => PatchDMap k v -> DMap k v' -> DMap k v'
93+getDeletions (PatchDMap p) m = DMap.intersectionWithKey (\_ v _ -> v) m p
src/Data/Patch/DMapWithMove.hsnew file+371
@@ -0,0 +1,371 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE PolyKinds #-}
9+{-# LANGUAGE Rank2Types #-}
10+{-# LANGUAGE ScopedTypeVariables #-}
11+{-# LANGUAGE TypeFamilies #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+
14+-- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
15+-- move values between keys.
16+module Data.Patch.DMapWithMove where
17+
18+import Data.Patch.Class
19+import Data.Patch.MapWithMove (PatchMapWithMove (..))
20+import qualified Data.Patch.MapWithMove as MapWithMove
21+
22+import Data.Constraint.Extras
23+import Data.Dependent.Map (DMap)
24+import Data.Dependent.Sum (DSum (..))
25+import qualified Data.Dependent.Map as DMap
26+import Data.Functor.Constant
27+import Data.Functor.Misc
28+import Data.Functor.Product
29+import Data.GADT.Compare (GEq (..), GCompare (..))
30+import Data.GADT.Show (GShow, gshow)
31+import qualified Data.Map as Map
32+import Data.Maybe
33+import Data.Monoid.DecidablyEmpty
34+#if !MIN_VERSION_base(4,11,0)
35+import Data.Semigroup (Semigroup (..))
36+#endif
37+import Data.Some (Some, mkSome)
38+import Data.These
39+
40+-- | Like 'PatchMapWithMove', but for 'DMap'. Each key carries a 'NodeInfo' which describes how it will be changed by the patch and connects move sources and
41+-- destinations.
42+--
43+-- Invariants:
44+--
45+-- * A key should not move to itself.
46+-- * A move should always be represented with both the destination key (as a 'From_Move') and the source key (as a @'ComposeMaybe' ('Just' destination)@)
47+newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
48+
49+-- It won't let me derive for some reason
50+instance GCompare k => DecidablyEmpty (PatchDMapWithMove k v) where
51+ isEmpty (PatchDMapWithMove m) = DMap.null m
52+
53+-- |Structure which represents what changes apply to a particular key. @_nodeInfo_from@ specifies what happens to this key, and in particular what other key
54+-- the current key is moving from, while @_nodeInfo_to@ specifies what key the current key is moving to if involved in a move.
55+data NodeInfo k v a = NodeInfo
56+ { _nodeInfo_from :: !(From k v a)
57+ -- ^Change applying to the current key, be it an insert, move, or delete.
58+ , _nodeInfo_to :: !(To k a)
59+ -- ^Where this key is moving to, if involved in a move. Should only be @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
60+ }
61+ deriving (Show)
62+
63+-- |Structure describing a particular change to a key, be it inserting a new key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting a
64+-- key (@From_Delete@), or moving a key (@From_Move@).
65+data From (k :: a -> *) (v :: a -> *) :: a -> * where
66+ -- |Insert a new or update an existing key with the given value @v a@
67+ From_Insert :: v a -> From k v a
68+ -- |Delete the existing key
69+ From_Delete :: From k v a
70+ -- |Move the value from the given key @k a@ to this key. The source key should also have an entry in the patch giving the current key as @_nodeInfo_to@,
71+ -- usually but not necessarily with @From_Delete@.
72+ From_Move :: !(k a) -> From k v a
73+ deriving (Show, Read, Eq, Ord)
74+
75+-- |Type alias for the "to" part of a 'NodeInfo'. @'ComposeMaybe' ('Just' k)@ means the key is moving to another key, @ComposeMaybe Nothing@ for any other
76+-- operation.
77+type To = ComposeMaybe
78+
79+-- |Test whether a 'PatchDMapWithMove' satisfies its invariants.
80+validPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Bool
81+validPatchDMapWithMove = not . null . validationErrorsForPatchDMapWithMove
82+
83+-- |Enumerate what reasons a 'PatchDMapWithMove' doesn't satisfy its invariants, returning @[]@ if it's valid.
84+validationErrorsForPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> [String]
85+validationErrorsForPatchDMapWithMove m =
86+ noSelfMoves <> movesBalanced
87+ where
88+ noSelfMoves = mapMaybe selfMove . DMap.toAscList $ m
89+ selfMove (dst :=> NodeInfo (From_Move src) _) | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
90+ selfMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) | Just _ <- src `geq` dst = Just $ "self move of key " <> gshow dst <> " at source side"
91+ selfMove _ = Nothing
92+ movesBalanced = mapMaybe unbalancedMove . DMap.toAscList $ m
93+ unbalancedMove (dst :=> NodeInfo (From_Move src) _) =
94+ case DMap.lookup src m of
95+ Nothing -> Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key is not in the patch"
96+ Just (NodeInfo _ (ComposeMaybe (Just dst'))) ->
97+ if isNothing (dst' `geq` dst)
98+ then Just $ "unbalanced move at destination key " <> gshow dst <> " from " <> gshow src <> " is going to " <> gshow dst' <> " instead"
99+ else Nothing
100+ _ ->
101+ Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key has no move to key"
102+ unbalancedMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) =
103+ case DMap.lookup dst m of
104+ Nothing -> Just $ " unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not in the patch"
105+ Just (NodeInfo (From_Move src') _) ->
106+ if isNothing (src' `geq` src)
107+ then Just $ "unbalanced move at source key " <> gshow src <> " to " <> gshow dst <> " is coming from " <> gshow src' <> " instead"
108+ else Nothing
109+
110+ _ ->
111+ Just $ "unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not moving"
112+ unbalancedMove _ = Nothing
113+
114+-- |Test whether two @'PatchDMapWithMove' k v@ contain the same patch operations.
115+instance (GEq k, Has' Eq k (NodeInfo k v)) => Eq (PatchDMapWithMove k v) where
116+ PatchDMapWithMove a == PatchDMapWithMove b = a == b
117+
118+-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
119+data Pair1 f g a = Pair1 (f a) (g a)
120+
121+-- |Helper data structure used for composing patches using the monoid instance.
122+data Fixup k v a
123+ = Fixup_Delete
124+ | Fixup_Update (These (From k v a) (To k a))
125+
126+-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
127+instance GCompare k => Semigroup (PatchDMapWithMove k v) where
128+ PatchDMapWithMove ma <> PatchDMapWithMove mb = PatchDMapWithMove m
129+ where
130+ connections = DMap.toList $ DMap.intersectionWithKey (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b)) ma mb
131+ h :: DSum k (Pair1 (ComposeMaybe k) (From k v)) -> [DSum k (Fixup k v)]
132+ h (_ :=> Pair1 (ComposeMaybe mToAfter) editBefore) = case (mToAfter, editBefore) of
133+ (Just toAfter, From_Move fromBefore)
134+ | isJust $ fromBefore `geq` toAfter
135+ -> [toAfter :=> Fixup_Delete]
136+ | otherwise
137+ -> [ toAfter :=> Fixup_Update (This editBefore)
138+ , fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))
139+ ]
140+ (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
141+ (Just toAfter, _) -> [toAfter :=> Fixup_Update (This editBefore)]
142+ (Nothing, _) -> []
143+ mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
144+ mergeFixups _ (Fixup_Update a) (Fixup_Update b)
145+ | This x <- a, That y <- b
146+ = Fixup_Update $ These x y
147+ | That y <- a, This x <- b
148+ = Fixup_Update $ These x y
149+ mergeFixups _ _ _ = error "PatchDMapWithMove: incompatible fixups"
150+ fixups = DMap.fromListWithKey mergeFixups $ concatMap h connections
151+ combineNodeInfos _ nia nib = NodeInfo
152+ { _nodeInfo_from = _nodeInfo_from nia
153+ , _nodeInfo_to = _nodeInfo_to nib
154+ }
155+ applyFixup _ ni = \case
156+ Fixup_Delete -> Nothing
157+ Fixup_Update u -> Just $ NodeInfo
158+ { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
159+ , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
160+ }
161+ m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
162+ getHere :: These a b -> Maybe a
163+ getHere = \case
164+ This a -> Just a
165+ These a _ -> Just a
166+ That _ -> Nothing
167+ getThere :: These a b -> Maybe b
168+ getThere = \case
169+ This _ -> Nothing
170+ These _ b -> Just b
171+ That b -> Just b
172+
173+-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
174+instance GCompare k => Monoid (PatchDMapWithMove k v) where
175+ mempty = PatchDMapWithMove mempty
176+ mappend = (<>)
177+
178+{-
179+mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
180+PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
181+ where
182+ 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
183+ removeRedundantDst toKey (From_Move fromKey) | isJust (toKey `geq` fromKey) = Nothing
184+ removeRedundantDst _ a = Just a
185+ f :: forall a. k a -> From k v a -> Maybe (From k v a)
186+ f toKey _ = removeRedundantDst toKey $ case getDstAction toKey dstAfter of
187+ From_Move fromKey -> getDstAction fromKey dstBefore
188+ nonMove -> nonMove
189+ dst = DMap.mapMaybeWithKey f $ DMap.union dstAfter dstBefore
190+ getSrcAction k m = fromMaybe (ComposeMaybe $ Just k) $ DMap.lookup k m
191+ removeRedundantSrc fromKey (ComposeMaybe (Just toKey)) | isJust (fromKey `geq` toKey) = Nothing
192+ removeRedundantSrc _ a = Just a
193+ g :: forall a. k a -> ComposeMaybe k a -> Maybe (ComposeMaybe k a)
194+ g fromKey _ = removeRedundantSrc fromKey $ case getSrcAction fromKey srcBefore of
195+ ComposeMaybe Nothing -> ComposeMaybe Nothing
196+ ComposeMaybe (Just toKeyBefore) -> getSrcAction toKeyBefore srcAfter
197+ src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
198+-}
199+
200+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of inserting or updating a value @v a@ to the given key @k a@, like 'DMap.insert'.
201+insertDMapKey :: k a -> v a -> PatchDMapWithMove k v
202+insertDMapKey k v =
203+ PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
204+
205+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of moving the value from the first key @k a@ to the second key @k a@, equivalent to:
206+--
207+-- @
208+-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
209+-- @
210+moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
211+moveDMapKey src dst = case src `geq` dst of
212+ Nothing -> PatchDMapWithMove $ DMap.fromList
213+ [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
214+ , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
215+ ]
216+ Just _ -> mempty
217+
218+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
219+--
220+-- @
221+-- let aMay = DMap.lookup a dmap
222+-- bMay = DMap.lookup b dmap
223+-- in maybe id (DMap.insert a) (bMay <> aMay)
224+-- . maybe id (DMap.insert b) (aMay <> bMay)
225+-- . DMap.delete a . DMap.delete b $ dmap
226+-- @
227+swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
228+swapDMapKey src dst = case src `geq` dst of
229+ Nothing -> PatchDMapWithMove $ DMap.fromList
230+ [ dst :=> NodeInfo (From_Move src) (ComposeMaybe $ Just src)
231+ , src :=> NodeInfo (From_Move dst) (ComposeMaybe $ Just dst)
232+ ]
233+ Just _ -> mempty
234+
235+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'DMap.delete'.
236+deleteDMapKey :: k a -> PatchDMapWithMove k v
237+deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
238+
239+{-
240+k1, k2 :: Const2 Int () ()
241+k1 = Const2 1
242+k2 = Const2 2
243+p1, p2 :: PatchDMapWithMove (Const2 Int ()) Identity
244+p1 = moveDMapKey k1 k2
245+p2 = moveDMapKey k2 k1
246+p12 = p1 <> p2
247+p21 = p2 <> p1
248+p12Slow = p1 `mappendPatchDMapWithMoveSlow` p2
249+p21Slow = p2 `mappendPatchDMapWithMoveSlow` p1
250+
251+testPatchDMapWithMove = do
252+ print p1
253+ print p2
254+ print $ p12 == deleteDMapKey k1
255+ print $ p21 == deleteDMapKey k2
256+ print $ p12Slow == deleteDMapKey k1
257+ print $ p21Slow == deleteDMapKey k2
258+
259+dst (PatchDMapWithMove x _) = x
260+src (PatchDMapWithMove _ x) = x
261+-}
262+
263+-- |Extract the 'DMap' representing the patch changes from the 'PatchDMapWithMove'.
264+unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
265+unPatchDMapWithMove (PatchDMapWithMove p) = p
266+
267+-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove', without checking any invariants.
268+--
269+-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithMove' are preserved; they will not be checked.
270+unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
271+unsafePatchDMapWithMove = PatchDMapWithMove
272+
273+-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while checking invariants. If the invariants are satisfied, @Right p@ is returned
274+-- otherwise @Left errors@.
275+patchDMapWithMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
276+patchDMapWithMove dm =
277+ case validationErrorsForPatchDMapWithMove dm of
278+ [] -> Right $ unsafePatchDMapWithMove dm
279+ errs -> Left errs
280+
281+-- |Map a natural transform @v -> v'@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
282+mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
283+mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $
284+ DMap.map (\ni -> ni { _nodeInfo_from = g $ _nodeInfo_from ni }) p
285+ where g :: forall a. From k v a -> From k v' a
286+ g = \case
287+ From_Insert v -> From_Insert $ f v
288+ From_Delete -> From_Delete
289+ From_Move k -> From_Move k
290+
291+-- |Traverse an effectful function @forall a. v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
292+traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
293+traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
294+
295+-- |Map an effectful function @forall a. k a -> v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
296+traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
297+traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
298+ where g :: forall a. k a -> From k v a -> m (From k v' a)
299+ g k = \case
300+ From_Insert v -> From_Insert <$> f k v
301+ From_Delete -> pure From_Delete
302+ From_Move fromKey -> pure $ From_Move fromKey
303+
304+-- |Map a function which transforms @'From' k v a@ into a @'From' k v' a@ over a @'NodeInfo' k v a@.
305+nodeInfoMapFrom :: (From k v a -> From k v' a) -> NodeInfo k v a -> NodeInfo k v' a
306+nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
307+
308+-- |Map an effectful function which transforms @'From' k v a@ into a @f ('From' k v' a)@ over a @'NodeInfo' k v a@.
309+nodeInfoMapFromM :: Functor f => (From k v a -> f (From k v' a)) -> NodeInfo k v a -> f (NodeInfo k v' a)
310+nodeInfoMapFromM f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
311+
312+-- |Weaken a 'PatchDMapWithMove' to a 'PatchMapWithMove' by weakening the keys from @k a@ to @'Some' k@ and applying a given weakening function @v a -> v'@ to
313+-- values.
314+weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) v'
315+weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
316+ where g :: forall a. NodeInfo k v a -> MapWithMove.NodeInfo (Some k) v'
317+ g ni = MapWithMove.NodeInfo
318+ { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
319+ From_Insert v -> MapWithMove.From_Insert $ f v
320+ From_Delete -> MapWithMove.From_Delete
321+ From_Move k -> MapWithMove.From_Move $ mkSome k
322+ , MapWithMove._nodeInfo_to = mkSome <$> getComposeMaybe (_nodeInfo_to ni)
323+ }
324+
325+-- |"Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
326+-- dependency in the typing and all points are already @a@, hence the function to map each value to @v'@ is not higher rank.
327+patchDMapWithMoveToPatchMapWithMoveWith :: forall k v v' a. (v a -> v') -> PatchDMapWithMove (Const2 k a) v -> PatchMapWithMove k v'
328+patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
329+ where g :: NodeInfo (Const2 k a) v a -> MapWithMove.NodeInfo k v'
330+ g ni = MapWithMove.NodeInfo
331+ { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
332+ From_Insert v -> MapWithMove.From_Insert $ f v
333+ From_Delete -> MapWithMove.From_Delete
334+ From_Move (Const2 k) -> MapWithMove.From_Move k
335+ , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
336+ }
337+
338+-- |"Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove ('Const2' k a)@; that is, turn a non-dependently-typed patch into a dependently typed
339+-- one but which always has a constant key type represented by 'Const2'. Apply the given function to each @v@ to produce a @v' a@.
340+-- Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
341+const2PatchDMapWithMoveWith :: forall k v v' a. (v -> v' a) -> PatchMapWithMove k v -> PatchDMapWithMove (Const2 k a) v'
342+const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
343+ where g :: (k, MapWithMove.NodeInfo k v) -> DSum (Const2 k a) (NodeInfo (Const2 k a) v')
344+ g (k, ni) = Const2 k :=> NodeInfo
345+ { _nodeInfo_from = case MapWithMove._nodeInfo_from ni of
346+ MapWithMove.From_Insert v -> From_Insert $ f v
347+ MapWithMove.From_Delete -> From_Delete
348+ MapWithMove.From_Move fromKey -> From_Move $ Const2 fromKey
349+ , _nodeInfo_to = ComposeMaybe $ Const2 <$> MapWithMove._nodeInfo_to ni
350+ }
351+
352+-- | Apply the insertions, deletions, and moves to a given 'DMap'.
353+instance GCompare k => Patch (PatchDMapWithMove k v) where
354+ type PatchTarget (PatchDMapWithMove k v) = DMap k v
355+ 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?
356+ where insertions = DMap.mapMaybeWithKey insertFunc p
357+ insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
358+ insertFunc _ ni = case _nodeInfo_from ni of
359+ From_Insert v -> Just v
360+ From_Move k -> DMap.lookup k old
361+ From_Delete -> Nothing
362+ deletions = DMap.mapMaybeWithKey deleteFunc p
363+ deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
364+ deleteFunc _ ni = case _nodeInfo_from ni of
365+ From_Delete -> Just $ Constant ()
366+ _ -> Nothing
367+
368+-- | Get the values that will be replaced, deleted, or moved if the given patch is applied to the given 'DMap'.
369+getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
370+getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
371+ where f _ v ni = Pair v $ _nodeInfo_to ni
src/Data/Patch/IntMap.hsnew file+76
@@ -0,0 +1,76 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveTraversable #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE MultiParamTypeClasses #-}
6+{-# LANGUAGE StandaloneDeriving #-}
7+{-# LANGUAGE TemplateHaskell #-}
8+{-# LANGUAGE TypeFamilies #-}
9+
10+-- | Module containing 'PatchIntMap', a 'Patch' for 'IntMap' which allows for
11+-- insert/update or delete of associations.
12+module Data.Patch.IntMap where
13+
14+import Control.Lens
15+import Data.IntMap.Strict (IntMap)
16+import qualified Data.IntMap.Strict as IntMap
17+import Data.Maybe
18+import Data.Monoid.DecidablyEmpty
19+#if !MIN_VERSION_base(4,11,0)
20+import Data.Semigroup (Semigroup (..))
21+#endif
22+import Data.Patch.Class
23+
24+-- | 'Patch' for 'IntMap' which represents insertion or deletion of keys in the mapping.
25+-- Internally represented by 'IntMap (Maybe a)', where @Just@ means insert/update
26+-- and @Nothing@ means delete.
27+newtype PatchIntMap a = PatchIntMap { unPatchIntMap :: IntMap (Maybe a) }
28+ deriving ( Show, Read, Eq, Ord
29+ , Functor, Foldable, Traversable
30+ , Monoid, DecidablyEmpty
31+ )
32+
33+-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
34+-- If the same key is modified by both patches, the one on the left will take
35+-- precedence.
36+deriving instance Semigroup (PatchIntMap v)
37+
38+makeWrapped ''PatchIntMap
39+
40+-- | Apply the insertions or deletions to a given 'IntMap'.
41+instance Patch (PatchIntMap a) where
42+ type PatchTarget (PatchIntMap a) = IntMap a
43+ apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
44+ let removes = IntMap.filter isNothing p
45+ adds = IntMap.mapMaybe id p
46+ in IntMap.union adds $ v `IntMap.difference` removes
47+
48+instance FunctorWithIndex Int PatchIntMap
49+instance FoldableWithIndex Int PatchIntMap
50+instance TraversableWithIndex Int PatchIntMap where
51+ itraverse = itraversed . Indexed
52+ itraversed = _Wrapped .> itraversed <. traversed
53+
54+-- | Map a function @Int -> a -> b@ over all @a@s in the given @'PatchIntMap' a@
55+-- (that is, all inserts/updates), producing a @PatchIntMap b@.
56+mapIntMapPatchWithKey :: (Int -> a -> b) -> PatchIntMap a -> PatchIntMap b
57+mapIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap $ IntMap.mapWithKey (\ k mv -> f k <$> mv) m
58+
59+-- | Map an effectful function @Int -> a -> f b@ over all @a@s in the given @'PatchIntMap' a@
60+-- (that is, all inserts/updates), producing a @f (PatchIntMap b)@.
61+traverseIntMapPatchWithKey :: Applicative f => (Int -> a -> f b) -> PatchIntMap a -> f (PatchIntMap b)
62+traverseIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap <$> IntMap.traverseWithKey (traverse . f) m
63+
64+-- | Extract all @a@s inserted/updated by the given @'PatchIntMap' a@.
65+patchIntMapNewElements :: PatchIntMap a -> [a]
66+patchIntMapNewElements (PatchIntMap m) = catMaybes $ IntMap.elems m
67+
68+-- | Convert the given @'PatchIntMap' a@ into an @'IntMap' a@ with all
69+-- the inserts/updates in the given patch.
70+patchIntMapNewElementsMap :: PatchIntMap a -> IntMap a
71+patchIntMapNewElementsMap (PatchIntMap m) = IntMap.mapMaybe id m
72+
73+-- | Subset the given @'IntMap' a@ to contain only the keys that would be
74+-- deleted by the given @'PatchIntMap' a@.
75+getDeletions :: PatchIntMap v -> IntMap v' -> IntMap v'
76+getDeletions (PatchIntMap m) v = IntMap.intersection v m
src/Data/Patch/Map.hsnew file+72
@@ -0,0 +1,72 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveTraversable #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TemplateHaskell #-}
9+{-# LANGUAGE TypeFamilies #-}
10+
11+-- | 'Patch'es on 'Map' that consist only of insertions (including overwrites)
12+-- and deletions
13+module Data.Patch.Map where
14+
15+import Data.Patch.Class
16+
17+import Control.Lens
18+import Data.Map (Map)
19+import qualified Data.Map as Map
20+import Data.Maybe
21+import Data.Monoid.DecidablyEmpty
22+import Data.Semigroup (Semigroup (..), stimesIdempotentMonoid)
23+
24+-- | A set of changes to a 'Map'. Any element may be inserted/updated or
25+-- deleted. Insertions are represented as values wrapped in 'Just', while
26+-- deletions are represented as 'Nothing's
27+newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
28+ deriving ( Show, Read, Eq, Ord
29+ , Foldable, Traversable
30+ , DecidablyEmpty
31+ )
32+
33+-- | 'fmap'ping a 'PatchMap' will alter all of the values it will insert.
34+-- Deletions are unaffected.
35+deriving instance Functor (PatchMap k)
36+-- | The empty 'PatchMap' contains no insertions or deletions
37+deriving instance Ord k => Monoid (PatchMap k v)
38+
39+-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
40+-- If the same key is modified by both patches, the one on the left will take
41+-- precedence.
42+instance Ord k => Semigroup (PatchMap k v) where
43+ PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
44+ -- PatchMap is idempotent, so stimes n is id for every n
45+ stimes = stimesIdempotentMonoid
46+
47+-- | Apply the insertions or deletions to a given 'Map'.
48+instance Ord k => Patch (PatchMap k v) where
49+ type PatchTarget (PatchMap k v) = Map k v
50+ {-# INLINABLE apply #-}
51+ 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?
52+ where insertions = Map.mapMaybeWithKey (const id) p
53+ deletions = Map.mapMaybeWithKey (const nothingToJust) p
54+ nothingToJust = \case
55+ Nothing -> Just ()
56+ Just _ -> Nothing
57+
58+instance FunctorWithIndex k (PatchMap k)
59+instance FoldableWithIndex k (PatchMap k)
60+instance TraversableWithIndex k (PatchMap k) where
61+ itraverse = itraversed . Indexed
62+ itraversed = _Wrapped .> itraversed <. traversed
63+
64+-- | Returns all the new elements that will be added to the 'Map'
65+patchMapNewElements :: PatchMap k v -> [v]
66+patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
67+
68+-- | Returns all the new elements that will be added to the 'Map'
69+patchMapNewElementsMap :: PatchMap k v -> Map k v
70+patchMapNewElementsMap (PatchMap p) = Map.mapMaybe id p
71+
72+makeWrapped ''PatchMap
src/Data/Patch/MapWithMove.hsnew file+312
@@ -0,0 +1,312 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveTraversable #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6+{-# LANGUAGE LambdaCase #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE PatternGuards #-}
9+{-# LANGUAGE PatternSynonyms #-}
10+{-# LANGUAGE ScopedTypeVariables #-}
11+{-# LANGUAGE StandaloneDeriving #-}
12+{-# LANGUAGE TemplateHaskell #-}
13+{-# LANGUAGE TypeApplications #-}
14+{-# LANGUAGE TypeFamilies #-}
15+{-# LANGUAGE ViewPatterns #-}
16+
17+-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
18+-- another
19+module Data.Patch.MapWithMove
20+ ( PatchMapWithMove
21+ ( PatchMapWithMove
22+ , unPatchMapWithMove
23+ , ..
24+ )
25+ , patchMapWithMove
26+ , patchMapWithMoveInsertAll
27+ , insertMapKey
28+ , moveMapKey
29+ , swapMapKey
30+ , deleteMapKey
31+ , unsafePatchMapWithMove
32+ , patchMapWithMoveNewElements
33+ , patchMapWithMoveNewElementsMap
34+ , patchThatSortsMapWith
35+ , patchThatChangesAndSortsMapWith
36+ , patchThatChangesMap
37+
38+ -- * Node Info
39+ , NodeInfo
40+ ( NodeInfo
41+ , _nodeInfo_to
42+ , _nodeInfo_from
43+ , ..
44+ )
45+ , bitraverseNodeInfo
46+ , nodeInfoMapFrom
47+ , nodeInfoMapMFrom
48+ , nodeInfoSetTo
49+
50+ -- * From
51+ , From
52+ ( From_Insert
53+ , From_Delete
54+ , From_Move
55+ , ..
56+ )
57+ , bitraverseFrom
58+
59+ -- * To
60+ , To
61+ ) where
62+
63+import Data.Coerce
64+import Data.Kind (Type)
65+import Data.Patch.Class
66+import Data.Patch.MapWithPatchingMove (PatchMapWithPatchingMove(..), To)
67+import qualified Data.Patch.MapWithPatchingMove as PM -- already a transparent synonym
68+
69+import Control.Lens
70+import Data.List
71+import Data.Map (Map)
72+import qualified Data.Map as Map
73+import Data.Proxy
74+#if !MIN_VERSION_base(4,11,0)
75+import Data.Semigroup (Semigroup (..))
76+#endif
77+import Data.Traversable (foldMapDefault)
78+
79+-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
80+-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
81+-- and vice versa. There should never be any unpaired From/To keys.
82+newtype PatchMapWithMove k (v :: Type) = PatchMapWithMove'
83+ { -- | Extract the underlying 'PatchMapWithPatchingMove k (Proxy v)'
84+ unPatchMapWithMove' :: PatchMapWithPatchingMove k (Proxy v)
85+ }
86+ deriving ( Show, Read, Eq, Ord
87+-- Haddock cannot handle documentation here before GHC 8.6
88+ ,
89+#if __GLASGOW_HASKELL__ >= 806
90+ -- | Compose patches having the same effect as applying the
91+ -- patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p .
92+ -- 'applyAlways' q@
93+#endif
94+ Semigroup
95+ , Monoid
96+ )
97+
98+pattern Coerce :: Coercible a b => a -> b
99+pattern Coerce x <- (coerce -> x)
100+ where Coerce x = coerce x
101+
102+{-# COMPLETE PatchMapWithMove #-}
103+pattern PatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
104+-- | Extract the representation of the 'PatchMapWithMove' as a map of
105+-- 'NodeInfo'.
106+unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
107+pattern PatchMapWithMove { unPatchMapWithMove } = PatchMapWithMove' (PatchMapWithPatchingMove (Coerce unPatchMapWithMove))
108+
109+_PatchMapWithMove
110+ :: Iso
111+ (PatchMapWithMove k0 v0)
112+ (PatchMapWithMove k1 v1)
113+ (Map k0 (NodeInfo k0 v0))
114+ (Map k1 (NodeInfo k1 v1))
115+_PatchMapWithMove = iso unPatchMapWithMove PatchMapWithMove
116+
117+instance Functor (PatchMapWithMove k) where
118+ fmap f = runIdentity . traverse (Identity . f)
119+
120+instance Foldable (PatchMapWithMove k) where
121+ foldMap = foldMapDefault
122+
123+instance Traversable (PatchMapWithMove k) where
124+ traverse =
125+ _PatchMapWithMove .
126+ traverse .
127+ traverse
128+
129+instance FunctorWithIndex k (PatchMapWithMove k)
130+instance FoldableWithIndex k (PatchMapWithMove k)
131+instance TraversableWithIndex k (PatchMapWithMove k) where
132+ itraverse = itraversed . Indexed
133+ itraversed =
134+ _PatchMapWithMove .>
135+ itraversed <.
136+ traverse
137+
138+-- | Create a 'PatchMapWithMove', validating it
139+patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
140+patchMapWithMove = fmap PatchMapWithMove' . PM.patchMapWithPatchingMove . coerce
141+
142+-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
143+patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
144+patchMapWithMoveInsertAll = PatchMapWithMove' . PM.patchMapWithPatchingMoveInsertAll
145+
146+-- | Make a @'PatchMapWithMove' k v@ which has the effect of inserting or updating a value @v@ to the given key @k@, like 'Map.insert'.
147+insertMapKey :: k -> v -> PatchMapWithMove k v
148+insertMapKey k v = PatchMapWithMove' $ PM.insertMapKey k v
149+
150+-- |Make a @'PatchMapWithMove' k v@ which has the effect of moving the value from the first key @k@ to the second key @k@, equivalent to:
151+--
152+-- @
153+-- 'Map.delete' src (maybe map ('Map.insert' dst) (Map.lookup src map))
154+-- @
155+moveMapKey :: Ord k => k -> k -> PatchMapWithMove k v
156+moveMapKey src dst = PatchMapWithMove' $ PM.moveMapKey src dst
157+
158+-- |Make a @'PatchMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
159+--
160+-- @
161+-- let aMay = Map.lookup a map
162+-- bMay = Map.lookup b map
163+-- in maybe id (Map.insert a) (bMay <> aMay)
164+-- . maybe id (Map.insert b) (aMay <> bMay)
165+-- . Map.delete a . Map.delete b $ map
166+-- @
167+swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
168+swapMapKey src dst = PatchMapWithMove' $ PM.swapMapKey src dst
169+
170+-- |Make a @'PatchMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'Map.delete'.
171+deleteMapKey :: k -> PatchMapWithMove k v
172+deleteMapKey = PatchMapWithMove' . PM.deleteMapKey
173+
174+-- | Wrap a @'Map' k (NodeInfo k v)@ representing patch changes into a @'PatchMapWithMove' k v@, without checking any invariants.
175+--
176+-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithMove' are preserved; they will not be checked.
177+unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
178+unsafePatchMapWithMove = coerce PM.unsafePatchMapWithPatchingMove
179+
180+-- | Apply the insertions, deletions, and moves to a given 'Map'
181+instance Ord k => Patch (PatchMapWithMove k v) where
182+ type PatchTarget (PatchMapWithMove k v) = Map k v
183+ apply (PatchMapWithMove' p) = apply p
184+
185+-- | Returns all the new elements that will be added to the 'Map'.
186+patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
187+patchMapWithMoveNewElements = PM.patchMapWithPatchingMoveNewElements . unPatchMapWithMove'
188+
189+-- | Return a @'Map' k v@ with all the inserts/updates from the given @'PatchMapWithMove' k v@.
190+patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
191+patchMapWithMoveNewElementsMap = PM.patchMapWithPatchingMoveNewElementsMap . unPatchMapWithMove'
192+
193+-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
194+-- its values using the given ordering function. The set keys of the 'Map' is
195+-- not changed.
196+patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
197+patchThatSortsMapWith cmp = PatchMapWithMove' . PM.patchThatSortsMapWith cmp
198+
199+-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
200+-- will produce a 'Map' with the same values as the second 'Map' but with the
201+-- values sorted with the given ordering function.
202+patchThatChangesAndSortsMapWith :: (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
203+patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
204+ where newList = Map.toList newByIndexUnsorted
205+ newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
206+
207+-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
208+-- will produce the second 'Map'.
209+patchThatChangesMap :: (Ord k, Ord v) => Map k v -> Map k v -> PatchMapWithMove k v
210+patchThatChangesMap oldByIndex newByIndex = PatchMapWithMove' $
211+ PM.patchThatChangesMap oldByIndex newByIndex
212+
213+--
214+-- NodeInfo
215+--
216+
217+-- | Holds the information about each key: where its new value should come from,
218+-- and where its old value should go to
219+newtype NodeInfo k (v :: Type) = NodeInfo' { unNodeInfo' :: PM.NodeInfo k (Proxy v) }
220+
221+deriving instance (Show k, Show p) => Show (NodeInfo k p)
222+deriving instance (Read k, Read p) => Read (NodeInfo k p)
223+deriving instance (Eq k, Eq p) => Eq (NodeInfo k p)
224+deriving instance (Ord k, Ord p) => Ord (NodeInfo k p)
225+
226+{-# COMPLETE NodeInfo #-}
227+pattern NodeInfo :: To k -> From k v -> NodeInfo k v
228+_nodeInfo_to :: NodeInfo k v -> To k
229+_nodeInfo_from :: NodeInfo k v -> From k v
230+pattern NodeInfo { _nodeInfo_to, _nodeInfo_from } = NodeInfo'
231+ PM.NodeInfo
232+ { PM._nodeInfo_to = _nodeInfo_to
233+ , PM._nodeInfo_from = Coerce _nodeInfo_from
234+ }
235+
236+_NodeInfo
237+ :: Iso
238+ (NodeInfo k0 v0)
239+ (NodeInfo k1 v1)
240+ (PM.NodeInfo k0 (Proxy v0))
241+ (PM.NodeInfo k1 (Proxy v1))
242+_NodeInfo = iso unNodeInfo' NodeInfo'
243+
244+instance Functor (NodeInfo k) where
245+ fmap f = runIdentity . traverse (Identity . f)
246+
247+instance Foldable (NodeInfo k) where
248+ foldMap = foldMapDefault
249+
250+instance Traversable (NodeInfo k) where
251+ traverse = bitraverseNodeInfo pure
252+
253+bitraverseNodeInfo
254+ :: Applicative f
255+ => (k0 -> f k1)
256+ -> (v0 -> f v1)
257+ -> NodeInfo k0 v0 -> f (NodeInfo k1 v1)
258+bitraverseNodeInfo fk fv = fmap NodeInfo'
259+ . PM.bitraverseNodeInfo fk (\ ~Proxy -> pure Proxy) fv
260+ . coerce
261+
262+-- | Change the 'From' value of a 'NodeInfo'
263+nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
264+nodeInfoMapFrom f = coerce $ PM.nodeInfoMapFrom (unFrom' . f . From')
265+
266+-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
267+-- 'Applicative', 'Monad', etc.) action to get the new value
268+nodeInfoMapMFrom
269+ :: Functor f
270+ => (From k v -> f (From k v))
271+ -> NodeInfo k v -> f (NodeInfo k v)
272+nodeInfoMapMFrom f = fmap NodeInfo'
273+ . PM.nodeInfoMapMFrom (fmap unFrom' . f . From')
274+ . coerce
275+
276+-- | Set the 'To' field of a 'NodeInfo'
277+nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
278+nodeInfoSetTo = coerce . PM.nodeInfoSetTo
279+
280+--
281+-- From
282+--
283+
284+-- | Describe how a key's new value should be produced
285+newtype From k (v :: Type) = From' { unFrom' :: PM.From k (Proxy v) }
286+
287+{-# COMPLETE From_Insert, From_Delete, From_Move #-}
288+
289+-- | Insert the given value here
290+pattern From_Insert :: v -> From k v
291+pattern From_Insert v = From' (PM.From_Insert v)
292+
293+-- | Delete the existing value, if any, from here
294+pattern From_Delete :: From k v
295+pattern From_Delete = From' PM.From_Delete
296+
297+-- | Move the value here from the given key
298+pattern From_Move :: k -> From k v
299+pattern From_Move k = From' (PM.From_Move k Proxy)
300+
301+bitraverseFrom
302+ :: Applicative f
303+ => (k0 -> f k1)
304+ -> (v0 -> f v1)
305+ -> From k0 v0 -> f (From k1 v1)
306+bitraverseFrom fk fv = fmap From'
307+ . PM.bitraverseFrom fk (\ ~Proxy -> pure Proxy) fv
308+ . coerce
309+
310+makeWrapped ''PatchMapWithMove
311+makeWrapped ''NodeInfo
312+makeWrapped ''From
src/Data/Patch/MapWithPatchingMove.hsnew file+432
@@ -0,0 +1,432 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE StandaloneDeriving #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeFamilies #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+
14+-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
15+-- another
16+module Data.Patch.MapWithPatchingMove
17+ ( PatchMapWithPatchingMove (..)
18+ , patchMapWithPatchingMove
19+ , patchMapWithPatchingMoveInsertAll
20+ , insertMapKey
21+ , moveMapKey
22+ , swapMapKey
23+ , deleteMapKey
24+ , unsafePatchMapWithPatchingMove
25+ , patchMapWithPatchingMoveNewElements
26+ , patchMapWithPatchingMoveNewElementsMap
27+ , patchThatSortsMapWith
28+ , patchThatChangesAndSortsMapWith
29+ , patchThatChangesMap
30+
31+ -- * Node Info
32+ , NodeInfo (..)
33+ , bitraverseNodeInfo
34+ , nodeInfoMapFrom
35+ , nodeInfoMapMFrom
36+ , nodeInfoSetTo
37+
38+ -- * From
39+ , From(..)
40+ , bitraverseFrom
41+
42+ -- * To
43+ , To
44+
45+ -- TODO internals module
46+ , Fixup (..)
47+ ) where
48+
49+import Data.Patch.Class
50+
51+import Control.Lens hiding (from, to)
52+import Control.Lens.TH (makeWrapped)
53+import Data.Align (align)
54+import Data.Foldable (toList)
55+import Data.Function
56+import Data.List
57+import Data.Map (Map)
58+import qualified Data.Map as Map
59+import Data.Maybe
60+#if !MIN_VERSION_base(4,11,0)
61+import Data.Semigroup (Semigroup (..))
62+#endif
63+import Data.Monoid.DecidablyEmpty
64+import Data.Set (Set)
65+import qualified Data.Set as Set
66+import Data.These (These (..))
67+
68+-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
69+-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
70+-- and vice versa. There should never be any unpaired From/To keys.
71+newtype PatchMapWithPatchingMove k p = PatchMapWithPatchingMove
72+ { -- | Extract the internal representation of the 'PatchMapWithPatchingMove'
73+ unPatchMapWithPatchingMove :: Map k (NodeInfo k p)
74+ }
75+
76+deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (PatchMapWithPatchingMove k p)
77+deriving instance (Ord k, Read k, Read p, Read (PatchTarget p)) => Read (PatchMapWithPatchingMove k p)
78+deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (PatchMapWithPatchingMove k p)
79+deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (PatchMapWithPatchingMove k p)
80+
81+deriving instance ( Ord k
82+#if !MIN_VERSION_base(4,11,0)
83+ , Semigroup p
84+#endif
85+ , DecidablyEmpty p
86+ , Patch p
87+ ) => DecidablyEmpty (PatchMapWithPatchingMove k p)
88+
89+-- | Create a 'PatchMapWithPatchingMove', validating it
90+patchMapWithPatchingMove
91+ :: Ord k => Map k (NodeInfo k p) -> Maybe (PatchMapWithPatchingMove k p)
92+patchMapWithPatchingMove m = if valid then Just $ PatchMapWithPatchingMove m else Nothing
93+ where valid = forwardLinks == backwardLinks
94+ forwardLinks = Map.mapMaybe _nodeInfo_to m
95+ backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, p) ->
96+ case _nodeInfo_from p of
97+ From_Move from _ -> Just (from, to)
98+ _ -> Nothing
99+
100+-- | Create a 'PatchMapWithPatchingMove' that inserts everything in the given 'Map'
101+patchMapWithPatchingMoveInsertAll
102+ :: Map k (PatchTarget p) -> PatchMapWithPatchingMove k p
103+patchMapWithPatchingMoveInsertAll m = PatchMapWithPatchingMove $ flip fmap m $ \v -> NodeInfo
104+ { _nodeInfo_from = From_Insert v
105+ , _nodeInfo_to = Nothing
106+ }
107+
108+-- | Make a @'PatchMapWithPatchingMove' k p@ which has the effect of inserting or replacing a value @v@ at the given key @k@, like 'Map.insert'.
109+insertMapKey
110+ :: k -> PatchTarget p -> PatchMapWithPatchingMove k p
111+insertMapKey k v = PatchMapWithPatchingMove . Map.singleton k $ NodeInfo (From_Insert v) Nothing
112+
113+-- |Make a @'PatchMapWithPatchingMove' k p@ which has the effect of moving the value from the first key @k@ to the second key @k@, equivalent to:
114+--
115+-- @
116+-- 'Map.delete' src (maybe map ('Map.insert' dst) (Map.lookup src map))
117+-- @
118+moveMapKey
119+ :: ( DecidablyEmpty p
120+#if !MIN_VERSION_base(4,11,0)
121+ , Semigroup p
122+#endif
123+ , Patch p
124+ )
125+ => Ord k => k -> k -> PatchMapWithPatchingMove k p
126+moveMapKey src dst
127+ | src == dst = mempty
128+ | otherwise =
129+ PatchMapWithPatchingMove $ Map.fromList
130+ [ (dst, NodeInfo (From_Move src mempty) Nothing)
131+ , (src, NodeInfo From_Delete (Just dst))
132+ ]
133+
134+-- |Make a @'PatchMapWithPatchingMove' k p@ which has the effect of swapping two keys in the mapping, equivalent to:
135+--
136+-- @
137+-- let aMay = Map.lookup a map
138+-- bMay = Map.lookup b map
139+-- in maybe id (Map.insert a) (bMay <> aMay)
140+-- . maybe id (Map.insert b) (aMay <> bMay)
141+-- . Map.delete a . Map.delete b $ map
142+-- @
143+swapMapKey
144+ :: ( DecidablyEmpty p
145+#if !MIN_VERSION_base(4,11,0)
146+ , Semigroup p
147+#endif
148+ , Patch p
149+ )
150+ => Ord k => k -> k -> PatchMapWithPatchingMove k p
151+swapMapKey src dst
152+ | src == dst = mempty
153+ | otherwise =
154+ PatchMapWithPatchingMove $ Map.fromList
155+ [ (dst, NodeInfo (From_Move src mempty) (Just src))
156+ , (src, NodeInfo (From_Move dst mempty) (Just dst))
157+ ]
158+
159+-- | Make a @'PatchMapWithPatchingMove' k v@ which has the effect of deleting a key in
160+-- the mapping, equivalent to 'Map.delete'.
161+deleteMapKey
162+ :: k -> PatchMapWithPatchingMove k v
163+deleteMapKey k = PatchMapWithPatchingMove . Map.singleton k $ NodeInfo From_Delete Nothing
164+
165+-- | Wrap a @'Map' k (NodeInfo k v)@ representing patch changes into a @'PatchMapWithPatchingMove' k v@, without checking any invariants.
166+--
167+-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithPatchingMove' are preserved; they will not be checked.
168+unsafePatchMapWithPatchingMove
169+ :: Map k (NodeInfo k p) -> PatchMapWithPatchingMove k p
170+unsafePatchMapWithPatchingMove = PatchMapWithPatchingMove
171+
172+-- | Apply the insertions, deletions, and moves to a given 'Map'
173+instance (Ord k, Patch p) => Patch (PatchMapWithPatchingMove k p) where
174+ type PatchTarget (PatchMapWithPatchingMove k p) = Map k (PatchTarget p)
175+ -- TODO: return Nothing sometimes
176+ -- Note: the strict application here is critical to ensuring that incremental
177+ -- merges don't hold onto all their prerequisite events forever; can we make
178+ -- this more robust?
179+ apply (PatchMapWithPatchingMove m) old = Just $! insertions `Map.union` (old `Map.difference` deletions)
180+ where insertions = flip Map.mapMaybeWithKey m $ \_ ni -> case _nodeInfo_from ni of
181+ From_Insert v -> Just v
182+ From_Move k p -> applyAlways p <$> Map.lookup k old
183+ From_Delete -> Nothing
184+ deletions = flip Map.mapMaybeWithKey m $ \_ ni -> case _nodeInfo_from ni of
185+ From_Delete -> Just ()
186+ _ -> Nothing
187+
188+-- | Returns all the new elements that will be added to the 'Map'
189+patchMapWithPatchingMoveNewElements
190+ :: PatchMapWithPatchingMove k p -> [PatchTarget p]
191+patchMapWithPatchingMoveNewElements = Map.elems . patchMapWithPatchingMoveNewElementsMap
192+
193+-- | Return a @'Map' k v@ with all the inserts/updates from the given @'PatchMapWithPatchingMove' k v@.
194+patchMapWithPatchingMoveNewElementsMap
195+ :: PatchMapWithPatchingMove k p -> Map k (PatchTarget p)
196+patchMapWithPatchingMoveNewElementsMap (PatchMapWithPatchingMove p) = Map.mapMaybe f p
197+ where f ni = case _nodeInfo_from ni of
198+ From_Insert v -> Just v
199+ From_Move _ _ -> Nothing
200+ From_Delete -> Nothing
201+
202+-- | Create a 'PatchMapWithPatchingMove' that, if applied to the given 'Map', will sort
203+-- its values using the given ordering function. The set keys of the 'Map' is
204+-- not changed.
205+patchThatSortsMapWith
206+ :: (Ord k, Monoid p)
207+ => (PatchTarget p -> PatchTarget p -> Ordering)
208+ -> Map k (PatchTarget p) -> PatchMapWithPatchingMove k p
209+patchThatSortsMapWith cmp m = PatchMapWithPatchingMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
210+ where unsorted = Map.toList m
211+ sorted = sortBy (cmp `on` snd) unsorted
212+ f (to, _) (from, _) = if to == from then Nothing else
213+ Just (from, to)
214+ reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
215+ g (to, _) (from, _) = if to == from then Nothing else
216+ let Just movingTo = Map.lookup from reverseMapping
217+ in Just (to, NodeInfo (From_Move from mempty) $ Just movingTo)
218+
219+-- | Create a 'PatchMapWithPatchingMove' that, if applied to the first 'Map' provided,
220+-- will produce a 'Map' with the same values as the second 'Map' but with the
221+-- values sorted with the given ordering function.
222+patchThatChangesAndSortsMapWith
223+ :: forall k p. (Ord k, Ord (PatchTarget p), Monoid p)
224+ => (PatchTarget p -> PatchTarget p -> Ordering)
225+ -> Map k (PatchTarget p) -> Map k (PatchTarget p) -> PatchMapWithPatchingMove k p
226+patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
227+ where newList = Map.toList newByIndexUnsorted
228+ newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
229+
230+-- | Create a 'PatchMapWithPatchingMove' that, if applied to the first 'Map' provided,
231+-- will produce the second 'Map'.
232+-- Note: this will never produce a patch on a value.
233+patchThatChangesMap
234+ :: forall k p
235+ . (Ord k, Ord (PatchTarget p), Monoid p)
236+ => Map k (PatchTarget p) -> Map k (PatchTarget p) -> PatchMapWithPatchingMove k p
237+patchThatChangesMap oldByIndex newByIndex = patch
238+ where invert :: Map k (PatchTarget p) -> Map (PatchTarget p) (Set k)
239+ invert = Map.fromListWith (<>) . fmap (\(k, v) -> (v, Set.singleton k)) . Map.toList
240+ -- In the places where we use unionDistinct, a non-distinct key indicates a bug in this function
241+ unionDistinct :: forall k' v'. Ord k' => Map k' v' -> Map k' v' -> Map k' v'
242+ unionDistinct = Map.unionWith (error "patchThatChangesMap: non-distinct keys")
243+ unionPairDistinct :: (Map k (From k v), Map k (To k)) -> (Map k (From k v), Map k (To k)) -> (Map k (From k v), Map k (To k))
244+ unionPairDistinct (oldFroms, oldTos) (newFroms, newTos) = (unionDistinct oldFroms newFroms, unionDistinct oldTos newTos)
245+ -- Generate patch info for a single value
246+ -- Keys that are found in both the old and new sets will not be patched
247+ -- Keys that are found in only the old set will be moved to a new position if any are available; otherwise they will be deleted
248+ -- Keys that are found in only the new set will be populated by moving an old key if any are available; otherwise they will be inserted
249+ patchSingleValue :: PatchTarget p -> Set k -> Set k -> (Map k (From k p), Map k (To k))
250+ patchSingleValue v oldKeys newKeys = foldl' unionPairDistinct mempty $ align (toList $ oldKeys `Set.difference` newKeys) (toList $ newKeys `Set.difference` oldKeys) <&> \case
251+ This oldK -> (mempty, Map.singleton oldK Nothing) -- There's nowhere for this value to go, so we know we are deleting it
252+ That newK -> (Map.singleton newK $ From_Insert v, mempty) -- There's nowhere fo this value to come from, so we know we are inserting it
253+ These oldK newK -> (Map.singleton newK $ From_Move oldK mempty, Map.singleton oldK $ Just newK)
254+ -- Run patchSingleValue on a These. Missing old or new sets are considered empty
255+ patchSingleValueThese :: PatchTarget p -> These (Set k) (Set k) -> (Map k (From k p), Map k (To k))
256+ patchSingleValueThese v = \case
257+ This oldKeys -> patchSingleValue v oldKeys mempty
258+ That newKeys -> patchSingleValue v mempty newKeys
259+ These oldKeys newKeys -> patchSingleValue v oldKeys newKeys
260+ -- Generate froms and tos for all values, then merge them together
261+ (froms, tos) = foldl' unionPairDistinct mempty $ Map.mapWithKey patchSingleValueThese $ align (invert oldByIndex) (invert newByIndex)
262+ patch = unsafePatchMapWithPatchingMove $ align froms tos <&> \case
263+ This from -> NodeInfo from Nothing -- Since we don't have a 'to' record for this key, that must mean it isn't being moved anywhere, so it should be deleted.
264+ That to -> NodeInfo From_Delete to -- Since we don't have a 'from' record for this key, it must be getting deleted
265+ These from to -> NodeInfo from to
266+
267+--
268+-- NodeInfo
269+--
270+
271+-- | Holds the information about each key: where its new value should come from,
272+-- and where its old value should go to
273+data NodeInfo k p = NodeInfo
274+ { _nodeInfo_from :: !(From k p)
275+ -- ^ Where do we get the new value for this key?
276+ , _nodeInfo_to :: !(To k)
277+ -- ^ If the old value is being kept (i.e. moved rather than deleted or
278+ -- replaced), where is it going?
279+ }
280+deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (NodeInfo k p)
281+deriving instance (Read k, Read p, Read (PatchTarget p)) => Read (NodeInfo k p)
282+deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (NodeInfo k p)
283+deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (NodeInfo k p)
284+
285+-- | Traverse the 'NodeInfo' over the key, patch, and patch target. Because of
286+-- the type families here, this doesn't it any bi- or tri-traversal class.
287+bitraverseNodeInfo
288+ :: Applicative f
289+ => (k0 -> f k1)
290+ -> (p0 -> f p1)
291+ -> (PatchTarget p0 -> f (PatchTarget p1))
292+ -> NodeInfo k0 p0 -> f (NodeInfo k1 p1)
293+bitraverseNodeInfo fk fp fpt (NodeInfo from to) = NodeInfo
294+ <$> bitraverseFrom fk fp fpt from
295+ <*> traverse fk to
296+
297+-- | Change the 'From' value of a 'NodeInfo'
298+nodeInfoMapFrom
299+ :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
300+nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
301+
302+-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
303+-- 'Applicative', 'Monad', etc.) action to get the new value
304+nodeInfoMapMFrom
305+ :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
306+nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
307+
308+-- | Set the 'To' field of a 'NodeInfo'
309+nodeInfoSetTo
310+ :: To k -> NodeInfo k v -> NodeInfo k v
311+nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
312+
313+--
314+-- From
315+--
316+
317+-- | Describe how a key's new value should be produced
318+data From k p
319+ = From_Insert (PatchTarget p) -- ^ Insert the given value here
320+ | From_Delete -- ^ Delete the existing value, if any, from here
321+ | From_Move !k !p -- ^ Move the value here from the given key, and apply the given patch
322+
323+deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (From k p)
324+deriving instance (Read k, Read p, Read (PatchTarget p)) => Read (From k p)
325+deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (From k p)
326+deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (From k p)
327+
328+-- | Traverse the 'From' over the key, patch, and patch target. Because of
329+-- the type families here, this doesn't it any bi- or tri-traversal class.
330+bitraverseFrom
331+ :: Applicative f
332+ => (k0 -> f k1)
333+ -> (p0 -> f p1)
334+ -> (PatchTarget p0 -> f (PatchTarget p1))
335+ -> From k0 p0 -> f (From k1 p1)
336+bitraverseFrom fk fp fpt = \case
337+ From_Insert pt -> From_Insert <$> fpt pt
338+ From_Delete -> pure From_Delete
339+ From_Move k p -> From_Move <$> fk k <*> fp p
340+
341+--
342+-- To
343+--
344+
345+-- | Describe where a key's old value will go. If this is 'Just', that means
346+-- the key's old value will be moved to the given other key; if it is 'Nothing',
347+-- that means it will be deleted.
348+type To = Maybe
349+
350+--
351+-- Fixup
352+--
353+
354+-- | Helper data structure used for composing patches using the monoid instance.
355+data Fixup k v
356+ = Fixup_Delete
357+ | Fixup_Update (These (From k v) (To k))
358+
359+-- | Compose patches having the same effect as applying the patches in turn:
360+-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
361+instance ( Ord k
362+#if !MIN_VERSION_base(4,11,0)
363+ , Semigroup p
364+#endif
365+ , DecidablyEmpty p
366+ , Patch p
367+ ) => Semigroup (PatchMapWithPatchingMove k p) where
368+ PatchMapWithPatchingMove ma <> PatchMapWithPatchingMove mb = PatchMapWithPatchingMove m
369+ where
370+ connections = Map.toList $ Map.intersectionWithKey (\_ a b -> (_nodeInfo_to a, _nodeInfo_from b)) ma mb
371+ h :: (k, (Maybe k, From k p)) -> [(k, Fixup k p)]
372+ h (_, (mToAfter, editBefore)) = case (mToAfter, editBefore) of
373+ (Just toAfter, From_Move fromBefore p)
374+ | fromBefore == toAfter && isEmpty p
375+ -> [(toAfter, Fixup_Delete)]
376+ | otherwise
377+ -> [ (toAfter, Fixup_Update (This editBefore))
378+ , (fromBefore, Fixup_Update (That mToAfter))
379+ ]
380+ (Nothing, From_Move fromBefore _) -> [(fromBefore, Fixup_Update (That mToAfter))] -- The item is destroyed in the second patch, so indicate that it is destroyed in the source map
381+ (Just toAfter, _) -> [(toAfter, Fixup_Update (This editBefore))]
382+ (Nothing, _) -> []
383+ mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
384+ mergeFixups _ (Fixup_Update a) (Fixup_Update b)
385+ | This x <- a, That y <- b
386+ = Fixup_Update $ These x y
387+ | That y <- a, This x <- b
388+ = Fixup_Update $ These x y
389+ mergeFixups _ _ _ = error "PatchMapWithPatchingMove: incompatible fixups"
390+ fixups = Map.fromListWithKey mergeFixups $ concatMap h connections
391+ combineNodeInfos _ nia nib = NodeInfo
392+ { _nodeInfo_from = _nodeInfo_from nia
393+ , _nodeInfo_to = _nodeInfo_to nib
394+ }
395+ applyFixup _ ni = \case
396+ Fixup_Delete -> Nothing
397+ Fixup_Update u -> Just $ NodeInfo
398+ { _nodeInfo_from = case _nodeInfo_from ni of
399+ f@(From_Move _ p') -> case getHere u of -- The `from` fixup comes from the "old" patch
400+ Nothing -> f -- If there's no `from` fixup, just use the "new" `from`
401+ Just (From_Insert v) -> From_Insert $ applyAlways p' v
402+ Just From_Delete -> From_Delete
403+ Just (From_Move oldKey p) -> From_Move oldKey $ p' <> p
404+ _ -> error "PatchMapWithPatchingMove: fixup for non-move From"
405+ , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
406+ }
407+ m = Map.differenceWithKey applyFixup (Map.unionWithKey combineNodeInfos ma mb) fixups
408+ getHere :: These a b -> Maybe a
409+ getHere = \case
410+ This a -> Just a
411+ These a _ -> Just a
412+ That _ -> Nothing
413+ getThere :: These a b -> Maybe b
414+ getThere = \case
415+ This _ -> Nothing
416+ These _ b -> Just b
417+ That b -> Just b
418+
419+--TODO: Figure out how to implement this in terms of PatchDMapWithPatchingMove rather than duplicating it here
420+-- | Compose patches having the same effect as applying the patches in turn:
421+-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
422+instance ( Ord k
423+#if !MIN_VERSION_base(4,11,0)
424+ , Semigroup p
425+#endif
426+ , DecidablyEmpty p
427+ , Patch p
428+ ) => Monoid (PatchMapWithPatchingMove k p) where
429+ mempty = PatchMapWithPatchingMove mempty
430+ mappend = (<>)
431+
432+makeWrapped ''PatchMapWithPatchingMove
src/Data/Semigroup/Additive.hsnew file+54
@@ -0,0 +1,54 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE TypeOperators #-}
3+{-# LANGUAGE TypeFamilies #-}
4+-- |
5+-- Module:
6+-- Data.Semigroup.Additive
7+-- Description:
8+-- This module defines a class for commutative semigroups, until it is moved
9+-- to another library.
10+module Data.Semigroup.Additive
11+ ( Additive
12+ ) where
13+
14+import Data.Functor.Const (Const (..))
15+import Data.Functor.Identity
16+import Data.Proxy
17+#if !MIN_VERSION_base(4,12,0)
18+-- for :*: and :.: semigroup instances
19+import Data.Orphans ()
20+#endif
21+#if !MIN_VERSION_base(4,11,0)
22+import Data.Semigroup (Semigroup (..))
23+#endif
24+import GHC.Generics
25+
26+-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
27+class Semigroup q => Additive q where
28+
29+-- | Trivial additive semigroup.
30+instance Additive ()
31+
32+-- | Product additive semigroup.
33+-- A Pair of additive semigroups gives rise to a additive semigroup
34+instance (Additive a, Additive b) => Additive (a, b)
35+
36+-- See https://gitlab.haskell.org/ghc/ghc/issues/11135#note_111802 for the reason Compose is not also provided.
37+-- Base does not define Monoid (Compose f g a) so this is the best we can
38+-- really do for functor composition.
39+instance Additive (f (g a)) => Additive ((f :.: g) a)
40+
41+-- | Product of additive semigroups, Functor style.
42+instance (Additive (f a), Additive (g a)) => Additive ((f :*: g) a)
43+
44+-- | Trivial additive semigroup, Functor style
45+instance Additive (Proxy x)
46+
47+-- | Const lifts additive semigroups into a functor.
48+instance Additive a => Additive (Const a x)
49+
50+-- | Identity lifts additive semigroups pointwise (at only one point)
51+instance Additive a => Additive (Identity a)
52+
53+-- | Functions lift additive semigroups pointwise.
54+instance Additive b => Additive (a -> b)
src/Data/WeakBag.hsdeleted−118
@@ -1,118 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
4−-- | This module defines the 'WeakBag' type, which represents a mutable
5−-- collection of items that does not cause the items to be retained in memory.
6−-- This is useful for situations where a value needs to be inspected or modified
7−-- if it is still alive, but can be ignored if it is dead.
8−module Data.WeakBag
9− ( WeakBag
10− , WeakBagTicket
11− , empty
12− , singleton
13− , insert
14− , traverse
15− , remove
16− ) where
17−
18−import Control.Exception
19−import Control.Monad hiding (forM_, mapM_)
20−import Control.Monad.IO.Class
21−import Data.Foldable (forM_, mapM_)
22−import Data.IntMap.Strict (IntMap)
23−import qualified Data.IntMap.Strict as IntMap
24−import Data.IORef
25−import System.Mem.Weak
26−
27−import Prelude hiding (mapM_, traverse)
28−
29−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
30−-- that is, they can still be garbage-collected. As long as the @a@s remain
31−-- alive, the 'WeakBag' will continue to refer to them.
32−data WeakBag a = WeakBag
33− { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
34− , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a)))
35− }
36−
37−-- | When inserting an item into a 'WeakBag', a 'WeakBagTicket' is returned. If
38−-- the caller retains the ticket, the item is guranteed to stay in memory (and
39−-- thus in the 'WeakBag'). The ticket can also be used to remove the item from
40−-- the 'WeakBag' prematurely (i.e. while it is still alive), using 'remove'.
41−data WeakBagTicket = forall a. WeakBagTicket
42− { _weakBagTicket_weakItem :: {-# UNPACK #-} !(Weak a)
43− , _weakBagTicket_item :: {-# NOUNPACK #-} !a
44− }
45−
46−-- | Insert an item into a 'WeakBag'.
47−{-# INLINE insert #-}
48−insert :: a -- ^ The item
49− -> WeakBag a -- ^ The 'WeakBag' to insert into
50− -> IORef (Weak b) -- ^ An arbitrary value to be used in the following
51− -- callback
52− -> (b -> IO ()) -- ^ A callback to be invoked when the item is removed
53− -- (whether automatically by the item being garbage
54− -- collected or manually via 'remove')
55− -> IO WeakBagTicket -- ^ Returns a 'WeakBagTicket' that ensures the item
56− -- is retained and allows the item to be removed.
57−insert a (WeakBag nextId children) wbRef finalizer = {-# SCC "insert" #-} do
58− a' <- evaluate a
59− wbRef' <- evaluate wbRef
60− myId <- atomicModifyIORef' nextId $ \n -> (succ n, n)
61− let cleanup = do
62− wb <- readIORef wbRef'
63− mb <- deRefWeak wb
64− forM_ mb $ \b -> do
65− csWithoutMe <- atomicModifyIORef children $ \cs ->
66− let !csWithoutMe = IntMap.delete myId cs
67− in (csWithoutMe, csWithoutMe)
68− when (IntMap.null csWithoutMe) $ finalizer b
69− return ()
70− return ()
71− wa <- mkWeakPtr a' $ Just cleanup
72− atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
73− return $ WeakBagTicket
74− { _weakBagTicket_weakItem = wa
75− , _weakBagTicket_item = a'
76− }
77−
78−-- | Create an empty 'WeakBag'.
79−{-# INLINE empty #-}
80−empty :: IO (WeakBag a)
81−empty = {-# SCC "empty" #-} do
82− nextId <- newIORef 1
83− children <- newIORef IntMap.empty
84− let bag = WeakBag
85− { _weakBag_nextId = nextId
86− , _weakBag_children = children
87− }
88− return bag
89−
90−-- | Create a 'WeakBag' with one item; equivalent to creating the 'WeakBag' with
91−-- 'empty', then using 'insert'.
92−{-# INLINE singleton #-}
93−singleton :: a -> IORef (Weak b) -> (b -> IO ()) -> IO (WeakBag a, WeakBagTicket)
94−singleton a wbRef finalizer = {-# SCC "singleton" #-} do
95− bag <- empty
96− ticket <- insert a bag wbRef finalizer
97− return (bag, ticket)
98−
99−{-# INLINE traverse #-}
100−-- | Visit every node in the given list. If new nodes are appended during the
101−-- traversal, they will not be visited. Every live node that was in the list
102−-- when the traversal began will be visited exactly once; however, no guarantee
103−-- is made about the order of the traversal.
104−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
105−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
106− cs <- liftIO $ readIORef children
107− forM_ cs $ \c -> do
108− ma <- liftIO $ deRefWeak c
109− mapM_ f ma
110−
111−-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
112−-- on the same 'WeakBagTicket'.
113−{-# INLINE remove #-}
114−remove :: WeakBagTicket -> IO ()
115−remove (WeakBagTicket w _) = {-# SCC "remove" #-} finalize w
116−--TODO: Should 'remove' also drop the reference to the item?
117−
118−--TODO: can/should we provide a null WeakBagTicket?
src/Reflex.hsdeleted−12
@@ -1,12 +0,0 @@
1−-- | This module exports all of the commonly-used functionality of Reflex; if
2−-- you are just getting started with Reflex, this is probably what you want.
3−module Reflex (module X) where
4−
5−import Reflex.Class as X
6−import Reflex.Dynamic as X
7−import Reflex.Dynamic.TH as X
8−import Reflex.Dynamic.Uniq as X
9−import Reflex.DynamicWriter as X
10−import Reflex.PerformEvent.Class as X
11−import Reflex.PostBuild.Class as X
12−import Reflex.Spider as X
src/Reflex/Class.hsdeleted−894
@@ -1,894 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE NoMonomorphismRestriction #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE RecursiveDo #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE StandaloneDeriving #-}
14−{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
17−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
18−
19−-- | This module contains the Reflex interface, as well as a variety of
20−-- convenience functions for working with 'Event's, 'Behavior's, and other
21−-- signals.
22−module Reflex.Class
23− ( -- * Primitives
24− Reflex (..)
25− , coerceBehavior
26− , coerceEvent
27− , coerceDynamic
28− , MonadSample (..)
29− , MonadHold (..)
30− -- ** 'fan'-related types
31− , EventSelector (..)
32− -- ** 'Incremental'-related types
33− , Patch (..)
34− , PatchDMap (..)
35− , ComposeMaybe (..)
36− , PatchMap (..)
37− -- * Convenience functions
38− , constDyn
39− , pushAlways
40− -- ** Combining 'Event's
41− , leftmost
42− , mergeMap
43− , mergeList
44− , mergeWith
45− -- ** Breaking up 'Event's
46− , splitE
47− , fanEither
48− , fanThese
49− , fanMap
50− , dmapToThese
51− , EitherTag (..)
52− , eitherToDSum
53− , dsumToEither
54− -- ** Switching between 'Event's
55− , switchPromptly
56− -- ** Using 'Event's to sample 'Behavior's
57− , tag
58− , attach
59− , attachWith
60− , attachWithMaybe
61− -- ** Blocking an 'Event' based on a 'Behavior'
62− , gate
63− -- ** Combining 'Dynamic's
64− , distributeDMapOverDynPure
65− , distributeListOverDyn
66− , distributeListOverDynWith
67− , zipDyn
68− , zipDynWith
69− -- ** Accumulating state
70− , Accumulator (..)
71− , mapAccum_
72− , mapAccumM_
73− , mapAccumMaybe_
74− , mapAccumMaybeM_
75− , zipListWithEvent
76− , headE
77− , tailE
78− , headTailE
79− , switcher
80− -- * Debugging functions
81− , traceEvent
82− , traceEventWith
83− -- * Unsafe functions
84− , unsafeDynamic
85− -- * 'FunctorMaybe'
86− , FunctorMaybe (..)
87− , fforMaybe
88− , ffilter
89− -- * Miscellaneous convenience functions
90− , ffor
91− , MonadAdjust (..)
92− -- * Deprecated functions
93− , appendEvents
94− , onceE
95− , sequenceThese
96− ) where
97−
98−import Control.Applicative
99−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
100−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
101−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
102−import Control.Monad.Trans.Cont (ContT ())
103−import Control.Monad.Trans.Except (ExceptT ())
104−import Control.Monad.Trans.RWS (RWST ())
105−import Control.Monad.Trans.Writer (WriterT ())
106−import Data.Align
107−import Data.Bifunctor
108−import Data.Coerce
109−import Data.Dependent.Map (DMap, DSum (..), GCompare (..), GOrdering (..))
110−import qualified Data.Dependent.Map as DMap
111−import Data.Dependent.Sum (ShowTag (..))
112−import Data.Either
113−import Data.Foldable
114−import Data.Functor.Bind hiding (join)
115−import qualified Data.Functor.Bind as Bind
116−import Data.Functor.Constant
117−import Data.Functor.Misc
118−import Data.Functor.Plus
119−import Data.GADT.Compare ((:~:) (..), GEq (..))
120−import Data.GADT.Show (GShow (..))
121−import Data.List.NonEmpty (NonEmpty (..))
122−import Data.Map (Map)
123−import qualified Data.Map as Map
124−import Data.Maybe
125−import Data.Monoid hiding (Alt, (<>))
126−import Data.Semigroup (Semigroup, sconcat, stimes, stimesIdempotentMonoid, (<>))
127−import Data.String
128−import Data.These
129−import Data.Traversable
130−import Data.Type.Coercion
131−
132−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
133−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
134−
135−import Debug.Trace (trace)
136−
137−-- | The 'Reflex' class contains all the primitive functionality needed for
138−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
139−-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
140−-- and the type of the timeline determines the FRP engine to be used. For most
141−-- purposes, the 'Reflex.Spider' implementation is recommended.
142−class ( MonadHold t (PushM t)
143− , MonadSample t (PullM t)
144− , MonadFix (PushM t)
145− , Functor (Dynamic t)
146− , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
147− , Monad (Dynamic t)
148− ) => Reflex t where
149− -- | A container for a value that can change over time. 'Behavior's can be
150− -- sampled at will, but it is not possible to be notified when they change
151− data Behavior t :: * -> *
152− -- | A stream of occurrences. During any given frame, an 'Event' is either
153− -- occurring or not occurring; if it is occurring, it will contain a value of
154− -- the given type (its "occurrence type")
155− data Event t :: * -> *
156− -- | A container for a value that can change over time and allows
157− -- notifications on changes. Basically a combination of a 'Behavior' and an
158− -- 'Event', with a rule that the 'Behavior' will change if and only if the
159− -- 'Event' fires.
160− data Dynamic t :: * -> *
161− -- | A container for a value that can change over time and allows
162− -- notifications on changes. Basically a combination of a 'Behavior' and an
163− -- 'Event', with a rule that the 'Behavior' will change if and only if the
164− -- 'Event' fires.
165− data Incremental t :: * -> *
166− -- | An 'Event' with no occurrences
167− never :: Event t a
168− -- | Create a 'Behavior' that always has the given value
169− constant :: a -> Behavior t a --TODO: Refactor to use 'pure' from Applicative instead; however, we need to make sure that encouraging Applicative-style use of 'Behavior's doesn't have a negative performance impact
170− -- | Create an 'Event' from another 'Event'; the provided function can sample
171− -- 'Behavior's and hold 'Event's, and use the results to produce a occurring
172− -- (Just) or non-occurring (Nothing) result
173− push :: (a -> PushM t (Maybe b)) -> Event t a -> Event t b
174− -- | A monad for doing complex push-based calculations efficiently
175− type PushM t :: * -> *
176− -- | Create a 'Behavior' by reading from other 'Behavior's; the result will be
177− -- recomputed whenever any of the read 'Behavior's changes
178− pull :: PullM t a -> Behavior t a
179− -- | A monad for doing complex pull-based calculations efficiently
180− type PullM t :: * -> *
181− -- | Merge a collection of events; the resulting 'Event' will only occur if at
182− -- least one input event is occuring, and will contain all of the input keys
183− -- that are occurring simultaneously
184− 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
185− -- | Efficiently fan-out an event to many destinations. This function should
186− -- be partially applied, and then the result applied repeatedly to create
187− -- child events
188− 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
189− -- | Create an 'Event' that will occur whenever the currently-selected input
190− -- 'Event' occurs
191− switch :: Behavior t (Event t a) -> Event t a
192− -- | Create an 'Event' that will occur whenever the input event is occurring
193− -- and its occurrence value, another 'Event', is also occurring
194− coincidence :: Event t (Event t a) -> Event t a
195− -- | Extract the 'Behavior' of a 'Dynamic'.
196− current :: Dynamic t a -> Behavior t a
197− -- | Extract the 'Event' of the 'Dynamic'.
198− updated :: Dynamic t a -> Event t a
199− -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
200− -- recent firing of the given 'Event', if any.
201− unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
202− -- | Create a new 'Incremental'. The given 'PullM''s value must always change
203− -- in the same way that the accumulated application of patches would change
204− -- that value.
205− unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
206− -- | Create a merge whose parents can change over time
207− mergeIncremental :: GCompare k => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
208− -- | Extract the 'Behavior' component of an 'Incremental'
209− currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
210− -- | Extract the 'Event' component of an 'Incremental'
211− updatedIncremental :: Patch p => Incremental t p -> Event t p
212− -- | Convert an 'Incremental' to a 'Dynamic'
213− incrementalToDynamic :: Patch p => Incremental t p -> Dynamic t (PatchTarget p)
214− -- | Construct a 'Coercion' for a 'Behavior' given an 'Coercion' for its
215− -- occurrence type
216− behaviorCoercion :: Coercion a b -> Coercion (Behavior t a) (Behavior t b)
217− -- | Construct a 'Coercion' for an 'Event' given an 'Coercion' for its
218− -- occurrence type
219− eventCoercion :: Coercion a b -> Coercion (Event t a) (Event t b)
220− -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
221− -- occurrence type
222− dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
223−
224−-- | Coerce a 'Behavior' between representationally-equivalent value types
225−coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
226−coerceBehavior = coerceWith $ behaviorCoercion Coercion
227−
228−-- | Coerce an 'Event' between representationally-equivalent occurrence types
229−coerceEvent :: (Reflex t, Coercible a b) => Event t a -> Event t b
230−coerceEvent = coerceWith $ eventCoercion Coercion
231−
232−-- | Coerce a 'Dynamic' between representationally-equivalent value types
233−coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
234−coerceDynamic = coerceWith $ dynamicCoercion Coercion
235−
236−-- | A 'Patch' type represents a kind of change made to a datastructure.
237−class Patch p where
238− type PatchTarget p :: *
239− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
240− -- 'Nothing'.
241− apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
242−
243−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
244−-- make the 'f' parameter have a nominal type role. We need f to be
245−-- representational so that we can use safe 'coerce'.
246−newtype ComposeMaybe f a = ComposeMaybe { getComposeMaybe :: Maybe (f a) }
247−
248−deriving instance Functor f => Functor (ComposeMaybe f)
249−
250−instance Patch (Identity a) where
251− type PatchTarget (Identity a) = a
252− apply (Identity a) _ = Just a
253−
254−-- | A set of changes to a 'DMap'. Only DMap types are allowed for @a@.
255−newtype PatchDMap k v = PatchDMap (DMap k (ComposeMaybe v))
256−
257−instance GCompare k => Semigroup (PatchDMap k v) where
258− PatchDMap a <> PatchDMap b = PatchDMap $ a `mappend` b --TODO: Add a semigroup instance for DMap
259− -- PatchDMap is idempotent, so stimes n is id for every n
260−#if MIN_VERSION_semigroups(0,17,0)
261− stimes = stimesIdempotentMonoid
262−#else
263− times1p n x = case compare n 0 of
264− LT -> error "stimesIdempotentMonoid: negative multiplier"
265− EQ -> mempty
266− GT -> x
267−#endif
268−
269−instance GCompare k => Monoid (PatchDMap k v) where
270− mempty = PatchDMap mempty
271− mappend = (<>)
272−
273−instance GCompare k => Patch (PatchDMap k v) where
274− type PatchTarget (PatchDMap k v) = DMap k v
275− 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?
276− where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
277− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
278− nothingToJust = \case
279− Nothing -> Just $ Constant ()
280− Just _ -> Nothing
281−
282−newtype PatchMap k v = PatchMap (Map k (Maybe v))
283−
284−instance Ord k => Patch (PatchMap k v) where
285− type PatchTarget (PatchMap k v) = Map k v
286− 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?
287− where insertions = Map.mapMaybeWithKey (const id) p
288− deletions = Map.mapMaybeWithKey (const nothingToJust) p
289− nothingToJust = \case
290− Nothing -> Just ()
291− Just _ -> Nothing
292−
293−instance Ord k => Semigroup (PatchMap k v) where
294− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
295− -- PatchMap is idempotent, so stimes n is id for every n
296−#if MIN_VERSION_semigroups(0,17,0)
297− stimes = stimesIdempotentMonoid
298−#else
299− times1p n x = case compare n 0 of
300− LT -> error "stimesIdempotentMonoid: negative multiplier"
301− EQ -> mempty
302− GT -> x
303−#endif
304−
305−instance Ord k => Monoid (PatchMap k v) where
306− mempty = PatchMap mempty
307− mappend = (<>)
308−
309−-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
310−-- _must_ change when and only when the 'Event' fires, such that the
311−-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
312−-- if this is not the case, the resulting 'Dynamic' will behave
313−-- nondeterministically.
314−unsafeDynamic :: Reflex t => Behavior t a -> Event t a -> Dynamic t a
315−unsafeDynamic = unsafeBuildDynamic . sample
316−
317−-- | Construct a 'Dynamic' value that never changes
318−constDyn :: Reflex t => a -> Dynamic t a
319−constDyn = pure
320−
321−-- | 'MonadSample' designates monads that can read the current value of a
322−-- 'Behavior'. This includes both 'PullM' and 'PushM'.
323−class (Applicative m, Monad m) => MonadSample t m | m -> t where
324− -- | Get the current value in the 'Behavior'
325− sample :: Behavior t a -> m a
326−
327−-- | 'MonadHold' designates monads that can create new 'Behavior's based on
328−-- 'Event's; usually this will be 'PushM' or a monad based on it. 'MonadHold'
329−-- is required to create any stateful computations with Reflex.
330−class MonadSample t m => MonadHold t m where
331− -- | Create a new 'Behavior' whose value will initially be equal to the given
332− -- value and will be updated whenever the given 'Event' occurs. The update
333− -- takes effect immediately after the 'Event' occurs; if the occurrence that
334− -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
335− -- the 'Behavior', it will see the _old_ value of the 'Behavior', not the new
336− -- one.
337− hold :: a -> Event t a -> m (Behavior t a)
338− -- | Create a 'Dynamic' value using the given initial value that changes every
339− -- time the 'Event' occurs.
340− holdDyn :: a -> Event t a -> m (Dynamic t a)
341− -- | Create an 'Incremental' value using the given initial value that changes
342− -- every time the 'Event' occurs.
343− holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
344−
345−-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
346−-- key. This is much more efficient than filtering for each key with
347−-- 'fmapMaybe'.
348−newtype EventSelector t k = EventSelector
349− { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
350− -- determined by the type of the key, so this can be used to fan-out
351− -- 'Event's whose sub-'Event's have different types.
352− --
353− -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
354− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
355− -- occurrences of an 'Event'.
356− select :: forall a. k a -> Event t a
357− }
358−
359−--------------------------------------------------------------------------------
360−-- Instances
361−--------------------------------------------------------------------------------
362−
363−instance MonadSample t m => MonadSample t (ReaderT r m) where
364− sample = lift . sample
365−
366−instance MonadHold t m => MonadHold t (ReaderT r m) where
367− hold a0 = lift . hold a0
368− holdDyn a0 = lift . holdDyn a0
369− holdIncremental a0 = lift . holdIncremental a0
370−
371−instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
372− sample = lift . sample
373−
374−instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
375− hold a0 = lift . hold a0
376− holdDyn a0 = lift . holdDyn a0
377− holdIncremental a0 = lift . holdIncremental a0
378−
379−instance MonadSample t m => MonadSample t (StateT s m) where
380− sample = lift . sample
381−
382−instance MonadHold t m => MonadHold t (StateT s m) where
383− hold a0 = lift . hold a0
384− holdDyn a0 = lift . holdDyn a0
385− holdIncremental a0 = lift . holdIncremental a0
386−
387−instance MonadSample t m => MonadSample t (ExceptT e m) where
388− sample = lift . sample
389−
390−instance MonadHold t m => MonadHold t (ExceptT e m) where
391− hold a0 = lift . hold a0
392− holdDyn a0 = lift . holdDyn a0
393− holdIncremental a0 = lift . holdIncremental a0
394−
395−instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
396− sample = lift . sample
397−
398−instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
399− hold a0 = lift . hold a0
400− holdDyn a0 = lift . holdDyn a0
401− holdIncremental a0 = lift . holdIncremental a0
402−
403−instance MonadSample t m => MonadSample t (ContT r m) where
404− sample = lift . sample
405−
406−instance MonadHold t m => MonadHold t (ContT r m) where
407− hold a0 = lift . hold a0
408− holdDyn a0 = lift . holdDyn a0
409− holdIncremental a0 = lift . holdIncremental a0
410−
411−--------------------------------------------------------------------------------
412−-- Convenience functions
413−--------------------------------------------------------------------------------
414−
415−-- | Create an 'Event' from another 'Event'. The provided function can sample
416−-- 'Behavior's and hold 'Event's.
417−pushAlways :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
418−pushAlways f = push (fmap Just . f)
419−
420−-- | Flipped version of 'fmap'.
421−ffor :: Functor f => f a -> (a -> b) -> f b
422−ffor = flip fmap
423−
424−instance Reflex t => Applicative (Behavior t) where
425− pure = constant
426− f <*> x = pull $ sample f `ap` sample x
427− _ *> b = b
428− a <* _ = a
429−
430−instance Reflex t => Apply (Behavior t) where
431− (<.>) = (<*>)
432−
433−instance Reflex t => Bind (Behavior t) where
434− (>>-) = (>>=)
435−
436−instance (Reflex t, Fractional a) => Fractional (Behavior t a) where
437− (/) = liftA2 (/)
438− fromRational = pure . fromRational
439− recip = fmap recip
440−
441−instance Reflex t => Functor (Behavior t) where
442− fmap f = pull . fmap f . sample
443−
444−instance (Reflex t, IsString a) => IsString (Behavior t a) where
445− fromString = pure . fromString
446−
447−instance Reflex t => Monad (Behavior t) where
448− a >>= f = pull $ sample a >>= sample . f
449− -- 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.
450− return = constant
451− fail = error "Monad (Behavior t) does not support fail"
452−
453−instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
454− mempty = constant mempty
455− mappend a b = pull $ liftM2 mappend (sample a) (sample b)
456− mconcat = pull . fmap mconcat . mapM sample
457−
458−instance (Reflex t, Num a) => Num (Behavior t a) where
459− (+) = liftA2 (+)
460− (-) = liftA2 (-)
461− (*) = liftA2 (*)
462− abs = fmap abs
463− fromInteger = pure . fromInteger
464− negate = fmap negate
465− signum = fmap signum
466−
467−instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
468− a <> b = pull $ liftM2 (<>) (sample a) (sample b)
469− sconcat = pull . fmap sconcat . mapM sample
470−#if MIN_VERSION_semigroups(0,17,0)
471− stimes n = fmap $ stimes n
472−#else
473− times1p n = fmap $ times1p n
474−#endif
475−
476−--TODO: See if there's a better class in the standard libraries already
477−-- | A class for values that combines filtering and mapping using 'Maybe'.
478−class FunctorMaybe f where
479− -- | Combined mapping and filtering function.
480− fmapMaybe :: (a -> Maybe b) -> f a -> f b
481−
482−instance FunctorMaybe [] where
483− fmapMaybe f = catMaybes . fmap f
484−
485−-- | Flipped version of 'fmapMaybe'.
486−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
487−fforMaybe = flip fmapMaybe
488−
489−-- | Filter 'f a' using the provided predicate.
490−-- Relies on 'fforMaybe'.
491−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
492−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
493−
494−-- | Left-biased event union (prefers left event on simultaneous
495−-- occurrence).
496−instance Reflex t => Alt (Event t) where
497− ev1 <!> ev2 = leftmost [ev1, ev2]
498−
499−-- | 'Event' intersection (convenient interface to 'coincidence').
500−instance Reflex t => Apply (Event t) where
501− evf <.> evx = coincidence (fmap (<$> evx) evf)
502−
503−-- | 'Event' intersection (convenient interface to 'coincidence').
504−instance Reflex t => Bind (Event t) where
505− evx >>- f = coincidence (f <$> evx)
506− join = coincidence
507−
508−instance Reflex t => Functor (Event t) where
509− {-# INLINE fmap #-}
510− fmap f = fmapMaybe $ Just . f
511−
512−instance Reflex t => FunctorMaybe (Event t) where
513− {-# INLINE fmapMaybe #-}
514− fmapMaybe f = push $ return . f
515−
516−-- | Never: @'zero' = 'never'@.
517−instance Reflex t => Plus (Event t) where
518− zero = never
519−
520−-- | Replace each occurrence value of the 'Event' with the value of the
521−-- 'Behavior' at the time of that occurrence.
522−tag :: Reflex t => Behavior t b -> Event t a -> Event t b
523−tag b = pushAlways $ \_ -> sample b
524−
525−-- | Create a new 'Event' that combines occurences of supplied 'Event' with the
526−-- current value of the 'Behavior'.
527−attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
528−attach = attachWith (,)
529−
530−-- | Create a new 'Event' that occurs when the supplied 'Event' occurs by
531−-- combining it with the current value of the 'Behavior'.
532−attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
533−attachWith f = attachWithMaybe $ \a b -> Just $ f a b
534−
535−-- | Create a new 'Event' by combining each occurence with the current value of
536−-- the 'Behavior'. The occurrence is discarded if the combining function returns
537−-- Nothing
538−attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
539−attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
540−
541−-- | Create a new 'Event' that only occurs only once, on the first occurence of
542−-- the supplied 'Event'.
543−headE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
544−headE e = do
545− rec be <- hold e $ fmap (const never) e'
546− let e' = switch be
547− return e'
548−
549−-- | Create a new 'Event' that occurs on all but the first occurence of the
550−-- supplied 'Event'.
551−tailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
552−tailE e = snd <$> headTailE e
553−
554−-- | Create a tuple of two 'Event's with the first one occuring only the first
555−-- time the supplied 'Event' occurs and the second occuring on all but the first
556−-- occurence.
557−headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
558−headTailE e = do
559− eHead <- headE e
560− be <- hold never $ fmap (const e) eHead
561− return (eHead, switch be)
562−
563−-- | Split the supplied 'Event' into two individual 'Event's occuring at the
564−-- same time with the respective values from the tuple.
565−splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
566−splitE e = (fmap fst e, fmap snd e)
567−
568−-- | Print the supplied 'String' and the value of the 'Event' on each
569−-- occurence. This should /only/ be used for debugging.
570−--
571−-- Note: As with Debug.Trace.trace, the message will only be printed if the
572−-- 'Event' is actually used.
573−traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
574−traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
575−
576−-- | Print the output of the supplied function on each occurence of the
577−-- 'Event'. This should /only/ be used for debugging.
578−--
579−-- Note: As with Debug.Trace.trace, the message will only be printed if the
580−-- 'Event' is actually used.
581−traceEventWith :: Reflex t => (a -> String) -> Event t a -> Event t a
582−traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
583−
584−-- | Tag type for 'Either' to use it as a 'DSum'.
585−data EitherTag l r a where
586− LeftTag :: EitherTag l r l
587− RightTag :: EitherTag l r r
588−
589−instance GEq (EitherTag l r) where
590− geq a b = case (a, b) of
591− (LeftTag, LeftTag) -> Just Refl
592− (RightTag, RightTag) -> Just Refl
593− _ -> Nothing
594−
595−instance GCompare (EitherTag l r) where
596− gcompare a b = case (a, b) of
597− (LeftTag, LeftTag) -> GEQ
598− (LeftTag, RightTag) -> GLT
599− (RightTag, LeftTag) -> GGT
600− (RightTag, RightTag) -> GEQ
601−
602−instance GShow (EitherTag l r) where
603− gshowsPrec _ a = case a of
604− LeftTag -> showString "LeftTag"
605− RightTag -> showString "RightTag"
606−
607−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
608− showTaggedPrec t n (Identity a) = case t of
609− LeftTag -> showsPrec n a
610− RightTag -> showsPrec n a
611−
612−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
613−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
614−eitherToDSum = \case
615− Left a -> (LeftTag :=> Identity a)
616− Right b -> (RightTag :=> Identity b)
617−
618−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
619−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
620−dsumToEither = \case
621− (LeftTag :=> Identity a) -> Left a
622− (RightTag :=> Identity b) -> Right b
623−
624−-- | Extract the values of a 'DMap' of 'EitherTag's.
625−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
626−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
627− (Nothing, Nothing) -> Nothing
628− (Just (Identity a), Nothing) -> Just $ This a
629− (Nothing, Just (Identity b)) -> Just $ That b
630− (Just (Identity a), Just (Identity b)) -> Just $ These a b
631−
632−instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
633− (<>) = alignWith (mergeThese (<>))
634− sconcat = fmap sconcat . mergeList . toList
635−#if MIN_VERSION_semigroups(0,17,0)
636− stimes n = fmap $ stimes n
637−#else
638− times1p n = fmap $ times1p n
639−#endif
640−
641−instance (Semigroup a, Reflex t) => Monoid (Event t a) where
642− mempty = never
643− mappend = (<>)
644− mconcat = fmap sconcat . mergeList
645−
646−-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
647−-- list occurs. If multiple occur at the same time they are folded from the left
648−-- with the given function.
649−{-# INLINE mergeWith #-}
650−mergeWith :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
651−mergeWith f es = fmap (Prelude.foldl1 f . map (\(Const2 _ :=> Identity v) -> v) . DMap.toList)
652− . merge
653− . DMap.fromDistinctAscList
654− . map (\(k, v) -> Const2 k :=> v)
655− $ zip [0 :: Int ..] es
656−
657−-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
658−-- list occurs. If multiple occur at the same time the value is the value of the
659−-- leftmost event.
660−{-# INLINE leftmost #-}
661−leftmost :: Reflex t => [Event t a] -> Event t a
662−leftmost = mergeWith const
663−
664−-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
665−-- list occurs and has a list of the values of all 'Event's occuring at that
666−-- time.
667−mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
668−mergeList [] = never
669−mergeList es = mergeWith (<>) $ map (fmap (:|[])) es
670−
671−-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
672−-- occurs if at least one of them occurs and has a map of values of all 'Event's
673−-- occuring at that time.
674−mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
675−mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
676−
677−-- | Split the event into separate events for 'Left' and 'Right' values.
678−fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
679−fanEither e =
680− let justLeft = either Just (const Nothing)
681− justRight = either (const Nothing) Just
682− in (fmapMaybe justLeft e, fmapMaybe justRight e)
683−
684−-- | Split the event into separate events for 'This' and 'That' values,
685−-- allowing them to fire simultaneously when the input value is 'These'.
686−fanThese :: Reflex t => Event t (These a b) -> (Event t a, Event t b)
687−fanThese e =
688− let this (This x) = Just x
689− this (These x _) = Just x
690− this _ = Nothing
691− that (That y) = Just y
692− that (These _ y) = Just y
693− that _ = Nothing
694− in (fmapMaybe this e, fmapMaybe that e)
695−
696−-- | Split the event into an 'EventSelector' that allows efficient selection of
697−-- the individual 'Event's.
698−fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
699−fanMap = fan . fmap mapToDMap
700−
701−-- | Switches to the new event whenever it receives one; the new event is used
702−-- immediately, on the same frame that it is switched to
703−switchPromptly :: forall t m a. (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
704−switchPromptly ea0 eea = do
705− bea <- hold ea0 eea
706− let eLag = switch bea
707− eCoincidences = coincidence eea
708− return $ leftmost [eCoincidences, eLag]
709−
710−instance Reflex t => Align (Event t) where
711− nil = never
712− align ea eb = fmapMaybe dmapToThese $ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
713−
714−-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
715−-- the 'Behavior' is true at the time of occurence.
716−gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
717−gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
718−
719−-- | Create a new behavior given a starting behavior and switch to a the behvior
720−-- carried by the event when it fires.
721−switcher :: (Reflex t, MonadHold t m)
722− => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
723−switcher b eb = pull . (sample <=< sample) <$> hold b eb
724−
725−-- | Combine two 'Dynamic's. The result will change whenever either (or both)
726−-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
727−zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
728−zipDyn = zipDynWith (,)
729−
730−-- | Combine two 'Dynamic's with a combining function. The result will change
731−-- whenever either (or both) input 'Dynamic' changes.
732−zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
733−zipDynWith f da db =
734− let eab = align (updated da) (updated db)
735− ec = flip push eab $ \o -> do
736− (a, b) <- case o of
737− This a -> do
738− b <- sample $ current db
739− return (a, b)
740− That b -> do
741− a <- sample $ current da
742− return (a, b)
743− These a b -> return (a, b)
744− return $ Just $ f a b
745− in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
746−
747−instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
748− mconcat = distributeListOverDynWith mconcat
749− mempty = constDyn mempty
750− mappend = zipDynWith mappend
751−
752−-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
753−-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
754−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
755−distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
756−distributeDMapOverDynPure dm = case DMap.toList dm of
757− [] -> constDyn DMap.empty
758− [k :=> v] -> fmap (DMap.singleton k . Identity) v
759− _ ->
760− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
761− edmPre = merge $ DMap.map updated dm
762− result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
763− olds <- sample $ current result
764− return $ DMap.unionWithKey (\_ _ new -> new) olds news
765− in result
766−
767−-- | Convert a list of 'Dynamic's into a 'Dynamic' list.
768−distributeListOverDyn :: Reflex t => [Dynamic t a] -> Dynamic t [a]
769−distributeListOverDyn = distributeListOverDynWith id
770−
771−-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
772−distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
773−distributeListOverDynWith f = fmap (f . map (\(Const2 _ :=> Identity v) -> v) . DMap.toList) . distributeDMapOverDynPure . DMap.fromList . map (\(k, v) -> Const2 k :=> v) . zip [0 :: Int ..]
774−
775−
776−--------------------------------------------------------------------------------
777−-- Accumulator
778−--------------------------------------------------------------------------------
779−
780−-- | An 'Accumulator' type can be built by accumulating occurrences of an
781−-- 'Event'.
782−class Reflex t => Accumulator t f | f -> t where
783− accum :: (MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (f a)
784− accum f = accumMaybe $ \v o -> Just $ f v o
785− accumM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (f a)
786− accumM f = accumMaybeM $ \v o -> Just <$> f v o
787− accumMaybe :: (MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (f a)
788− accumMaybe f = accumMaybeM $ \v o -> return $ f v o
789− accumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (f a)
790− mapAccum :: (MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (f a, Event t c)
791− mapAccum f = mapAccumMaybe $ \v o -> bimap Just Just $ f v o
792− mapAccumM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (f a, Event t c)
793− mapAccumM f = mapAccumMaybeM $ \v o -> bimap Just Just <$> f v o
794− mapAccumMaybe :: (MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
795− mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
796− mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
797−
798−-- | Accumulate occurrences of an 'Event', producing an output occurrence each
799−-- time. Discard the underlying 'Accumulator'.
800−mapAccum_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Event t c)
801−mapAccum_ f z e = do
802− (_ :: Behavior t a, result) <- mapAccum f z e
803− return result
804−
805−-- | Accumulate occurrences of an 'Event', possibly producing an output
806−-- occurrence each time. Discard the underlying 'Accumulator'.
807−mapAccumMaybe_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
808−mapAccumMaybe_ f z e = do
809− (_ :: Behavior t a, result) <- mapAccumMaybe f z e
810− return result
811−
812−-- | Accumulate occurrences of an 'Event', using a 'PushM' action and producing
813−-- an output occurrence each time. Discard the underlying 'Accumulator'.
814−mapAccumM_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Event t c)
815−mapAccumM_ f z e = do
816− (_ :: Behavior t a, result) <- mapAccumM f z e
817− return result
818−
819−-- | Accumulate occurrences of an 'Event', using a 'PushM' action and possibly
820−-- producing an output occurrence each time. Discard the underlying
821−-- 'Accumulator'.
822−mapAccumMaybeM_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
823−mapAccumMaybeM_ f z e = do
824− (_ :: Behavior t a, result) <- mapAccumMaybeM f z e
825− return result
826−
827−instance Reflex t => Accumulator t (Dynamic t) where
828− accumMaybeM f z e = do
829− rec let e' = flip push e $ \o -> do
830− v <- sample $ current d'
831− f v o
832− d' <- holdDyn z e'
833− return d'
834− mapAccumMaybeM f z e = do
835− rec let e' = flip push e $ \o -> do
836− v <- sample $ current d'
837− result <- f v o
838− return $ case result of
839− (Nothing, Nothing) -> Nothing
840− _ -> Just result
841− d' <- holdDyn z $ fmapMaybe fst e'
842− return (d', fmapMaybe snd e')
843−
844−instance Reflex t => Accumulator t (Behavior t) where
845− accumMaybeM f z e = current <$> accumMaybeM f z e
846− mapAccumMaybeM f z e = first current <$> mapAccumMaybeM f z e
847−
848−instance Reflex t => Accumulator t (Event t) where
849− accumMaybeM f z e = updated <$> accumMaybeM f z e
850− mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
851−
852−-- | Create a new 'Event' by combining each occurence with the next value of the
853−-- list using the supplied function. If the list runs out of items, all
854−-- subsequent 'Event' occurrences will be ignored.
855−zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
856−zipListWithEvent f l e = do
857− let f' a b = case a of
858− h:t -> (Just t, Just $ f h b)
859− _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
860− mapAccumMaybe_ f' l e
861−
862−class (Reflex t, Monad m) => MonadAdjust t m | m -> t where
863− sequenceDMapWithAdjust :: GCompare k => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
864−
865−instance (Reflex t, MonadAdjust t m) => MonadAdjust t (ReaderT r m) where
866− sequenceDMapWithAdjust dm0 dm' = do
867− r <- ask
868− let loweredDm0 = DMap.map (`runReaderT` r) dm0
869− loweredDm' = ffor dm' $ \(PatchDMap p) -> PatchDMap $
870− DMap.map (\(ComposeMaybe mv) -> ComposeMaybe $ fmap (`runReaderT` r) mv) p
871− lift $ sequenceDMapWithAdjust loweredDm0 loweredDm'
872−
873−--------------------------------------------------------------------------------
874−-- Deprecated functions
875−--------------------------------------------------------------------------------
876−
877−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
878−-- occurs. If both occur at the same time they are combined using 'mappend'.
879−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
880−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
881−appendEvents = alignWith $ mergeThese mappend
882−
883−-- | Alias for 'headE'
884−{-# DEPRECATED onceE "Use 'headE' instead" #-}
885−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
886−onceE = headE
887−
888−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
889−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
890−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
891−sequenceThese t = case t of
892− This ma -> liftM This ma
893− These ma mb -> liftM2 These ma mb
894− That mb -> liftM That mb
src/Reflex/Dynamic.hsdeleted−562
@@ -1,562 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE NoMonomorphismRestriction #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
16−-- | This module contains various functions for working with 'Dynamic' values.
17−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
18−module Reflex.Dynamic
19− ( -- * Basics
20− Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
21− , current
22− , updated
23− , holdDyn
24− , constDyn
25− , uniqDyn
26− , uniqDynBy
27− , count
28− , toggle
29− , switchPromptlyDyn
30− , tagPromptlyDyn
31− , attachPromptlyDyn
32− , attachPromptlyDynWith
33− , attachPromptlyDynWithMaybe
34− , foldDyn
35− , foldDynM
36− , foldDynMaybe
37− , foldDynMaybeM
38− , joinDynThroughMap
39− , traceDyn
40− , traceDynWith
41− , splitDynPure
42− , distributeDMapOverDynPure
43− , Demux
44− , demux
45− , demuxed
46− -- Things that probably aren't very useful:
47− , HList (..)
48− , FHList (..)
49− , collectDynPure
50− , distributeFHListOverDynPure
51− -- Unsafe
52− , unsafeDynamic
53− -- * Deprecated functions
54− , apDyn
55− , attachDyn
56− , attachDynWith
57− , attachDynWithMaybe
58− , collectDyn
59− , combineDyn
60− , distributeDMapOverDyn
61− , distributeFHListOverDyn
62− , forDyn
63− , forDynM
64− , getDemuxed
65− , joinDyn
66− , mapDyn
67− , mapDynM
68− , mconcatDyn
69− , nubDyn
70− , splitDyn
71− , tagDyn
72− ) where
73−
74−import Prelude hiding (mapM, mapM_)
75−
76−import Data.Functor.Misc
77−import Reflex.Class
78−
79−import Control.Applicative ((<*>))
80−import Control.Monad hiding (forM, forM_, mapM, mapM_)
81−import Control.Monad.Fix
82−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
83−import Data.Align
84−import Data.Dependent.Map (DMap)
85−import qualified Data.Dependent.Map as DMap
86−import Data.Dependent.Sum (DSum (..))
87−import Data.GADT.Compare ((:~:) (..), GCompare (..), GEq (..), GOrdering (..))
88−import Data.Map (Map)
89−import Data.Monoid
90−import Data.These
91−
92−import Debug.Trace
93−
94−-- | Create a new 'Dynamic' that only signals changes if the values actually
95−-- changed.
96−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
97−uniqDyn = uniqDynBy (==)
98−
99−-- | Create a new 'Dynamic' that changes only when the underlying 'Dynamic'
100−-- changes and the given function returns 'False' when given both the old and
101−-- the new values.
102−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
103−uniqDynBy eq d =
104− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
105− in unsafeDynamic (current d) e'
106−
107−-- | Create a 'Dynamic' using the initial value and change it each time the
108−-- 'Event' occurs using a folding function on the previous value and the value
109−-- of the 'Event'.
110−foldDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> b) -> b -> Event t a -> m (Dynamic t b)
111−foldDyn = accum . flip
112−
113−-- | Like 'foldDyn', but the combining function is a 'PushM' action, so it
114−-- can 'sample' existing 'Behaviors' and 'hold' new ones.
115−foldDynM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t b) -> b -> Event t a -> m (Dynamic t b)
116−foldDynM = accumM . flip
117−
118−-- | Create a 'Dynamic' using the provided initial value and change it each time
119−-- the provided 'Event' occurs, using a function to combine the old value with
120−-- the 'Event''s value. If the function returns 'Nothing', the value is not
121−-- changed; this is distinct from returning 'Just' the old value, since the
122−-- 'Dynamic''s 'updated' 'Event' will fire in the 'Just' case, and will not fire
123−-- in the 'Nothing' case.
124−foldDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe b) -> b -> Event t a -> m (Dynamic t b)
125−foldDynMaybe = accumMaybe . flip
126−
127−-- | Like 'foldDynMaybe', but the combining function is a 'PushM' action, so it
128−-- can 'sample' existing 'Behaviors' and 'hold' new ones.
129−foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
130−foldDynMaybeM = accumMaybeM . flip
131−
132−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
133−count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
134−count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
135−
136−-- | Create a new 'Dynamic' using the initial value that flips its
137−-- value every time the 'Event' occurs.
138−toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
139−toggle = foldDyn (const not)
140−
141−-- | Switches to the new 'Event' whenever it receives one. Switching occurs
142−-- *before* the inner 'Event' fires - so if the 'Dynamic' changes and both the
143−-- old and new inner Events fire simultaneously, the output will fire with the
144−-- value of the *new* 'Event'.
145−switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
146−switchPromptlyDyn de =
147− let eLag = switch $ current de
148− eCoincidences = coincidence $ updated de
149− in leftmost [eCoincidences, eLag]
150−
151−-- | Split a 'Dynamic' pair into a pair of 'Dynamic's
152−splitDynPure :: Reflex t => Dynamic t (a, b) -> (Dynamic t a, Dynamic t b)
153−splitDynPure d = (fmap fst d, fmap snd d)
154−
155−-- | Create a 'Dynamic' with a 'DMap' of values out of a 'DMap' of 'Dynamic'
156−-- values. The resulting 'Dynamic' will change whenever one of the input
157−-- 'Dynamic's changes.
158−--
159−-- This function's implementation is more efficient than simply using
160−-- 'zipDynWith' or applicative syntax to achieve the same result, especially for
161−-- maps with many elements.
162−distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
163−distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
164−
165−--TODO: Generalize this to functors other than Maps
166−-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
167−-- with the current values of the 'Dynamic's in a map.
168−joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
169−joinDynThroughMap = joinDyn . fmap distributeMapOverDynPure
170−
171−-- | Print the value of the 'Dynamic' on each change and prefix it
172−-- with the provided string. This should /only/ be used for debugging.
173−--
174−-- Note: Just like Debug.Trace.trace, the value will only be shown if something
175−-- else in the system is depending on it.
176−traceDyn :: (Reflex t, Show a) => String -> Dynamic t a -> Dynamic t a
177−traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
178−
179−-- | Print the result of applying the provided function to the value
180−-- of the 'Dynamic' on each change. This should /only/ be used for
181−-- debugging.
182−--
183−-- Note: Just like Debug.Trace.trace, the value will only be shown if something
184−-- else in the system is depending on it.
185−traceDynWith :: Reflex t => (a -> String) -> Dynamic t a -> Dynamic t a
186−traceDynWith f d =
187− let e' = traceEventWith f $ updated d
188− getV0 = do
189− x <- sample $ current d
190− trace (f x) $ return x
191− in unsafeBuildDynamic getV0 e'
192−
193−-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
194−-- each time the 'Event' occurs.
195−--
196−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
197−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
198−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
199−-- will be used, since the 'Behavior' won't be updated until the end of the frame.
200−-- Additionally, this means that the output 'Event' may not be used to directly change
201−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
202−-- cyclic data flows, generally `tag (current d) e` is preferred.
203−tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
204−tagPromptlyDyn = attachPromptlyDynWith const
205−
206−-- | Attach the current value of the 'Dynamic' to the value of the
207−-- 'Event' each time it occurs.
208−--
209−-- Note: `attachPromptlyDyn d` is not the same as `attach (current d)`. See 'tagPromptlyDyn' for details.
210−attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
211−attachPromptlyDyn = attachPromptlyDynWith (,)
212−
213−-- | Combine the current value of the 'Dynamic' with the value of the
214−-- 'Event' each time it occurs.
215−--
216−-- Note: `attachPromptlyDynWith f d` is not the same as `attachWith f (current d)`. See 'tagPromptlyDyn' for details.
217−attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
218−attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
219−
220−-- | Create a new 'Event' by combining the value at each occurence with the
221−-- current value of the 'Dynamic' value and possibly filtering if the combining
222−-- function returns 'Nothing'.
223−--
224−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
225−-- (current d)`. See 'tagPromptlyDyn' for details.
226−attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
227−attachPromptlyDynWithMaybe f d e =
228− let e' = attach (current d) e
229− in fforMaybe (align e' $ updated d) $ \case
230− This (a, b) -> f a b -- Only the tagging event is firing, so use that
231− These (_, b) a -> f a b -- Both events are firing, so use the newer value
232− That _ -> Nothing -- The tagging event isn't firing, so don't fire
233−
234−--------------------------------------------------------------------------------
235−-- Demux
236−--------------------------------------------------------------------------------
237−
238−-- | Represents a time changing value together with an 'EventSelector' that can
239−-- efficiently detect when the underlying 'Dynamic' has a particular value.
240−-- This is useful for representing data like the current selection of a long
241−-- list.
242−--
243−-- Semantically,
244−--
245−-- > demuxed (demux d) k === fmap (== k) d
246−--
247−-- However, the when getDemuxed is used multiple times, the complexity is only
248−-- /O(log(n))/, rather than /O(n)/ for fmap.
249−data Demux t k = Demux { demuxValue :: Behavior t k
250− , demuxSelector :: EventSelector t (Const2 k Bool)
251− }
252−
253−-- | Demultiplex an input value to a 'Demux' with many outputs. At any given
254−-- time, whichever output is indicated by the given 'Dynamic' will be 'True'.
255−demux :: (Reflex t, Ord k) => Dynamic t k -> Demux t k
256−demux k = Demux (current k)
257− (fan $ attachWith (\k0 k1 -> if k0 == k1
258− then DMap.empty
259− else DMap.fromList [Const2 k0 :=> Identity False,
260− Const2 k1 :=> Identity True])
261− (current k) (updated k))
262−
263−-- | Select a particular output of the 'Demux'; this is equivalent to (but much
264−-- faster than) mapping over the original 'Dynamic' and checking whether it is
265−-- equal to the given key.
266−demuxed :: (Reflex t, Eq k) => Demux t k -> k -> Dynamic t Bool
267−demuxed d k =
268− let e = select (demuxSelector d) (Const2 k)
269− in unsafeBuildDynamic (fmap (==k) $ sample $ demuxValue d) e
270−
271−--------------------------------------------------------------------------------
272−-- collectDyn
273−--------------------------------------------------------------------------------
274−
275−--TODO: This whole section is badly in need of cleanup
276−
277−-- | A heterogeneous list whose type and length are fixed statically. This is
278−-- reproduced from the 'HList' package due to integration issues, and because
279−-- very little other functionality from that library is needed.
280−data HList (l::[*]) where
281− HNil :: HList '[]
282− HCons :: e -> HList l -> HList (e ': l)
283−
284−infixr 2 `HCons`
285−
286−type family HRevApp (l1 :: [k]) (l2 :: [k]) :: [k]
287−type instance HRevApp '[] l = l
288−type instance HRevApp (e ': l) l' = HRevApp l (e ': l')
289−
290−hRevApp :: HList l1 -> HList l2 -> HList (HRevApp l1 l2)
291−hRevApp HNil l = l
292−hRevApp (HCons x l) l' = hRevApp l (HCons x l')
293−
294−hReverse :: HList l -> HList (HRevApp l '[])
295−hReverse l = hRevApp l HNil
296−
297−hBuild :: (HBuild' '[] r) => r
298−hBuild = hBuild' HNil
299−
300−class HBuild' l r where
301− hBuild' :: HList l -> r
302−
303−instance (l' ~ HRevApp l '[])
304− => HBuild' l (HList l') where
305− hBuild' = hReverse
306−
307−instance HBuild' (a ': l) r
308− => HBuild' l (a->r) where
309− hBuild' l x = hBuild' (HCons x l)
310−
311−-- | Like 'HList', but with a functor wrapping each element.
312−data FHList f l where
313− FHNil :: FHList f '[]
314− FHCons :: f e -> FHList f l -> FHList f (e ': l)
315−
316−instance GEq (HListPtr l) where
317− HHeadPtr `geq` HHeadPtr = Just Refl
318− HHeadPtr `geq` HTailPtr _ = Nothing
319− HTailPtr _ `geq` HHeadPtr = Nothing
320− HTailPtr a `geq` HTailPtr b = a `geq` b
321−
322−instance GCompare (HListPtr l) where -- Warning: This ordering can't change, dmapTo*HList will break
323− HHeadPtr `gcompare` HHeadPtr = GEQ
324− HHeadPtr `gcompare` HTailPtr _ = GLT
325− HTailPtr _ `gcompare` HHeadPtr = GGT
326− HTailPtr a `gcompare` HTailPtr b = a `gcompare` b
327−
328−data HListPtr l a where
329− HHeadPtr :: HListPtr (h ': t) h
330− HTailPtr :: HListPtr t a -> HListPtr (h ': t) a
331−
332−fhlistToDMap :: forall (f :: * -> *) l. FHList f l -> DMap (HListPtr l) f
333−fhlistToDMap = DMap.fromList . go
334− where go :: forall l'. FHList f l' -> [DSum (HListPtr l') f]
335− go = \case
336− FHNil -> []
337− FHCons h t -> (HHeadPtr :=> h) : map (\(p :=> v) -> HTailPtr p :=> v) (go t)
338−
339−class RebuildSortedHList l where
340− rebuildSortedFHList :: [DSum (HListPtr l) f] -> FHList f l
341− rebuildSortedHList :: [DSum (HListPtr l) Identity] -> HList l
342−
343−instance RebuildSortedHList '[] where
344− rebuildSortedFHList l = case l of
345− [] -> FHNil
346− _ : _ -> error "rebuildSortedFHList{'[]}: empty list expected"
347− rebuildSortedHList l = case l of
348− [] -> HNil
349− _ : _ -> error "rebuildSortedHList{'[]}: empty list expected"
350−
351−instance RebuildSortedHList t => RebuildSortedHList (h ': t) where
352− rebuildSortedFHList l = case l of
353− ((HHeadPtr :=> h) : t) -> FHCons h . rebuildSortedFHList . map (\(HTailPtr p :=> v) -> p :=> v) $ t
354− _ -> error "rebuildSortedFHList{h':t}: non-empty list with HHeadPtr expected"
355− rebuildSortedHList l = case l of
356− ((HHeadPtr :=> Identity h) : t) -> HCons h . rebuildSortedHList . map (\(HTailPtr p :=> v) -> p :=> v) $ t
357− _ -> error "rebuildSortedHList{h':t}: non-empty list with HHeadPtr expected"
358−
359−dmapToHList :: forall l. RebuildSortedHList l => DMap (HListPtr l) Identity -> HList l
360−dmapToHList = rebuildSortedHList . DMap.toList
361−
362−-- | Collect a hetereogeneous list whose elements are all 'Dynamic's into a
363−-- single 'Dynamic' whose value represents the current values of all of the
364−-- input 'Dynamic's.
365−distributeFHListOverDynPure :: (Reflex t, RebuildSortedHList l) => FHList (Dynamic t) l -> Dynamic t (HList l)
366−distributeFHListOverDynPure l = fmap dmapToHList $ distributeDMapOverDynPure $ fhlistToDMap l
367−
368−class AllAreFunctors (f :: a -> *) (l :: [a]) where
369− type FunctorList f l :: [*]
370− toFHList :: HList (FunctorList f l) -> FHList f l
371− fromFHList :: FHList f l -> HList (FunctorList f l)
372−
373−instance AllAreFunctors f '[] where
374− type FunctorList f '[] = '[]
375− toFHList l = case l of
376− HNil -> FHNil
377−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
378− _ -> error "toFHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
379−#endif
380− fromFHList FHNil = HNil
381−
382−instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
383− type FunctorList f (h ': t) = f h ': FunctorList f t
384− toFHList l = case l of
385− a `HCons` b -> a `FHCons` toFHList b
386−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
387− _ -> error "toFHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
388−#endif
389− fromFHList (a `FHCons` b) = a `HCons` fromFHList b
390−
391−-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
392−-- single 'Dynamic' whose value represents all the current values of the input's
393−-- consitutent 'Dynamic's.
394−collectDynPure :: ( RebuildSortedHList (HListElems b)
395− , IsHList a, IsHList b
396− , AllAreFunctors (Dynamic t) (HListElems b)
397− , Reflex t
398− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
399− ) => a -> Dynamic t b
400−collectDynPure ds = fmap fromHList $ distributeFHListOverDynPure $ toFHList $ toHList ds
401−
402−-- Poor man's Generic
403−class IsHList a where
404− type HListElems a :: [*]
405− toHList :: a -> HList (HListElems a)
406− fromHList :: HList (HListElems a) -> a
407−
408−instance IsHList (a, b) where
409− type HListElems (a, b) = [a, b]
410− toHList (a, b) = hBuild a b
411− fromHList l = case l of
412− a `HCons` b `HCons` HNil -> (a, b)
413−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
414− _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
415−#endif
416−
417−instance IsHList (a, b, c, d) where
418− type HListElems (a, b, c, d) = [a, b, c, d]
419− toHList (a, b, c, d) = hBuild a b c d
420− fromHList l = case l of
421− a `HCons` b `HCons` c `HCons` d `HCons` HNil -> (a, b, c, d)
422−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
423− _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
424−#endif
425−
426−instance IsHList (a, b, c, d, e, f) where
427− type HListElems (a, b, c, d, e, f) = [a, b, c, d, e, f]
428− toHList (a, b, c, d, e, f) = hBuild a b c d e f
429− fromHList l = case l of
430− a `HCons` b `HCons` c `HCons` d `HCons` e `HCons` f `HCons` HNil -> (a, b, c, d, e, f)
431−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
432− _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
433−#endif
434−
435−--------------------------------------------------------------------------------
436−-- Deprecated functions
437−--------------------------------------------------------------------------------
438−
439−-- | Map a function over a 'Dynamic'.
440−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
441−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
442−mapDyn f = return . fmap f
443−
444−-- | 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.
445−{-# DEPRECATED mapDynM "Consider using the Monad instance for Dynamic instead." #-}
446−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)
447−mapDynM f d = do
448− let e' = push (fmap Just . f :: a -> PushM t (Maybe b)) $ updated d
449− eb' = fmap constant e'
450− v0 = pull $ f =<< sample (current d)
451− bb' :: Behavior t (Behavior t b) <- hold v0 eb'
452− let b' = pull $ sample =<< sample bb'
453− return $ unsafeDynamic b' e'
454−
455−-- | Flipped version of 'mapDyn'.
456−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
457−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
458−forDyn a = return . ffor a
459−
460−-- | Flipped version of 'mapDynM'
461−{-# DEPRECATED forDynM "Consider using the Monad instance for Dynamic instead." #-}
462−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)
463−forDynM d f = mapDynM f d
464−
465−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
466−-- of the tuple.
467−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
468−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
469−splitDyn = return . splitDynPure
470−
471−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
472−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
473−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
474−mconcatDyn = return . mconcat
475−
476−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
477−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
478−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
479−distributeDMapOverDyn = return . distributeDMapOverDynPure
480−
481−-- | Merge two 'Dynamic's into a new one using the provided function. The new
482−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
483−-- its value.
484−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
485−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
486−combineDyn f a b = return $ zipDynWith f a b
487−
488−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
489−--
490−-- > do
491−-- > person <- Person `mapDyn` dynFirstName
492−-- > `apDyn` dynListName
493−-- > `apDyn` dynAge
494−-- > `apDyn` dynAddress
495−{-# 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" #-}
496−{-# ANN apDyn "HLint: ignore Use fmap" #-}
497−apDyn :: forall t m a b. (Reflex t, Monad m)
498− => m (Dynamic t (a -> b))
499− -> Dynamic t a
500− -> m (Dynamic t b)
501−apDyn m a = liftM (<*> a) m
502−
503−--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
504−-- | This function no longer needs to be monadic, so it has been replaced by
505−-- 'demuxed', which is pure.
506−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
507−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
508−getDemuxed d = return . demuxed d
509−
510−-- | This function no longer needs to be monadic, so it has been replaced by
511−-- 'distributeFHListOverDynPure', which is pure.
512−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
513−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
514−distributeFHListOverDyn = return . distributeFHListOverDynPure
515−
516−-- | This function no longer needs to be monadic, so it has been replaced by
517−-- 'collectDynPure', which is pure.
518−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
519−collectDyn :: ( RebuildSortedHList (HListElems b)
520− , IsHList a, IsHList b
521− , AllAreFunctors (Dynamic t) (HListElems b)
522− , Reflex t, Monad m
523− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
524− ) => a -> m (Dynamic t b)
525−collectDyn = return . collectDynPure
526−
527−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
528−-- semantics.
529−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
530−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
531−tagDyn = tagPromptlyDyn
532−
533−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
534−-- semantics.
535−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
536−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
537−attachDyn = attachPromptlyDyn
538−
539−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
540−-- semantics.
541−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
542−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
543−attachDynWith = attachPromptlyDynWith
544−
545−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
546−-- its semantics.
547−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
548−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
549−attachDynWithMaybe = attachPromptlyDynWithMaybe
550−
551−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
552−-- current value will always be equal to the current value's current value, and
553−-- will change whenever either the inner or the outer (or both) values change.
554−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
555−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
556−joinDyn = join
557−
558−-- | 'nubDyn''s behavior is not quite analogous to 'nub''s behavior, so it has
559−-- been renamed to 'uniqDyn'
560−{-# DEPRECATED nubDyn "Use 'uniqDyn' instead" #-}
561−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
562−nubDyn = uniqDyn
src/Reflex/Dynamic/TH.hsdeleted−89
@@ -1,89 +0,0 @@
1−{-# LANGUAGE EmptyDataDecls #-}
2−{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE PatternGuards #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE TemplateHaskell #-}
6−{-# LANGUAGE TypeOperators #-}
7−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
8−-- | Template Haskell helper functions for building complex 'Dynamic' values.
9−module Reflex.Dynamic.TH (qDyn, unqDyn, mkDyn) where
10−
11−import Reflex.Dynamic
12−
13−import Control.Monad.State
14−import Data.Data
15−import Data.Generics
16−import Data.Monoid
17−import qualified Language.Haskell.Exts as Hs
18−import qualified Language.Haskell.Meta.Syntax.Translate as Hs
19−import Language.Haskell.TH
20−import Language.Haskell.TH.Quote
21−import qualified Language.Haskell.TH.Syntax as TH
22−
23−-- | Quote a 'Dynamic' expression. Within the quoted expression, you can use
24−-- @$(unqDyn [| x |])@ to refer to any expression @x@ of type @Dynamic t a@; the
25−-- unquoted result will be of type @a@
26−qDyn :: Q Exp -> Q Exp
27−qDyn qe = do
28− e <- qe
29− let f :: forall d. Data d => d -> StateT [(Name, Exp)] Q d
30− f d = case eqT of
31− Just (Refl :: d :~: Exp)
32− | AppE (VarE m) eInner <- d
33− , m == 'unqMarker
34− -> do n <- lift $ newName "dynamicQuotedExpressionVariable"
35− modify ((n, eInner):)
36− return $ VarE n
37− _ -> gmapM f d
38− (e', exprsReversed) <- runStateT (gmapM f e) []
39− let exprs = reverse exprsReversed
40− arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
41− param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
42− [| return $ $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
43−
44−-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
45−-- 'qDyn' quotation.
46−unqDyn :: Q Exp -> Q Exp
47−unqDyn e = [| unqMarker $e |]
48−
49−-- | This type represents an occurrence of unqDyn before it has been processed
50−-- by qDyn. If you see it in a type error, it probably means that unqDyn has
51−-- been used outside of a qDyn context.
52−data UnqDyn
53−
54−-- unqMarker must not be exported; it is used only as a way of smuggling data
55−-- from unqDyn to qDyn
56−
57−--TODO: It would be much nicer if the TH AST was extensible to support this kind of thing without trickery
58−unqMarker :: a -> UnqDyn
59−unqMarker = error "An unqDyn expression was used outside of a qDyn expression"
60−
61−-- | Create a 'Dynamic' value using other 'Dynamic's as inputs. The result is
62−-- sometimes more concise and readable than the equivalent 'Applicative'-based
63−-- expression. For example:
64−--
65−-- > [mkDyn| $x + $v * $t + 1/2 * $a * $t ^ 2 |]
66−--
67−-- would have a very cumbersome 'Applicative' encoding.
68−mkDyn :: QuasiQuoter
69−mkDyn = QuasiQuoter
70− { quoteExp = mkDynExp
71− , quotePat = error "mkDyn: pattern splices are not supported"
72− , quoteType = error "mkDyn: type splices are not supported"
73− , quoteDec = error "mkDyn: declaration splices are not supported"
74− }
75−
76−mkDynExp :: String -> Q Exp
77−mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] }) s of
78− Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
79− Hs.ParseOk e -> qDyn $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
80− where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
81− antiE x = case x of
82− Hs.SpliceExp se ->
83− Hs.App (Hs.Var $ Hs.Qual (Hs.ModuleName modName) (Hs.Ident occName)) $ case se of
84− Hs.IdSplice v -> Hs.Var $ Hs.UnQual $ Hs.Ident v
85− Hs.ParenSplice ps -> ps
86− _ -> x
87− reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
88− | modName == modName' && occName == occName' = 'unqMarker
89− reinstateUnqDyn x = x
src/Reflex/Dynamic/Uniq.hsdeleted−102
@@ -1,102 +0,0 @@
1−{-# LANGUAGE FlexibleInstances #-}
2−{-# LANGUAGE MagicHash #-}
3−{-# LANGUAGE MultiParamTypeClasses #-}
4−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
5−-- | This module provides a variation of 'Dynamic' values that uses cheap
6−-- pointer equality checks to reduce the amount of signal propagation needed.
7−module Reflex.Dynamic.Uniq
8− ( UniqDynamic
9− , uniqDynamic
10− , fromUniqDynamic
11− , alreadyUniqDynamic
12− ) where
13−
14−import Control.Applicative (Applicative (..))
15−import GHC.Exts
16−import Reflex.Class
17−import Reflex.Dynamic
18−
19−-- | A 'Dynamic' whose 'updated' 'Event' will never fire with the same value as
20−-- the 'current' 'Behavior''s contents. In order to maintain this constraint,
21−-- the value inside a 'UniqDynamic' is always evaluated to
22−-- <https://wiki.haskell.org/Weak_head_normal_form weak head normal form>.
23−--
24−-- Internally, 'UniqDynamic' uses pointer equality as a heuristic to avoid
25−-- unnecessary update propagation; this is much more efficient than performing
26−-- full comparisons. However, when the 'UniqDynamic' is converted back into a
27−-- regular 'Dynamic', a full comparison is performed.
28−newtype UniqDynamic t a = UniqDynamic { unUniqDynamic :: Dynamic t a }
29−
30−-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
31−uniqDynamic :: Reflex t => Dynamic t a -> UniqDynamic t a
32−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
33− old <- sample $ current d --TODO: Is it better to sample ourselves here?
34− return $ unsafeJustChanged old new
35−
36−-- | Retrieve a normal 'Dynamic' from a 'UniqDynamic'. This will perform a
37−-- final check using the output type's 'Eq' instance to ensure deterministic
38−-- behavior.
39−--
40−-- WARNING: If used with a type whose 'Eq' instance is not law-abiding -
41−-- specifically, if there are cases where @x /= x@, 'fromUniqDynamic' may
42−-- eliminate more 'updated' occurrences than it should. For example, NaN values
43−-- of 'Double' and 'Float' are considered unequal to themselves by the 'Eq'
44−-- instance, but can be equal by pointer equality. This may cause 'UniqDynamic'
45−-- to lose changes from NaN to NaN.
46−fromUniqDynamic :: (Reflex t, Eq a) => UniqDynamic t a -> Dynamic t a
47−fromUniqDynamic (UniqDynamic d) = uniqDynBy superEq d
48− where
49− -- Only consider values different if they fail both pointer equality /and/
50− -- 'Eq' equality. This is to make things a bit more deterministic in the
51− -- case of unlawful 'Eq' instances. However, it is still possible to
52− -- achieve nondeterminism by constructing elements that are identical in
53− -- value, unequal according to 'Eq', and nondeterministically equal or
54− -- nonequal by pointer quality. I suspect that it is impossible to make the
55− -- behavior deterministic in this case.
56− superEq a b = a `unsafePtrEq` b || a == b
57−
58−-- | Create a UniqDynamic without uniqing it on creation. This will be slightly
59−-- faster than uniqDynamic when used with a Dynamic whose values are always (or
60−-- nearly always) different from its previous values; if used with a Dynamic
61−-- whose values do not change frequently, it may be much slower than uniqDynamic
62−alreadyUniqDynamic :: Dynamic t a -> UniqDynamic t a
63−alreadyUniqDynamic = UniqDynamic
64−
65−unsafePtrEq :: a -> a -> Bool
66−unsafePtrEq a b = case a `seq` b `seq` reallyUnsafePtrEquality# a b of
67− 0# -> False
68− _ -> True
69−
70−unsafeJustChanged :: a -> a -> Maybe a
71−unsafeJustChanged old new =
72− if old `unsafePtrEq` new
73− then Nothing
74− else Just new
75−
76−instance Reflex t => Accumulator t (UniqDynamic t) where
77− accumMaybeM f z e = do
78− let f' old change = do
79− mNew <- f old change
80− return $ unsafeJustChanged old =<< mNew
81− d <- accumMaybeM f' z e
82− return $ UniqDynamic d
83− mapAccumMaybeM f z e = do
84− let f' old change = do
85− (mNew, output) <- f old change
86− return (unsafeJustChanged old =<< mNew, output)
87− (d, out) <- mapAccumMaybeM f' z e
88− return (UniqDynamic d, out)
89−
90−instance Reflex t => Functor (UniqDynamic t) where
91− fmap f (UniqDynamic d) = uniqDynamic $ fmap f d
92−
93−instance Reflex t => Applicative (UniqDynamic t) where
94− pure = UniqDynamic . constDyn
95− UniqDynamic a <*> UniqDynamic b = uniqDynamic $ a <*> b
96− _ *> b = b
97− a <* _ = a
98−
99−instance Reflex t => Monad (UniqDynamic t) where
100− UniqDynamic x >>= f = uniqDynamic $ x >>= unUniqDynamic . f
101− _ >> b = b
102− return = pure
src/Reflex/DynamicWriter.hsdeleted−194
@@ -1,194 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE FlexibleInstances #-}
3−{-# LANGUAGE FunctionalDependencies #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE RecursiveDo #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE UndecidableInstances #-}
12−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
13−module Reflex.DynamicWriter where
14−
15−import Control.Monad.Exception
16−import Control.Monad.Identity
17−import Control.Monad.IO.Class
18−import Control.Monad.Reader
19−import Control.Monad.Ref
20−import Control.Monad.State.Strict
21−import Data.Dependent.Map (DMap, DSum (..))
22−import qualified Data.Dependent.Map as DMap
23−import Data.Functor.Misc
24−import Data.Map (Map)
25−import qualified Data.Map as Map
26−import Data.Semigroup
27−import Data.Some (Some)
28−import qualified Data.Some as Some
29−import Reflex.Class
30−import Reflex.Dynamic
31−import Reflex.PerformEvent.Class
32−import Reflex.PostBuild.Class
33−import Reflex.Host.Class
34−
35−instance MonadTrans (DynamicWriterT t w) where
36− lift = DynamicWriterT . lift
37−
38−mconcatIncremental :: (Reflex t, MonadHold t m, MonadFix m, Monoid v, Ord k) => Map k v -> Event t (PatchMap k v) -> m (Dynamic t v)
39−mconcatIncremental m0 e = do
40− d <- foldDynMaybe apply m0 e
41− return $ fmap (mconcat . Map.elems) d
42−
43−mapIncrementalMapValuesWithKey :: (Reflex t, Ord k) => (k -> v -> v') -> Incremental t (PatchMap k v) -> Incremental t (PatchMap k v')
44−mapIncrementalMapValuesWithKey f = unsafeMapIncremental (Map.mapWithKey f) $ \(PatchMap m) -> PatchMap $ Map.mapWithKey (\k mv -> fmap (f k) mv) m
45−
46−mapIncrementalMapValues :: (Reflex t, Ord k) => (v -> v') -> Incremental t (PatchMap k v) -> Incremental t (PatchMap k v')
47−mapIncrementalMapValues f = mapIncrementalMapValuesWithKey $ const f
48−
49−unsafeMapIncremental :: (Reflex t, Patch p, Patch p') => (PatchTarget p -> PatchTarget p') -> (p -> p') -> Incremental t p -> Incremental t p'
50−unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
51−
52−incrementalExtractFunctorDMap :: (Reflex t, Ord k) => Incremental t (PatchMap k (f v)) -> Incremental t (PatchDMap (Const2 k v) f)
53−incrementalExtractFunctorDMap = unsafeMapIncremental mapWithFunctorToDMap $ \(PatchMap m) -> PatchDMap $ mapWithFunctorToDMap $ fmap ComposeMaybe m
54−
55−mergeIncrementalMap :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t v)) -> Event t (Map k v)
56−mergeIncrementalMap = fmap dmapToMap . mergeIncremental . incrementalExtractFunctorDMap
57−
58−holdIncrementalReplaceableMap :: forall t k v m. (MonadFix m, MonadHold t m, Reflex t, Ord k) => Map k (Replaceable t v) -> Event t (PatchMap k (Replaceable t v)) -> m (Incremental t (PatchMap k v))
59−holdIncrementalReplaceableMap m0 m' = do
60− rec vals <- holdIncremental m0 $ m' <> valChanges
61− let valChanges = fmap PatchMap $ mergeIncrementalMap $ mapIncrementalMapValues _replaceable_modify vals
62− return $ mapIncrementalMapValues _replaceable_value vals
63−
64−mergeDynIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Dynamic t v)) -> Incremental t (PatchMap k v)
65−mergeDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
66− where changedValues = fmap (PatchMap . fmap Just) $ mergeIncrementalMap $ mapIncrementalMapValues updated a
67− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchMap m) -> PatchMap <$> mapM (mapM (sample . current)) m
68−
69−data Replaceable t w = Replaceable
70− { _replaceable_value :: w
71− , _replaceable_modify :: Event t (Maybe (Replaceable t w)) -- "Please delete" is represented with an event of Nothing; all subsequent events will be ignored
72− }
73−
74−type DynamicWriterAccumulator t w = [Dynamic t w]
75−
76−newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT (DynamicWriterAccumulator t w) m a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadHold t, MonadSample t, MonadAsyncException, MonadException) -- The list is kept in reverse order
77−
78−instance MonadRef m => MonadRef (DynamicWriterT t w m) where
79− type Ref (DynamicWriterT t w m) = Ref m
80− newRef = lift . newRef
81− readRef = lift . readRef
82− writeRef r = lift . writeRef r
83−
84−instance MonadAtomicRef m => MonadAtomicRef (DynamicWriterT t w m) where
85− atomicModifyRef r = lift . atomicModifyRef r
86−
87−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DynamicWriterT t w m) where
88− newEventWithTrigger = lift . newEventWithTrigger
89− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
90−
91−runDynamicWriterTInternal :: DynamicWriterT t w m a -> m (a, DynamicWriterAccumulator t w)
92−runDynamicWriterTInternal (DynamicWriterT a) = runStateT a []
93−
94−mconcatIncrementalReplaceableDynMap :: forall m t k v.
95− (MonadFix m, MonadHold t m, Reflex t, Monoid v, Ord k)
96− => Map k (Replaceable t (Dynamic t v))
97− -> Event t (PatchMap k (Replaceable t (Dynamic t v)))
98− -> Event t ()
99− -> m (Replaceable t (Dynamic t v))
100−mconcatIncrementalReplaceableDynMap m0 m' additionsCeased = do
101− rec vals <- holdIncremental m0 $ m' <> valChanges
102− let valChanges = fmap PatchMap $ mergeIncrementalMap $ mapIncrementalMapValues _replaceable_modify vals
103− let i = mapIncrementalMapValues _replaceable_value vals
104− noMoreAdditions <- holdDyn False $ True <$ additionsCeased
105− let replaceSelf nma x = do
106− guard nma
107− case Map.toList x of
108− [] -> return Nothing -- Delete self
109− [(_, n)] -> return $ Just n --TODO: What if this one is also replacing itself simultaneously?
110− _ -> mzero
111− result = fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeDynIncremental i
112− return $ Replaceable result $ fmapMaybe id $ updated $ zipDynWith replaceSelf noMoreAdditions $ incrementalToDynamic vals
113−
114−runDynamicWriterT :: (MonadFix m, Reflex t, Monoid w) => DynamicWriterT t w m a -> m (a, Dynamic t w)
115−runDynamicWriterT (DynamicWriterT a) = do
116− (result, ws) <- runStateT a []
117− return (result, mconcat $ reverse ws)
118−
119−class Monad m => MonadDynamicWriter t w m | m -> t w where
120− tellDyn :: Dynamic t w -> m ()
121−
122−instance (Monad m, Reflex t) => MonadDynamicWriter t w (DynamicWriterT t w m) where
123− tellDyn w = DynamicWriterT $ modify (w :)
124−
125−instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
126− ask = lift ask
127− local f (DynamicWriterT a) = DynamicWriterT $ mapStateT (local f) a
128− reader = lift . reader
129−
130−liftDynamicWriterTThroughSync :: Monad m' => (m (a, DynamicWriterAccumulator t w) -> m' (b, (a, DynamicWriterAccumulator t w))) -> DynamicWriterT t w m a -> DynamicWriterT t w m' (b, a)
131−liftDynamicWriterTThroughSync f (DynamicWriterT child) = DynamicWriterT $ do
132− s <- get
133− (b, (a, newS)) <- lift $ f $ runStateT child s
134− put newS
135− return (b, a)
136−
137−instance PerformEvent t m => PerformEvent t (DynamicWriterT t w m) where
138− type Performable (DynamicWriterT t w m) = Performable m
139− performEvent_ = lift . performEvent_
140− performEvent = lift . performEvent
141−
142−instance TriggerEvent t m => TriggerEvent t (DynamicWriterT t w m) where
143− newTriggerEvent = lift newTriggerEvent
144− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
145− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
146−
147−instance PostBuild t m => PostBuild t (DynamicWriterT t w m) where
148− getPostBuild = lift getPostBuild
149−
150−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (ReaderT r m) where
151− tellDyn = lift . tellDyn
152−
153−instance MonadState s m => MonadState s (DynamicWriterT t w m) where
154− get = lift get
155− put = lift . put
156−
157−newtype DynamicWriterTLoweredResult t w v = DynamicWriterTLoweredResult { unDynamicWriterTLoweredResult :: (v, Dynamic t w) }
158−
159−instance (MonadAdjust t m, MonadFix m, Monoid w, MonadHold t m, Reflex t) => MonadAdjust t (DynamicWriterT t w m) where
160− sequenceDMapWithAdjust (dm0 :: DMap k (DynamicWriterT t w m)) dm' = do
161− let loweredDm0 = mapKeyValuePairsMonotonic (\(k :=> v) -> WrapArg k :=> fmap DynamicWriterTLoweredResult (runDynamicWriterT v)) dm0
162− let loweredDm' = ffor dm' $ \(PatchDMap p) -> PatchDMap $
163− mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mv) -> WrapArg k :=> ComposeMaybe (fmap (fmap DynamicWriterTLoweredResult . runDynamicWriterT) mv)) p
164− (result0, result') <- lift $ sequenceDMapWithAdjust loweredDm0 loweredDm'
165− let getValue (DynamicWriterTLoweredResult (v, _)) = v
166− getWritten (DynamicWriterTLoweredResult (_, w)) = w
167− liftedResult0 = mapKeyValuePairsMonotonic (\(WrapArg k :=> Identity r) -> k :=> Identity (getValue r)) result0
168− liftedResult' = ffor result' $ \(PatchDMap p) -> PatchDMap $
169− mapKeyValuePairsMonotonic (\(WrapArg k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (Identity . getValue . runIdentity) mr)) p
170− liftedWritten0 :: Map (Some k) (Dynamic t w)
171− liftedWritten0 = Map.fromDistinctAscList $ fmap (\(WrapArg k :=> Identity r) -> (Some.This k, getWritten r)) $ DMap.toList result0
172− liftedWritten' = ffor result' $ \(PatchDMap p) -> PatchMap $
173− Map.fromDistinctAscList $ fmap (\(WrapArg k :=> ComposeMaybe mr) -> (Some.This k, fmap (getWritten . runIdentity) mr)) $ DMap.toList p
174− --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
175− i <- holdIncremental liftedWritten0 liftedWritten'
176− tellDyn $ fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeDynIncremental i
177− return (liftedResult0, liftedResult')
178−
179−withDynamicWriterT :: (Monoid w, Reflex t, MonadHold t m, MonadFix m)
180− => (w -> w')
181− -> DynamicWriterT t w m a
182− -> DynamicWriterT t w' m a
183−withDynamicWriterT f dw = do
184− (r, d) <- lift $ do
185− (r, d) <- runDynamicWriterT dw
186− let d' = fmap f d
187− return (r, d')
188− tellDyn d
189− return r
190−
191−instance MonadRequest t m => MonadRequest t (DynamicWriterT t w m) where
192− type Request (DynamicWriterT t w m) = Request m
193− type Response (DynamicWriterT t w m) = Response m
194− withRequesting f = DynamicWriterT $ withRequesting $ unDynamicWriterT . f
src/Reflex/Host/Class.hsdeleted−283
@@ -1,283 +0,0 @@
1−{-# LANGUAGE ExistentialQuantification #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE RoleAnnotations #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE UndecidableInstances #-}
12−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
13−-- | This module provides the interface for hosting 'Reflex' engines. This
14−-- should only be necessary if you're writing a binding or some other library
15−-- that provides a core event loop.
16−module Reflex.Host.Class
17− ( ReflexHost (..)
18− , MonadSubscribeEvent (..)
19− , MonadReadEvent (..)
20− , MonadReflexCreateTrigger (..)
21− , MonadReflexHost (..)
22− , fireEvents
23− , newEventWithTriggerRef
24− , fireEventRef
25− , fireEventRefAndRead
26− ) where
27−
28−import Reflex.Class
29−
30−import Control.Applicative
31−import Control.Monad
32−import Control.Monad.Fix
33−import Control.Monad.Identity
34−import Control.Monad.Ref
35−import Control.Monad.Trans
36−import Control.Monad.Trans.Cont (ContT ())
37−import Control.Monad.Trans.Except (ExceptT ())
38−import Control.Monad.Trans.Reader (ReaderT ())
39−import Control.Monad.Trans.RWS (RWST ())
40−import Control.Monad.Trans.State (StateT ())
41−import qualified Control.Monad.Trans.State.Strict as Strict
42−import Control.Monad.Trans.Writer (WriterT ())
43−import Data.Dependent.Sum (DSum (..))
44−import Data.GADT.Compare
45−import Data.Monoid
46−
47−-- Note: this import must come last to silence warnings from AMP
48−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
49−
50−-- | Framework implementation support class for the reflex implementation
51−-- represented by @t@.
52−class ( Reflex t
53− , MonadReflexCreateTrigger t (HostFrame t)
54− , MonadSample t (HostFrame t)
55− , MonadHold t (HostFrame t)
56− , MonadFix (HostFrame t)
57− , MonadSubscribeEvent t (HostFrame t)
58− ) => ReflexHost t where
59− type EventTrigger t :: * -> *
60− type EventHandle t :: * -> *
61− type HostFrame t :: * -> *
62−
63−-- | Monad in which Events can be 'subscribed'. This forces all underlying
64−-- event sources to be initialized, so that the event will fire whenever it
65−-- ought to. Events must be subscribed before they are read using readEvent
66−class (Reflex t, Monad m) => MonadSubscribeEvent t m | m -> t where
67− -- | Subscribe to an event and set it up if needed.
68− --
69− -- This function will create a new 'EventHandle' from an 'Event'. This handle
70− -- may then be used via 'readEvent' in the read callback of
71− -- 'fireEventsAndRead'.
72− --
73− -- If the event wasn't subscribed to before (either manually or through a
74− -- dependent event or behavior) then this function will cause the event and
75− -- all dependencies of this event to be set up. For example, if the event was
76− -- created by 'newEventWithTrigger', then it's callback will be executed.
77− --
78− -- It's safe to call this function multiple times.
79− subscribeEvent :: Event t a -> m (EventHandle t a)
80−
81−-- | Monad that allows to read events' values.
82−class (ReflexHost t, Applicative m, Monad m) => MonadReadEvent t m | m -> t where
83− -- | Read the value of an 'Event' from an 'EventHandle' (created by calling
84− -- 'subscribeEvent').
85− --
86− -- After event propagation is done, all events can be in two states: either
87− -- they are firing with some value or they are not firing. In the former
88− -- case, this function returns @Just act@, where @act@ in an action to read
89− -- the current value of the event. In the latter case, the function returns
90− -- @Nothing@.
91− --
92− -- This function is normally used in the calllback for 'fireEventsAndRead'.
93− readEvent :: EventHandle t a -> m (Maybe (m a))
94−
95−-- | A monad where new events feed from external sources can be created.
96−class (Applicative m, Monad m) => MonadReflexCreateTrigger t m | m -> t where
97− -- | Creates a root 'Event' (one that is not based on any other event).
98− --
99− -- When a subscriber first subscribes to an event (building another event that
100− -- depends on the subscription) the given callback function is run and passed
101− -- a trigger. The callback function can then set up the event source in IO.
102− -- After this is done, the callback function must return an accompanying
103− -- teardown action.
104− --
105− -- Any time between setup and teardown the trigger can be used to fire the
106− -- event, by passing it to 'fireEventsAndRead'.
107− --
108− -- Note: An event may be set up multiple times. So after the teardown action
109− -- is executed, the event may still be set up again in the future.
110− newEventWithTrigger :: (EventTrigger t a -> IO (IO ())) -> m (Event t a)
111− newFanEventWithTrigger :: GCompare k => (forall a. k a -> EventTrigger t a -> IO (IO ())) -> m (EventSelector t k)
112−
113−-- | 'MonadReflexHost' designates monads that can run reflex frames.
114−class ( ReflexHost t
115− , MonadReflexCreateTrigger t m
116− , MonadSubscribeEvent t m
117− , MonadReadEvent t (ReadPhase m)
118− , MonadSample t (ReadPhase m)
119− , MonadHold t (ReadPhase m)
120− ) => MonadReflexHost t m | m -> t where
121− type ReadPhase m :: * -> *
122− -- | Propagate some events firings and read the values of events afterwards.
123− --
124− -- This function will create a new frame to fire the given events. It will
125− -- then update all dependent events and behaviors. After that is done, the
126− -- given callback is executed which allows to read the final values of events
127− -- and check whether they have fired in this frame or not.
128− --
129− -- All events that are given are fired at the same time.
130− --
131− -- This function is typically used in the main loop of a reflex framework
132− -- implementation. The main loop waits for external events to happen (such as
133− -- keyboard input or a mouse click) and then fires the corresponding events
134− -- using this function. The read callback can be used to read output events
135− -- and perform a corresponding response action to the external event.
136− fireEventsAndRead :: [DSum (EventTrigger t) Identity] -> ReadPhase m a -> m a
137−
138− -- | Run a frame without any events firing.
139− --
140− -- This function should be used when you want to use 'sample' and 'hold' when
141− -- no events are currently firing. Using this function in that case can
142− -- improve performance, since the implementation can assume that no events are
143− -- firing when 'sample' or 'hold' are called.
144− --
145− -- This function is commonly used to set up the basic event network when the
146− -- application starts up.
147− runHostFrame :: HostFrame t a -> m a
148−
149−-- | Like 'fireEventsAndRead', but without reading any events.
150−fireEvents :: MonadReflexHost t m => [DSum (EventTrigger t) Identity] -> m ()
151−fireEvents dm = fireEventsAndRead dm $ return ()
152−{-# INLINE fireEvents #-}
153−
154−-- | Create a new event and store its trigger in an 'IORef' while it's active.
155−--
156−-- An event is only active between the set up (when it's first subscribed to)
157−-- and the teardown phases (when noboby is subscribing the event anymore). This
158−-- function returns an Event and an 'IORef'. As long as the event is active, the
159−-- 'IORef' will contain 'Just' the event trigger to trigger this event. When the
160−-- event is not active, the 'IORef' will contain 'Nothing'. This allows event
161−-- sources to be more efficient, since they don't need to produce events when
162−-- nobody is listening.
163−newEventWithTriggerRef :: (MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref IO) => m (Event t a, Ref m (Maybe (EventTrigger t a)))
164−newEventWithTriggerRef = do
165− rt <- newRef Nothing
166− e <- newEventWithTrigger $ \t -> do
167− writeRef rt $ Just t
168− return $ writeRef rt Nothing
169− return (e, rt)
170−{-# INLINE newEventWithTriggerRef #-}
171−
172−-- | Fire the given trigger if it is not 'Nothing'.
173−fireEventRef :: (MonadReflexHost t m, MonadRef m, Ref m ~ Ref IO) => Ref m (Maybe (EventTrigger t a)) -> a -> m ()
174−fireEventRef mtRef input = do
175− mt <- readRef mtRef
176− case mt of
177− Nothing -> return ()
178− Just trigger -> fireEvents [trigger :=> Identity input]
179−
180−-- | Fire the given trigger if it is not 'Nothing', and read from the given
181−-- 'EventHandle'.
182−fireEventRefAndRead :: (MonadReflexHost t m, MonadRef m, Ref m ~ Ref IO) => Ref m (Maybe (EventTrigger t a)) -> a -> EventHandle t b -> m (Maybe b)
183−fireEventRefAndRead mtRef input e = do
184− mt <- readRef mtRef
185− case mt of
186− Nothing -> return Nothing -- Since we aren't firing the input, the output can't fire
187− Just trigger -> fireEventsAndRead [trigger :=> Identity input] $ do
188− mGetValue <- readEvent e
189− case mGetValue of
190− Nothing -> return Nothing
191− Just getValue -> fmap Just getValue
192−
193−
194−--------------------------------------------------------------------------------
195−-- Instances
196−--------------------------------------------------------------------------------
197−
198−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ReaderT r m) where
199− newEventWithTrigger = lift . newEventWithTrigger
200− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
201−
202−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (ReaderT r m) where
203− subscribeEvent = lift . subscribeEvent
204−
205−instance MonadReflexHost t m => MonadReflexHost t (ReaderT r m) where
206− type ReadPhase (ReaderT r m) = ReadPhase m
207− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
208− runHostFrame = lift . runHostFrame
209−
210−instance (MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (WriterT w m) where
211− newEventWithTrigger = lift . newEventWithTrigger
212− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
213−
214−instance (MonadSubscribeEvent t m, Monoid w) => MonadSubscribeEvent t (WriterT w m) where
215− subscribeEvent = lift . subscribeEvent
216−
217−instance (MonadReflexHost t m, Monoid w) => MonadReflexHost t (WriterT w m) where
218− type ReadPhase (WriterT w m) = ReadPhase m
219− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
220− runHostFrame = lift . runHostFrame
221−
222−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StateT s m) where
223− newEventWithTrigger = lift . newEventWithTrigger
224− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
225−
226−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (StateT r m) where
227− subscribeEvent = lift . subscribeEvent
228−
229−instance MonadReflexHost t m => MonadReflexHost t (StateT s m) where
230− type ReadPhase (StateT s m) = ReadPhase m
231− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
232− runHostFrame = lift . runHostFrame
233−
234−
235−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Strict.StateT s m) where
236− newEventWithTrigger = lift . newEventWithTrigger
237− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
238−
239−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (Strict.StateT r m) where
240− subscribeEvent = lift . subscribeEvent
241−
242−instance MonadReflexHost t m => MonadReflexHost t (Strict.StateT s m) where
243− type ReadPhase (Strict.StateT s m) = ReadPhase m
244− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
245− runHostFrame = lift . runHostFrame
246−
247−
248−
249−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ContT r m) where
250− newEventWithTrigger = lift . newEventWithTrigger
251− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
252−
253−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (ContT r m) where
254− subscribeEvent = lift . subscribeEvent
255−
256−instance MonadReflexHost t m => MonadReflexHost t (ContT r m) where
257− type ReadPhase (ContT r m) = ReadPhase m
258− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
259− runHostFrame = lift . runHostFrame
260−
261−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ExceptT e m) where
262− newEventWithTrigger = lift . newEventWithTrigger
263− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
264−
265−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (ExceptT r m) where
266− subscribeEvent = lift . subscribeEvent
267−
268−instance MonadReflexHost t m => MonadReflexHost t (ExceptT e m) where
269− type ReadPhase (ExceptT e m) = ReadPhase m
270− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
271− runHostFrame = lift . runHostFrame
272−
273−instance (MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (RWST r w s m) where
274− newEventWithTrigger = lift . newEventWithTrigger
275− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
276−
277−instance (MonadSubscribeEvent t m, Monoid w) => MonadSubscribeEvent t (RWST r w s m) where
278− subscribeEvent = lift . subscribeEvent
279−
280−instance (MonadReflexHost t m, Monoid w) => MonadReflexHost t (RWST r w s m) where
281− type ReadPhase (RWST r w s m) = ReadPhase m
282− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
283− runHostFrame = lift . runHostFrame
src/Reflex/Optimizer.hsdeleted−33
@@ -1,33 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
3−module Reflex.Optimizer (plugin) where
4−
5−#ifndef ghcjs_HOST_OS
6−
7−import GhcPlugins
8−import Control.Arrow
9−
10−plugin :: Plugin
11−plugin = defaultPlugin { installCoreToDos = install }
12−
13−install :: [CommandLineOption] -> [CoreToDo] -> CoreM [CoreToDo]
14−install [] p = return $ makeInlinable : p
15−
16−makeInlinable :: CoreToDo
17−makeInlinable = CoreDoPluginPass "MakeInlinable" $ \modGuts -> do
18− let f v = setIdInfo v $ let i = idInfo v in
19− setInlinePragInfo i $ let p = inlinePragInfo i in
20− if isDefaultInlinePragma p
21− then defaultInlinePragma { inl_inline = Inlinable }
22− else p
23− newBinds = flip map (mg_binds modGuts) $ \case
24− NonRec b e -> NonRec (f b) e
25− Rec bes -> Rec $ map (first f) bes
26− return $ modGuts { mg_binds = newBinds }
27−
28−#else
29−
30−plugin :: ()
31−plugin = ()
32−
33−#endif
src/Reflex/PerformEvent/Base.hsdeleted−288
@@ -1,288 +0,0 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE FlexibleInstances #-}
3−{-# LANGUAGE GADTs #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE PartialTypeSignatures #-}
7−{-# LANGUAGE PolyKinds #-}
8−{-# LANGUAGE RankNTypes #-}
9−{-# LANGUAGE RecursiveDo #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE StandaloneDeriving #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
16−module Reflex.PerformEvent.Base where
17−
18−import Reflex.Class
19−import Reflex.Host.Class
20−import Reflex.PostBuild.Class
21−import Reflex.PerformEvent.Class
22−
23−import Control.Lens
24−import Control.Monad.Exception
25−import Control.Monad.Identity
26−import Control.Monad.Primitive
27−import Control.Monad.Ref
28−import Control.Monad.State.Strict
29−import Control.Monad.Reader
30−import Data.Coerce
31−import Data.Dependent.Map (DMap, GCompare (..), Some)
32−import qualified Data.Dependent.Map as DMap
33−import Data.Dependent.Sum
34−import Data.Functor.Misc
35−import Data.Maybe
36−import Data.Semigroup
37−import qualified Data.Some as Some
38−import Data.These
39−import Data.Tuple
40−import Data.Unique.Tag
41−
42−newtype EventTriggerRef t m a = EventTriggerRef { unEventTriggerRef :: Ref m (Maybe (EventTrigger t a)) }
43−
44−newtype FireCommand t m = FireCommand { runFireCommand :: forall a. [DSum (EventTrigger t) Identity] -> ReadPhase m a -> m [a] } --TODO: The handling of this ReadPhase seems wrong, or at least inelegant; how do we actually make the decision about what order frames run in?
45−
46−newtype PerformEventT t m a = PerformEventT { unPerformEventT :: RequestT t (HostFrame t) Identity (HostFrame t) a }
47−
48−deriving instance ReflexHost t => Functor (PerformEventT t m)
49−deriving instance ReflexHost t => Applicative (PerformEventT t m)
50−deriving instance ReflexHost t => Monad (PerformEventT t m)
51−deriving instance ReflexHost t => MonadFix (PerformEventT t m)
52−deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
53−deriving instance (ReflexHost t, MonadException (HostFrame t)) => MonadException (PerformEventT t m)
54−
55−instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
56− type PrimState (PerformEventT t m) = PrimState (HostFrame t)
57− primitive = PerformEventT . lift . primitive
58−
59−instance (ReflexHost t, Ref m ~ Ref IO, PrimMonad (HostFrame t)) => PerformEvent t (PerformEventT t m) where
60− type Performable (PerformEventT t m) = HostFrame t
61− {-# INLINABLE performEvent_ #-}
62− performEvent_ = PerformEventT . requesting_
63− {-# INLINABLE performEvent #-}
64− performEvent = PerformEventT . fmap (fmap runIdentity) . requesting
65−
66−instance (ReflexHost t, PrimMonad (HostFrame t)) => MonadAdjust t (PerformEventT t m) where
67− sequenceDMapWithAdjust (outerDm0 :: DMap k (PerformEventT t m)) outerDm' = PerformEventT $ sequenceDMapWithAdjustRequestTWith f (coerce outerDm0) (coerceEvent outerDm')
68− where f :: DMap k' (HostFrame t) -> Event t (PatchDMap k' (HostFrame t)) -> RequestT t (HostFrame t) Identity (HostFrame t) (DMap k' Identity, Event t (PatchDMap k' Identity))
69− f dm0 dm' = do
70− result0 <- lift $ DMap.traverseWithKey (\_ v -> Identity <$> v) dm0
71− result' <- requesting $ ffor dm' $ \(PatchDMap p) -> do
72− PatchDMap <$> DMap.traverseWithKey (\_ (ComposeMaybe mv) -> ComposeMaybe <$> mapM (fmap Identity) mv) p
73− return (result0, fmap runIdentity result')
74−
75−instance ReflexHost t => MonadReflexCreateTrigger t (PerformEventT t m) where
76− {-# INLINABLE newEventWithTrigger #-}
77− newEventWithTrigger = PerformEventT . lift . newEventWithTrigger
78− {-# INLINABLE newFanEventWithTrigger #-}
79− newFanEventWithTrigger f = PerformEventT $ lift $ newFanEventWithTrigger f
80−
81−{-# INLINABLE hostPerformEventT #-}
82−hostPerformEventT :: forall t m a.
83− ( Monad m
84− , MonadSubscribeEvent t m
85− , MonadReflexHost t m
86− , MonadRef m
87− , Ref m ~ Ref IO
88− )
89− => PerformEventT t m a
90− -> m (a, FireCommand t m)
91−hostPerformEventT a = do
92− (response, responseTrigger) <- newEventWithTriggerRef
93− (result, eventToPerform) <- runHostFrame $ runRequestT (unPerformEventT a) response
94− eventToPerformHandle <- subscribeEvent eventToPerform
95− return $ (,) result $ FireCommand $ \triggers (readPhase :: ReadPhase m a') -> do
96− let go :: [DSum (EventTrigger t) Identity] -> m [a']
97− go ts = do
98− (result', mToPerform) <- fireEventsAndRead ts $ do
99− mToPerform <- sequence =<< readEvent eventToPerformHandle
100− result' <- readPhase
101− return (result', mToPerform)
102− case mToPerform of
103− Nothing -> return [result']
104− Just toPerform -> do
105− responses <- runHostFrame $ DMap.traverseWithKey (\_ v -> Identity <$> v) toPerform
106− mrt <- readRef responseTrigger
107− let followupEventTriggers = case mrt of
108− Just rt -> [rt :=> Identity responses]
109− Nothing -> []
110− (result':) <$> go followupEventTriggers
111− go triggers
112−
113−instance ReflexHost t => MonadSample t (PerformEventT t m) where
114− {-# INLINABLE sample #-}
115− sample = PerformEventT . lift . sample
116−
117−instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
118− {-# INLINABLE hold #-}
119− hold v0 v' = PerformEventT $ lift $ hold v0 v'
120− {-# INLINABLE holdDyn #-}
121− holdDyn v0 v' = PerformEventT $ lift $ holdDyn v0 v'
122− {-# INLINABLE holdIncremental #-}
123− holdIncremental v0 v' = PerformEventT $ lift $ holdIncremental v0 v'
124−
125−instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
126− type Ref (PerformEventT t m) = Ref (HostFrame t)
127− {-# INLINABLE newRef #-}
128− newRef = PerformEventT . lift . newRef
129− {-# INLINABLE readRef #-}
130− readRef = PerformEventT . lift . readRef
131− {-# INLINABLE writeRef #-}
132− writeRef r = PerformEventT . lift . writeRef r
133−
134−instance (MonadAtomicRef (HostFrame t), ReflexHost t) => MonadAtomicRef (PerformEventT t m) where
135− {-# INLINABLE atomicModifyRef #-}
136− atomicModifyRef r = PerformEventT . lift . atomicModifyRef r
137−
138−--------------------------------------------------------------------------------
139−-- RequestT
140−--------------------------------------------------------------------------------
141−
142−newtype RequestT t request response m a
143− = RequestT { unRequestT :: StateT [Event t (DMap (Tag (PrimState m)) request)] (ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m) a }
144− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException)
145−
146−instance MonadTrans (RequestT t request response) where
147− lift = RequestT . lift . lift
148−
149−runRequestT :: forall t m a request response.
150− ( Reflex t
151− , Monad m
152− )
153− => RequestT t request response m a
154− -> Event t (DMap (Tag (PrimState m)) response)
155− -> m (a, Event t (DMap (Tag (PrimState m)) request))
156−runRequestT (RequestT a) responses = do
157− (result, requests) <- runReaderT (runStateT a mempty) $ fan $ mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e) <$> responses
158− return (result, mergeWith DMap.union requests)
159−
160−instance (Reflex t, PrimMonad m) => MonadRequest t (RequestT t request response m) where
161− type Request (RequestT t request response m) = request
162− type Response (RequestT t request response m) = response
163− withRequesting a = do
164− t <- lift newTag
165− s <- RequestT ask
166− (req, result) <- a $ select s $ WrapArg t
167− RequestT $ modify $ (:) $ DMap.singleton t <$> req
168− return result
169−
170−data DMapTransform (a :: *) k k' v v' = forall (b :: *). DMapTransform !(k a -> k' b) !(v a -> v' b)
171−
172−mapPatchKeysAndValuesMonotonic :: (forall a. DMapTransform a k k' v v') -> PatchDMap k v -> PatchDMap k' v'
173−mapPatchKeysAndValuesMonotonic x (PatchDMap p) = PatchDMap $ mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mv) -> case x of DMapTransform f g -> f k :=> ComposeMaybe (fmap g mv)) p
174−
175−mapKeysAndValuesMonotonic :: (forall a. DMapTransform a k k' v v') -> DMap k v -> DMap k' v'
176−mapKeysAndValuesMonotonic x = mapKeyValuePairsMonotonic $ \(k :=> v) -> case x of
177− DMapTransform f g -> f k :=> g v
178−
179−instance MonadSample t m => MonadSample t (RequestT t request response m) where
180− sample = lift . sample
181−
182−instance MonadHold t m => MonadHold t (RequestT t request response m) where
183− hold v0 = lift . hold v0
184− holdDyn v0 = lift . holdDyn v0
185− holdIncremental v0 = lift . holdIncremental v0
186−
187−instance (Reflex t, MonadAdjust t m, MonadHold t m) => MonadAdjust t (RequestT t request response m) where
188− sequenceDMapWithAdjust = sequenceDMapWithAdjustRequestTWith $ \dm0 dm' -> lift $ sequenceDMapWithAdjust dm0 dm'
189−
190−sequenceDMapWithAdjustRequestTWith :: (GCompare k, Monad m, Reflex t, MonadHold t m)
191− => (forall k'. GCompare k'
192− => DMap k' m
193− -> Event t (PatchDMap k' m)
194− -> RequestT t request response m (DMap k' Identity, Event t (PatchDMap k' Identity))
195− )
196− -> DMap k (RequestT t request response m)
197− -> Event t (PatchDMap k (RequestT t request response m))
198− -> RequestT t request response m (DMap k Identity, Event t (PatchDMap k Identity))
199−sequenceDMapWithAdjustRequestTWith f (dm0 :: DMap k (RequestT t request response m)) dm' = do
200− response <- RequestT ask
201− let inputTransform :: forall a. DMapTransform a k (WrapArg ((,) [Event t (DMap (Tag (PrimState m)) request)]) k) (RequestT t request response m) m
202− inputTransform = DMapTransform WrapArg (\(RequestT v) -> swap <$> runReaderT (runStateT v mempty) response)
203− (children0, children') <- f (mapKeysAndValuesMonotonic inputTransform dm0) $ mapPatchKeysAndValuesMonotonic inputTransform <$> dm'
204− let result0 = mapKeyValuePairsMonotonic (\(WrapArg k :=> Identity (_, v)) -> k :=> Identity v) children0
205− result' = ffor children' $ \(PatchDMap p) -> PatchDMap $
206− mapKeyValuePairsMonotonic (\(WrapArg k :=> ComposeMaybe mv) -> k :=> ComposeMaybe (fmap (Identity . snd . runIdentity) mv)) p
207− requests0 :: DMap (Const2 (Some k) (DMap (Tag (PrimState m)) request)) (Event t)
208− requests0 = mapKeyValuePairsMonotonic (\(WrapArg k :=> Identity (r, _)) -> Const2 (Some.This k) :=> mergeWith DMap.union r) children0
209− requests' :: Event t (PatchDMap (Const2 (Some k) (DMap (Tag (PrimState m)) request)) (Event t))
210− requests' = ffor children' $ \(PatchDMap p) -> PatchDMap $
211− mapKeyValuePairsMonotonic (\(WrapArg k :=> ComposeMaybe mv) -> Const2 (Some.This k) :=> ComposeMaybe (fmap (mergeWith DMap.union . fst . runIdentity) mv)) p
212− childRequestMap <- holdIncremental requests0 requests'
213− RequestT $ modify $ (:) $ ffor (mergeIncremental childRequestMap) $ \m ->
214− mconcat $ (\(Const2 _ :=> Identity reqs) -> reqs) <$> DMap.toList m
215− RequestT $ modify $ (:) $ coincidence $ ffor requests' $ \(PatchDMap p) -> mergeWith DMap.union $ catMaybes $ ffor (DMap.toList p) $ \(Const2 _ :=> ComposeMaybe me) -> me
216− return (result0, result')
217−
218−instance PerformEvent t m => PerformEvent t (RequestT t request response m) where
219− type Performable (RequestT t request response m) = Performable m
220− performEvent_ = lift . performEvent_
221− performEvent = lift . performEvent
222−
223−instance PostBuild t m => PostBuild t (RequestT t request response m) where
224− getPostBuild = lift getPostBuild
225−
226−instance TriggerEvent t m => TriggerEvent t (RequestT t request response m) where
227− newTriggerEvent = lift newTriggerEvent
228− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
229− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
230−
231−instance MonadReader r m => MonadReader r (RequestT t request response m) where
232− ask = lift ask
233− local f (RequestT a) = RequestT $ mapStateT (mapReaderT $ local f) a
234− reader = lift . reader
235−
236−{-
237−withRequestT :: forall t m a (req :: * -> *) (req' :: * -> *).
238− (Reflex t, MonadHold t m, MonadFix m)
239− => (forall x. request x -> request' x)
240− -> (forall x. response' x -> response x)
241− -> RequestT t request response m a
242− -> RequestT t request' response m a
243−withRequestT f g m = RequestT $ hoist (hoist (withDynamicWriterT f')) (unRequestT m)
244− where
245− f' :: Event t [(y, Some request)] -> Event t [(y, Some request')]
246− f' = fmap . fmap . fmap $ \(SomeRequest req) -> SomeRequest $ f req
247−-}
248−
249−instance MonadRef m => MonadRef (RequestT t request response m) where
250− type Ref (RequestT t request response m) = Ref m
251− newRef = lift . newRef
252− readRef = lift . readRef
253− writeRef r = lift . writeRef r
254−
255−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (RequestT t request response m) where
256− newEventWithTrigger = lift . newEventWithTrigger
257− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
258−
259−
260−--------------------------------------------------------------------------------
261−-- Helpers
262−--------------------------------------------------------------------------------
263−
264−{-# INLINABLE numberWith #-}
265−numberWith :: (Enum n, Traversable t) => (n -> a -> b) -> t a -> n -> (t b, n)
266−numberWith f t n0 = flip runState n0 $ forM t $ \x -> state $ \n -> (f n x, succ n)
267−
268−{-# INLINABLE mergeSelfDeletingEvents #-}
269−mergeSelfDeletingEvents :: forall t m k v. (Ord k, Reflex t, MonadFix m, MonadHold t m)
270− => DMap (Const2 k (These v ())) (Event t)
271− -> Event t (PatchDMap (Const2 k (These v ())) (Event t))
272− -> m (Event t [v])
273−mergeSelfDeletingEvents initial eAddNew = do
274− rec events :: Incremental t (PatchDMap (Const2 k (These v ())) (Event t))
275− <- holdIncremental initial $ eAddNew <> eDelete --TODO: Eliminate empty firings
276− let event = mergeWith DMap.union
277− [ mergeIncremental events
278− , coincidence $ ffor eAddNew $ \(PatchDMap m) -> merge $ DMap.mapMaybeWithKey (const getComposeMaybe) m
279− ]
280− eDelete :: Event t (PatchDMap (Const2 k (These v ())) (Event t))
281− eDelete = fforMaybe event $
282− fmap (PatchDMap . DMap.fromDistinctAscList) .
283− (\l -> if null l then Nothing else Just l) .
284− fmapMaybe (\(Const2 k :=> Identity x) -> (Const2 k :=> ComposeMaybe Nothing) <$ x ^? there) .
285− DMap.toList
286− return $ ffor event $
287− fmapMaybe (\(Const2 _ :=> Identity x) -> x ^? here) .
288− DMap.toList
src/Reflex/PerformEvent/Class.hsdeleted−93
@@ -1,93 +0,0 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE FlexibleInstances #-}
3−{-# LANGUAGE FunctionalDependencies #-}
4−{-# LANGUAGE MultiParamTypeClasses #-}
5−{-# LANGUAGE RankNTypes #-}
6−{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TypeFamilies #-}
8−{-# LANGUAGE TypeOperators #-}
9−{-# LANGUAGE UndecidableInstances #-}
10−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11−module Reflex.PerformEvent.Class where
12−
13−import Reflex.Class
14−
15−import Control.Monad.Identity
16−import Control.Monad.Reader
17−import qualified Control.Monad.State.Lazy as Lazy
18−import Control.Monad.State.Strict
19−
20−class (Reflex t, Monad (Performable m), Monad m) => PerformEvent t m | m -> t where
21− type Performable m :: * -> *
22− performEvent :: Event t (Performable m a) -> m (Event t a)
23− performEvent_ :: Event t (Performable m ()) -> m ()
24−
25−--TODO: Shouldn't have IO hard-coded
26−class Monad m => TriggerEvent t m | m -> t where
27− newTriggerEvent :: m (Event t a, a -> IO ())
28− newTriggerEventWithOnComplete :: m (Event t a, a -> IO () -> IO ()) --TODO: This and newTriggerEvent should be unified somehow
29− newEventWithLazyTriggerWithOnComplete :: ((a -> IO () -> IO ()) -> IO (IO ())) -> m (Event t a)
30−
31−class (Reflex t, Monad m) => MonadRequest t m | m -> t where
32− type Request m :: * -> *
33− type Response m :: * -> *
34− withRequesting :: (Event t (Response m a) -> m (Event t (Request m a), r)) -> m r
35−
36−{-# INLINABLE performEventAsync #-}
37−performEventAsync :: (TriggerEvent t m, PerformEvent t m) => Event t ((a -> IO ()) -> Performable m ()) -> m (Event t a)
38−performEventAsync e = do
39− (eOut, triggerEOut) <- newTriggerEvent
40− performEvent_ $ fmap ($ triggerEOut) e
41− return eOut
42−
43−instance PerformEvent t m => PerformEvent t (ReaderT r m) where
44− type Performable (ReaderT r m) = ReaderT r (Performable m)
45− performEvent_ e = do
46− r <- ask
47− lift $ performEvent_ $ flip runReaderT r <$> e
48− performEvent e = do
49− r <- ask
50− lift $ performEvent $ flip runReaderT r <$> e
51−
52−instance TriggerEvent t m => TriggerEvent t (ReaderT r m) where
53− newTriggerEvent = lift newTriggerEvent
54− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
55− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
56−
57−instance MonadRequest t m => MonadRequest t (ReaderT r m) where
58− type Request (ReaderT r m) = Request m
59− type Response (ReaderT r m) = Response m
60− withRequesting f = do
61− r <- ask
62− lift $ withRequesting $ (`runReaderT` r) . f
63−
64−instance MonadRequest t m => MonadRequest t (StateT s m) where
65− type Request (StateT s m) = Request m
66− type Response (StateT s m) = Response m
67− withRequesting f = do
68− old <- get
69− (result, new) <- lift $ withRequesting $ \x -> do
70− ((request, result), new) <- runStateT (f x) old
71− return (request, (result, new))
72− put new
73− return result
74−
75−instance MonadRequest t m => MonadRequest t (Lazy.StateT s m) where
76− type Request (Lazy.StateT s m) = Request m
77− type Response (Lazy.StateT s m) = Response m
78− withRequesting f = do
79− old <- Lazy.get
80− (result, new) <- lift $ withRequesting $ \x -> do
81− ((request, result), new) <- Lazy.runStateT (f x) old
82− return (request, (result, new))
83− Lazy.put new
84− return result
85−
86−requesting :: MonadRequest t m => Event t (Request m a) -> m (Event t (Response m a))
87−requesting req = withRequesting $ return . (,) req
88−
89−requesting_ :: MonadRequest t m => Event t (Request m a) -> m ()
90−requesting_ req = withRequesting $ \_ -> return (req, ())
91−
92−requestingIdentity :: (MonadRequest t m, Response m ~ Identity) => Event t (Request m a) -> m (Event t a)
93−requestingIdentity = fmap (fmap runIdentity) . requesting
src/Reflex/PostBuild/Class.hsdeleted−103
@@ -1,103 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE FlexibleInstances #-}
3−{-# LANGUAGE FunctionalDependencies #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE RecursiveDo #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE TypeOperators #-}
10−{-# LANGUAGE UndecidableInstances #-}
11−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12−module Reflex.PostBuild.Class where
13−
14−import Control.Monad.Exception
15−import Control.Monad.Primitive
16−import Control.Monad.Reader
17−import Control.Monad.Ref
18−import Control.Monad.Trans.Control
19−import qualified Data.Dependent.Map as DMap
20−import Reflex.Class
21−import Reflex.Host.Class
22−import Reflex.PerformEvent.Class
23−
24−class (Reflex t, Monad m) => PostBuild t m | m -> t where
25− getPostBuild :: m (Event t ())
26−
27−newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans, MonadException, MonadAsyncException)
28−
29−instance PrimMonad m => PrimMonad (PostBuildT x m) where
30− type PrimState (PostBuildT x m) = PrimState m
31− primitive = lift . primitive
32−
33−instance MonadTransControl (PostBuildT t) where
34− type StT (PostBuildT t) a = StT (ReaderT (Event t ())) a
35− {-# INLINABLE liftWith #-}
36− liftWith = defaultLiftWith PostBuildT unPostBuildT
37− {-# INLINABLE restoreT #-}
38− restoreT = defaultRestoreT PostBuildT
39−
40−instance (Reflex t, Monad m) => PostBuild t (PostBuildT t m) where
41− {-# INLINABLE getPostBuild #-}
42− getPostBuild = PostBuildT ask
43−
44−instance MonadSample t m => MonadSample t (PostBuildT t m) where
45− {-# INLINABLE sample #-}
46− sample = lift . sample
47−
48−instance MonadHold t m => MonadHold t (PostBuildT t m) where
49− {-# INLINABLE hold #-}
50− hold v0 = lift . hold v0
51− {-# INLINABLE holdDyn #-}
52− holdDyn v0 = lift . holdDyn v0
53− {-# INLINABLE holdIncremental #-}
54− holdIncremental v0 = lift . holdIncremental v0
55−
56−instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
57− type Performable (PostBuildT t m) = PostBuildT t (Performable m)
58− {-# INLINABLE performEvent_ #-}
59− performEvent_ e = liftWith $ \run -> performEvent_ $ fmap run e
60− {-# INLINABLE performEvent #-}
61− performEvent e = liftWith $ \run -> performEvent $ fmap run e
62−
63−instance (ReflexHost t, MonadReflexCreateTrigger t m) => MonadReflexCreateTrigger t (PostBuildT t m) where
64− {-# INLINABLE newEventWithTrigger #-}
65− newEventWithTrigger = PostBuildT . lift . newEventWithTrigger
66− {-# INLINABLE newFanEventWithTrigger #-}
67− newFanEventWithTrigger f = PostBuildT $ lift $ newFanEventWithTrigger f
68−
69−instance TriggerEvent t m => TriggerEvent t (PostBuildT t m) where
70− {-# INLINABLE newTriggerEvent #-}
71− newTriggerEvent = lift newTriggerEvent
72− {-# INLINABLE newTriggerEventWithOnComplete #-}
73− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
74− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
75−
76−instance MonadRef m => MonadRef (PostBuildT t m) where
77− type Ref (PostBuildT t m) = Ref m
78− {-# INLINABLE newRef #-}
79− newRef = lift . newRef
80− {-# INLINABLE readRef #-}
81− readRef = lift . readRef
82− {-# INLINABLE writeRef #-}
83− writeRef r = lift . writeRef r
84−
85−instance MonadAtomicRef m => MonadAtomicRef (PostBuildT t m) where
86− {-# INLINABLE atomicModifyRef #-}
87− atomicModifyRef r = lift . atomicModifyRef r
88−
89−{-# INLINABLE runPostBuildT #-}
90−runPostBuildT :: PostBuildT t m a -> Event t () -> m a
91−runPostBuildT (PostBuildT a) = runReaderT a
92−
93−instance PostBuild t m => PostBuild t (ReaderT r m) where
94− getPostBuild = lift getPostBuild
95−
96−instance (Reflex t, MonadHold t m, MonadFix m, MonadAdjust t m, PerformEvent t m) => MonadAdjust t (PostBuildT t m) where
97− sequenceDMapWithAdjust dm0 dm' = do
98− postBuild <- getPostBuild
99− let loweredDm0 = DMap.map (`runPostBuildT` postBuild) dm0
100− rec (result0, result') <- lift $ sequenceDMapWithAdjust loweredDm0 loweredDm'
101− let loweredDm' = ffor dm' $ \(PatchDMap p) -> PatchDMap $
102− DMap.map (ComposeMaybe . fmap (\v -> runPostBuildT v =<< headE (void result')) . getComposeMaybe) p --TODO: Avoid doing this headE so many times; once per loweredDm' firing ought to be OK, but it's not totally trivial to do because result' might be firing at the same time, and we don't want *that* to be the postBuild occurrence
103− return (result0, result')
src/Reflex/Pure.hsdeleted−172
@@ -1,172 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE EmptyDataDecls #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE InstanceSigs #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TypeFamilies #-}
8−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
9−
10−-- There are two expected orphan instances in this module:
11−-- * MonadSample (Pure t) ((->) t)
12−-- * MonadHold (Pure t) ((->) t)
13−{-# OPTIONS_GHC -fno-warn-orphans #-}
14−
15−-- | This module provides a pure implementation of Reflex, which is intended to
16−-- serve as a reference for the semantics of the Reflex class. All
17−-- implementations of Reflex should produce the same results as this
18−-- implementation, although performance and laziness/strictness may differ.
19−module Reflex.Pure where
20−
21−#if !MIN_VERSION_base(4,8,0)
22−import Control.Applicative -- Necessary for GHC 7.8
23−#endif
24−
25−import Control.Monad
26−import Data.Dependent.Map (DMap, GCompare)
27−import qualified Data.Dependent.Map as DMap
28−import Data.Functor.Identity
29−import Data.Maybe
30−import Data.MemoTrie
31−import Data.Monoid
32−import Data.Type.Coercion
33−import Reflex.Class
34−
35−data Pure t
36−
37−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
38−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
39−-- exclusively to memoize functions of t, not for any of its other capabilities.
40−instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
41−
42− newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
43− newtype Event (Pure t) a = Event { unEvent :: t -> Maybe a }
44− newtype Dynamic (Pure t) a = Dynamic { unDynamic :: t -> (a, Maybe a) }
45− newtype Incremental (Pure t) p = Incremental { unIncremental :: t -> (PatchTarget p, Maybe p) }
46−
47− type PushM (Pure t) = (->) t
48− type PullM (Pure t) = (->) t
49−
50− never :: Event (Pure t) a
51− never = Event $ \_ -> Nothing
52−
53− constant :: a -> Behavior (Pure t) a
54− constant x = Behavior $ \_ -> x
55−
56− push :: (a -> PushM (Pure t) (Maybe b)) -> Event (Pure t) a -> Event (Pure t) b
57− push f e = Event $ memo $ \t -> unEvent e t >>= \o -> f o t
58−
59− pull :: PullM (Pure t) a -> Behavior (Pure t) a
60− pull = Behavior . memo
61−
62− -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
63− -- warning because the GCompare instance is not used; however, removing the
64− -- GCompare instance produces a different warning, due to that constraint
65− -- being present in the original class definition
66−
67− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
68− merge events = Event $ memo $ \t ->
69− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
70− in if DMap.null currentOccurrences
71− then Nothing
72− else Just currentOccurrences
73−
74− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
75− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
76−
77− switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
78− switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
79−
80− coincidence :: Event (Pure t) (Event (Pure t) a) -> Event (Pure t) a
81− coincidence e = Event $ memo $ \t -> unEvent e t >>= \o -> unEvent o t
82−
83− current :: Dynamic (Pure t) a -> Behavior (Pure t) a
84− current d = Behavior $ \t -> fst $ unDynamic d t
85−
86− updated :: Dynamic (Pure t) a -> Event (Pure t) a
87− updated d = Event $ \t -> snd $ unDynamic d t
88−
89− unsafeBuildDynamic :: PullM (Pure t) a -> Event (Pure t) a -> Dynamic (Pure t) a
90− unsafeBuildDynamic readV0 v' = Dynamic $ \t -> (readV0 t, unEvent v' t)
91−
92− -- See UNUSED_CONSTRAINT, above.
93−
94− --unsafeBuildIncremental :: Patch p => PullM (Pure t) a -> Event (Pure t) (p
95− --a) -> Incremental (Pure t) p a
96− unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
97−
98− mergeIncremental (Incremental f) = Event $ \t ->
99− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ f t
100− in if DMap.null results
101− then Nothing
102− else Just results
103−
104− currentIncremental (Incremental f) = Behavior $ \t -> fst $ f t
105−
106− updatedIncremental (Incremental f) = Event $ \t -> snd $ f t
107−
108− incrementalToDynamic (Incremental f) = Dynamic $ \t ->
109− let (old, mPatch) = f t
110− e = case mPatch of
111− Nothing -> Nothing
112− Just patch -> apply patch old
113− in (old, e)
114− behaviorCoercion Coercion = Coercion
115− eventCoercion Coercion = Coercion
116− dynamicCoercion Coercion = Coercion
117−
118−instance Functor (Dynamic (Pure t)) where
119− fmap f d = Dynamic $ \t -> let (cur, upd) = unDynamic d t
120− in (f cur, fmap f upd)
121−
122−instance Applicative (Dynamic (Pure t)) where
123− pure a = Dynamic $ \_ -> (a, Nothing)
124− (<*>) = ap
125−
126−instance Monad (Dynamic (Pure t)) where
127− return = pure
128− (x :: Dynamic (Pure t) a) >>= (f :: a -> Dynamic (Pure t) b) = Dynamic $ \t ->
129− let (curX :: a, updX :: Maybe a) = unDynamic x t
130− (cur :: b, updOuter :: Maybe b) = unDynamic (f curX) t
131− (updInner :: Maybe b, updBoth :: Maybe b) = case updX of
132− Nothing -> (Nothing, Nothing)
133− Just nextX -> let (c, u) = unDynamic (f nextX) t
134− in (Just c, u)
135− in (cur, getFirst $ mconcat $ map First [updBoth, updOuter, updInner])
136−
137−instance MonadSample (Pure t) ((->) t) where
138−
139− sample :: Behavior (Pure t) a -> (t -> a)
140− sample = unBehavior
141−
142−instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
143−
144− hold :: a -> Event (Pure t) a -> t -> Behavior (Pure t) a
145− hold initialValue e initialTime = Behavior f
146− where f = memo $ \sampleTime ->
147− -- Really, the sampleTime should never be prior to the initialTime,
148− -- because that would mean the Behavior is being sampled before
149− -- being created.
150− if sampleTime <= initialTime
151− then initialValue
152− else let lastTime = pred sampleTime
153− in fromMaybe (f lastTime) $ unEvent e lastTime
154−
155− holdDyn :: a -> Event (Pure t) a -> t -> Dynamic (Pure t) a
156− holdDyn initialValue e initialTime =
157− let Behavior f = hold initialValue e initialTime
158− in Dynamic $ \t -> (f t, unEvent e t)
159−
160− holdIncremental :: Patch p => PatchTarget p -> Event (Pure t) p -> t -> Incremental (Pure t) p
161− holdIncremental initialValue e initialTime = Incremental $ \t -> (f t, unEvent e t)
162− where f = memo $ \sampleTime ->
163− -- Really, the sampleTime should never be prior to the initialTime,
164− -- because that would mean the Behavior is being sampled before
165− -- being created.
166− if sampleTime <= initialTime
167− then initialValue
168− else let lastTime = pred sampleTime
169− lastValue = f lastTime
170− in case unEvent e lastTime of
171− Nothing -> lastValue
172− Just x -> fromMaybe lastValue $ apply x lastValue
src/Reflex/Spider.hsdeleted−16
@@ -1,16 +0,0 @@
1−-- | This module exports all of the user-facing functionality of the 'Spider'
2−-- 'Reflex' engine
3−module Reflex.Spider
4− ( Spider
5− , SpiderTimeline
6− , Global
7− , SpiderHost
8− , runSpiderHost
9− , runSpiderHostForTimeline
10− , newSpiderTimeline
11− , withSpiderTimeline
12− -- * Deprecated
13− , SpiderEnv
14− ) where
15−
16−import Reflex.Spider.Internal
src/Reflex/Spider/Internal.hsdeleted−2165
@@ -1,2165 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE ConstraintKinds #-}
4−{-# LANGUAGE EmptyDataDecls #-}
5−{-# LANGUAGE FlexibleContexts #-}
6−{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE GADTs #-}
9−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10−{-# LANGUAGE LambdaCase #-}
11−{-# LANGUAGE MagicHash #-}
12−{-# LANGUAGE MultiParamTypeClasses #-}
13−{-# LANGUAGE MultiWayIf #-}
14−{-# LANGUAGE RankNTypes #-}
15−{-# LANGUAGE RoleAnnotations #-}
16−{-# LANGUAGE ScopedTypeVariables #-}
17−{-# LANGUAGE TypeFamilies #-}
18−{-# LANGUAGE TypeOperators #-}
19−{-# LANGUAGE UndecidableInstances #-}
20−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
21−-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
22−-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
23−module Reflex.Spider.Internal where
24−
25−import Control.Applicative
26−import Control.Concurrent
27−import Control.Exception
28−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
29−import Control.Monad.Exception
30−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
31−import Control.Monad.Primitive
32−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
33−import Control.Monad.Ref
34−import Data.Align
35−import Data.Coerce
36−import Data.Dependent.Map (DMap, DSum (..))
37−import qualified Data.Dependent.Map as DMap
38−import Data.Foldable hiding (concat, elem, sequence_)
39−import Data.Function
40−import Data.Functor.Constant
41−import Data.Functor.Product
42−import Data.GADT.Compare
43−import Data.IntMap.Strict (IntMap)
44−import qualified Data.IntMap.Strict as IntMap
45−import Data.IORef
46−import Data.List hiding (foldl')
47−import Data.Maybe
48−import Data.Monoid ((<>))
49−import Data.Proxy
50−import Data.Some (Some)
51−import qualified Data.Some as Some
52−import Data.These
53−import Data.Traversable
54−import Data.Type.Coercion
55−import Data.Word
56−import GHC.Exts
57−import GHC.IORef (IORef (..))
58−import GHC.Stack
59−import System.IO.Unsafe
60−import System.Mem.Weak
61−import Unsafe.Coerce
62−
63−#ifdef DEBUG_CYCLES
64−import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
65−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
66−import qualified Data.List.NonEmpty as NonEmpty
67−import Data.Monoid (mempty)
68−import Data.Tree (Forest, Tree (..), drawForest)
69−#endif
70−
71−import Data.WeakBag (WeakBag, WeakBagTicket)
72−import qualified Data.WeakBag as WeakBag
73−import qualified Reflex.Class as R
74−import qualified Reflex.Host.Class as R
75−
76−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
77−import Prelude hiding (any, concat, mapM, mapM_, sequence)
78−
79−debugPropagate :: Bool
80−
81−debugInvalidateHeight :: Bool
82−
83−debugInvalidate :: Bool
84−
85−#ifdef DEBUG
86−
87−#define DEBUG_NODEIDS
88−
89−debugPropagate = True
90−
91−debugInvalidateHeight = False
92−
93−debugInvalidate = True
94−
95−class HasNodeId a where
96− getNodeId :: a -> Int
97−
98−instance HasNodeId (Hold x p a) where
99− getNodeId = holdNodeId
100−
101−instance HasNodeId (PushSubscribed x a b) where
102− getNodeId = pushSubscribedNodeId
103−
104−instance HasNodeId (SwitchSubscribed x a) where
105− getNodeId = switchSubscribedNodeId
106−
107−instance HasNodeId (FanSubscribed x a) where
108− getNodeId = fanSubscribedNodeId
109−
110−instance HasNodeId (CoincidenceSubscribed x a) where
111− getNodeId = coincidenceSubscribedNodeId
112−
113−instance HasNodeId (RootSubscribed x a) where
114− getNodeId = rootSubscribedNodeId
115−
116−instance HasNodeId (Pull x a) where
117− getNodeId = pullNodeId
118−
119−{-# INLINE showNodeId #-}
120−showNodeId :: HasNodeId a => a -> String
121−showNodeId = ("#"<>) . show . getNodeId
122−
123−showSubscriberType :: Subscriber x a -> String
124−showSubscriberType = \case
125− SubscriberPush _ _ -> "SubscriberPush"
126− SubscriberMerge _ _ -> "SubscriberMerge"
127− SubscriberFan _ -> "SubscriberFan"
128− SubscriberMergeChange _ -> "SubscriberMergeChange"
129− SubscriberHold _ -> "SubscriberHold"
130− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
131− SubscriberSwitch _ -> "SubscriberSwitch"
132− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
133− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
134− SubscriberHandle -> "SubscriberHandle"
135−
136−showEventType :: Event x a -> String
137−showEventType = \case
138− EventRoot _ _ -> "EventRoot"
139− EventNever -> "EventNever"
140− EventPush _ -> "EventPush"
141− EventMerge _ -> "EventMerge"
142− EventFan _ _ -> "EventFan"
143− EventSwitch _ -> "EventSwitch"
144− EventCoincidence _ -> "EventCoincidence"
145− EventHold _ -> "EventHold"
146− EventDyn _ -> "EventDyn"
147− EventHoldIdentity _ -> "EventHoldIdentity"
148− EventDynIdentity _ -> "EventDynIdentity"
149−
150−#else
151−
152−debugPropagate = False
153−
154−debugInvalidateHeight = False
155−
156−debugInvalidate = False
157−
158−-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
159−{-# INLINE showNodeId #-}
160−showNodeId :: a -> String
161−showNodeId _ = ""
162−
163−#endif
164−
165−#ifdef DEBUG_NODEIDS
166−{-# NOINLINE nextNodeIdRef #-}
167−nextNodeIdRef :: IORef Int
168−nextNodeIdRef = unsafePerformIO $ newIORef 1
169−
170−newNodeId :: IO Int
171−newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
172−
173−{-# NOINLINE unsafeNodeId #-}
174−unsafeNodeId :: a -> Int
175−unsafeNodeId a = unsafePerformIO $ do
176− touch a
177− newNodeId
178−#endif
179−
180−--------------------------------------------------------------------------------
181−-- Event
182−--------------------------------------------------------------------------------
183−
184−newtype Event x a = Event { unEvent :: Subscriber x a -> EventM x (EventSubscription x, Maybe a) }
185−
186−{-# INLINE subscribeAndRead #-}
187−subscribeAndRead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
188−subscribeAndRead = unEvent
189−
190−{-# RULES "pushCheap/cacheEvent" forall f e. pushCheap f (cacheEvent e) = pushCheap f e #-}
191−{-# RULES "hold/cacheEvent" forall f e. hold f (cacheEvent e) = hold f e #-}
192−{- RULES
193− "subscribeAndRead/cacheEvent" forall e. subscribeAndRead (cacheEvent e) = subscribeAndRead e
194− #-}
195−
196−-- | Construct an 'Event' equivalent to that constructed by 'push', but with no
197−-- caching; if the computation function is very cheap, this is (much) more
198−-- efficient than 'push'
199−{- INLINABLE pushCheap #-}
200−{-# INLINE [1] pushCheap #-}
201−pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
202−pushCheap f e = Event $ \sub -> do
203− (subscription, occ) <- subscribeAndRead e $ sub
204− { subscriberPropagate = \a -> do
205− mb <- runComputeM $ f a
206− mapM_ (subscriberPropagate sub) mb
207− }
208− occ' <- join <$> mapM (runComputeM . f) occ
209− return (subscription, occ')
210−
211−data CacheSubscribed x a
212− = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(WeakBag (Subscriber x a))
213− , _cacheSubscribed_weakSelf :: {-# UNPACK #-} !(IORef (Weak (CacheSubscribed x a)))
214− , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
215− , _cacheSubscribed_cached :: {-# UNPACK #-} !(IORef (Maybe (CacheSubscribed x a)))
216− , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
217− }
218−
219−-- | Construct an 'Event' whose value is guaranteed not to be recomputed
220−-- repeatedly
221−--
222−--TODO: Try a caching strategy where we subscribe directly to the parent when
223−--there's only one subscriber, and then build our own WeakBag only when a second
224−--subscriber joins
225−{-# NOINLINE [1] cacheEvent #-}
226−cacheEvent :: HasSpiderTimeline x => Event x a -> Event x a
227−cacheEvent e = Event $ \sub -> {-# SCC "cacheEvent" #-} do
228− let !mSubscribedRef = unsafeNewIORef e Nothing
229− mSubscribed <- liftIO $ readIORef mSubscribedRef
230− case mSubscribed of
231− Just subscribed -> liftIO $ do
232− ticket <- WeakBag.insert sub (_cacheSubscribed_subscribers subscribed) (_cacheSubscribed_weakSelf subscribed) cleanupCacheSubscribed
233− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
234− let es = EventSubscribed
235− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
236− , eventSubscribedRetained = toAny subscribed
237− }
238− return (EventSubscription (WeakBag.remove ticket >> touch ticket) es, occ)
239− Nothing -> do
240− weakSelf <- liftIO $ newIORef $ error "cacheEvent: weakSelf not yet intialized"
241− (subscribers, ticket) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCacheSubscribed
242− occRef <- liftIO $ newIORef undefined
243− (parentSub, occ) <- subscribeAndRead e $ Subscriber
244− { subscriberPropagate = \a -> do
245− liftIO $ writeIORef occRef $ Just a
246− scheduleClear occRef
247− propagate a subscribers
248− , subscriberInvalidateHeight = \old -> do
249− WeakBag.traverse subscribers $ invalidateSubscriberHeight old
250− , subscriberRecalculateHeight = \new -> do
251− WeakBag.traverse subscribers $ recalculateSubscriberHeight new
252− }
253− liftIO $ writeIORef occRef occ
254− when (isJust occ) $ scheduleClear occRef
255− let !subscribed = CacheSubscribed
256− { _cacheSubscribed_subscribers = subscribers
257− , _cacheSubscribed_weakSelf = weakSelf
258− , _cacheSubscribed_parent = parentSub
259− , _cacheSubscribed_cached = mSubscribedRef
260− , _cacheSubscribed_occurrence = occRef
261− }
262− liftIO $ writeIORef mSubscribedRef $ Just subscribed
263− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "PushSubscribed"
264− return (EventSubscription (WeakBag.remove ticket >> touch ticket) (EventSubscribed (eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub) (toAny subscribed)), occ)
265−
266−cleanupCacheSubscribed :: CacheSubscribed x a -> IO ()
267−cleanupCacheSubscribed self = do
268− unsubscribe $ _cacheSubscribed_parent self
269− writeIORef (_cacheSubscribed_cached self) Nothing
270−
271−subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
272−subscribe e s = fst <$> subscribeAndRead e s
273−
274−{-# INLINE wrap #-}
275−wrap :: MonadIO m => (t -> EventSubscribed x) -> (Subscriber x a -> m (WeakBagTicket, t, Maybe a)) -> Subscriber x a -> m (EventSubscription x, Maybe a)
276−wrap tag getSpecificSubscribed sub = do
277− (sln, subd, occ) <- getSpecificSubscribed sub
278− let es = tag subd
279− return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
280−
281−eventRoot :: GCompare k => k a -> Root x k -> Event x a
282−eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
283−
284−eventNever :: Event x a
285−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
286−
287−eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k -> Event x a
288−eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
289−
290−eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
291−eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
292−
293−eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
294−eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
295−
296−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
297−eventHold !h = Event $ subscribeHoldEvent h
298−
299−eventDyn :: (HasSpiderTimeline x, R.Patch p) => Dyn x p -> Event x p
300−eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
301−
302−{-# INLINE subscribeCoincidenceInner #-}
303−subscribeCoincidenceInner :: CanSubscribe x m => Event x a -> Height -> CoincidenceSubscribed x a -> m (Maybe a, Height, EventSubscribed x)
304−subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
305− subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
306− (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
307− innerHeight <- liftIO $ getEventSubscribedHeight innerSubd
308− let height = max innerHeight outerHeight
309− defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
310− return (innerOcc, height, innerSubd)
311−
312−--------------------------------------------------------------------------------
313−-- Subscriber
314−--------------------------------------------------------------------------------
315−
316−data Subscriber x a = Subscriber
317− { subscriberPropagate :: !(a -> EventM x ())
318− , subscriberInvalidateHeight :: !(Height -> IO ())
319− , subscriberRecalculateHeight :: !(Height -> IO ())
320− }
321−
322−--TODO: Move this comment to WeakBag
323−-- These function are constructor functions that are marked NOINLINE so they are
324−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
325−-- so any weak references that are attached to the constructors will have their
326−-- finalizer run. Using the opaque constructor, does not see the
327−-- constructor application, so it behaves like an IORef and cannot be fused away.
328−--
329−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
330−-- the weak pointer to it in some cases.
331−
332−newSubscriberHold :: (HasSpiderTimeline x, R.Patch p) => Hold x p -> IO (Subscriber x p)
333−newSubscriberHold h = return $ Subscriber
334− { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
335− , subscriberInvalidateHeight = \_ -> return ()
336− , subscriberRecalculateHeight = \_ -> return ()
337− }
338−
339−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
340−newSubscriberFan subscribed = return $ Subscriber
341− { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
342− subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
343− tracePropagate (Proxy :: Proxy x) $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
344− liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
345− scheduleClear $ fanSubscribedOccurrence subscribed
346− let f _ (Pair (Identity v) subsubs) = do
347− propagate v $ _fanSubscribedChildren_list subsubs
348− return $ Constant ()
349− _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
350− return ()
351− , subscriberInvalidateHeight = \old -> do
352− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
353− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
354− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
355− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
356− , subscriberRecalculateHeight = \new -> do
357− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
358− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
359− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
360− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
361− }
362−
363−newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
364−newSubscriberSwitch subscribed = return $ Subscriber
365− { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
366− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
367− liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
368− scheduleClear $ switchSubscribedOccurrence subscribed
369− propagate a $ switchSubscribedSubscribers subscribed
370− , subscriberInvalidateHeight = \_ -> do
371− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
372− oldHeight <- readIORef $ switchSubscribedHeight subscribed
373− when (oldHeight /= invalidHeight) $ do
374− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
375− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
376− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
377− , subscriberRecalculateHeight = \new -> do
378− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
379− updateSwitchHeight new subscribed
380− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
381− }
382−
383−newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
384−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
385− { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
386− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
387− outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
388− tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
389− (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
390− tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
391− tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
392− liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
393− scheduleClear $ coincidenceSubscribedInnerParent subscribed
394− case occ of
395− Nothing -> do
396− when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
397− writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
398− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
399− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
400− Just o -> do -- Since it's already firing, no need to adjust height
401− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
402− scheduleClear $ coincidenceSubscribedOccurrence subscribed
403− propagate o $ coincidenceSubscribedSubscribers subscribed
404− , subscriberInvalidateHeight = \_ -> do
405− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
406− invalidateCoincidenceHeight subscribed
407− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
408− , subscriberRecalculateHeight = \_ -> do
409− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
410− recalculateCoincidenceHeight subscribed
411− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
412− }
413−
414−newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
415−newSubscriberCoincidenceInner subscribed = return $ Subscriber
416− { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
417− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
418− occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
419− case occ of
420− Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
421− Nothing -> do
422− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
423− scheduleClear $ coincidenceSubscribedOccurrence subscribed
424− propagate a $ coincidenceSubscribedSubscribers subscribed
425− , subscriberInvalidateHeight = \_ -> do
426− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
427− invalidateCoincidenceHeight subscribed
428− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
429− , subscriberRecalculateHeight = \_ -> do
430− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
431− recalculateCoincidenceHeight subscribed
432− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
433− }
434−
435−invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
436−invalidateSubscriberHeight = flip subscriberInvalidateHeight
437−
438−recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
439−recalculateSubscriberHeight = flip subscriberRecalculateHeight
440−
441−-- | Propagate everything at the current height
442−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
443−propagate a subscribers = withIncreasedDepth $ do
444− -- 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
445− --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
446− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
447−
448−--------------------------------------------------------------------------------
449−-- EventSubscribed
450−--------------------------------------------------------------------------------
451−
452−toAny :: a -> Any
453−toAny = unsafeCoerce
454−
455−data EventSubscribed x = EventSubscribed
456− { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
457− , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
458−#ifdef DEBUG_CYCLES
459− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
460− , eventSubscribedHasOwnHeightRef :: !Bool
461− , eventSubscribedWhoCreated :: !(IO [String])
462−#endif
463− }
464−
465−eventSubscribedRoot :: RootSubscribed x a -> EventSubscribed x
466−eventSubscribedRoot !r = EventSubscribed
467− { eventSubscribedHeightRef = zeroRef
468− , eventSubscribedRetained = toAny r
469−#ifdef DEBUG_CYCLES
470− , eventSubscribedGetParents = return []
471− , eventSubscribedHasOwnHeightRef = False
472− , eventSubscribedWhoCreated = return ["root"]
473−#endif
474− }
475−
476−eventSubscribedNever :: EventSubscribed x
477−eventSubscribedNever = EventSubscribed
478− { eventSubscribedHeightRef = zeroRef
479− , eventSubscribedRetained = toAny ()
480−#ifdef DEBUG_CYCLES
481− , eventSubscribedGetParents = return []
482− , eventSubscribedHasOwnHeightRef = False
483− , eventSubscribedWhoCreated = return ["never"]
484−#endif
485− }
486−
487−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
488−eventSubscribedFan !subscribed = EventSubscribed
489− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
490− , eventSubscribedRetained = toAny subscribed
491−#ifdef DEBUG_CYCLES
492− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
493− , eventSubscribedHasOwnHeightRef = False
494− , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
495−#endif
496− }
497−
498−eventSubscribedSwitch :: SwitchSubscribed x a -> EventSubscribed x
499−eventSubscribedSwitch !subscribed = EventSubscribed
500− { eventSubscribedHeightRef = switchSubscribedHeight subscribed
501− , eventSubscribedRetained = toAny subscribed
502−#ifdef DEBUG_CYCLES
503− , eventSubscribedGetParents = do
504− s <- readIORef $ switchSubscribedCurrentParent subscribed
505− return [Some.This $ _eventSubscription_subscribed s]
506− , eventSubscribedHasOwnHeightRef = True
507− , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
508−#endif
509− }
510−
511−eventSubscribedCoincidence :: CoincidenceSubscribed x a -> EventSubscribed x
512−eventSubscribedCoincidence !subscribed = EventSubscribed
513− { eventSubscribedHeightRef = coincidenceSubscribedHeight subscribed
514− , eventSubscribedRetained = toAny subscribed
515−#ifdef DEBUG_CYCLES
516− , eventSubscribedGetParents = do
517− innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
518− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
519− innerParents = maybeToList $ fmap Some.This innerSubscription
520− return $ outerParent : innerParents
521− , eventSubscribedHasOwnHeightRef = True
522− , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
523−#endif
524− }
525−
526−getEventSubscribedHeight :: EventSubscribed x -> IO Height
527−getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
528−
529−#ifdef DEBUG_CYCLES
530−whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
531−whoCreatedEventSubscribed = eventSubscribedWhoCreated
532−
533−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
534−walkInvalidHeightParents s0 = do
535− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
536− h <- liftIO $ readIORef $ eventSubscribedHeightRef s
537− when (h == invalidHeight) $ do
538− when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
539− modify (Some.This s :)
540− mapM_ loop =<< liftIO (eventSubscribedGetParents s)
541− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
542− return subscribers
543−#endif
544−
545−{-# INLINE subscribeHoldEvent #-}
546−subscribeHoldEvent :: CanSubscribe x m => Hold x p -> Subscriber x p -> m (EventSubscription x, Maybe p)
547−subscribeHoldEvent = subscribeAndRead . holdEvent
548−
549−--------------------------------------------------------------------------------
550−-- EventSubscription
551−--------------------------------------------------------------------------------
552−
553−data EventSubscription x = EventSubscription
554− { _eventSubscription_unsubscribe :: !(IO ())
555− , _eventSubscription_subscribed :: {-# UNPACK #-} !(EventSubscribed x)
556− }
557−
558−unsubscribe :: EventSubscription x -> IO ()
559−unsubscribe (EventSubscription u _) = u
560−
561−--------------------------------------------------------------------------------
562−-- Behavior
563−--------------------------------------------------------------------------------
564−
565−newtype Behavior x a = Behavior { readBehaviorTracked :: BehaviorM x a }
566−
567−behaviorHold :: Hold x p -> Behavior x (R.PatchTarget p)
568−behaviorHold !h = Behavior $ readHoldTracked h
569−
570−behaviorHoldIdentity :: Hold x (Identity a) -> Behavior x a
571−behaviorHoldIdentity = behaviorHold
572−
573−behaviorConst :: a -> Behavior x a
574−behaviorConst !a = Behavior $ return a
575−
576−behaviorPull :: Pull x a -> Behavior x a
577−behaviorPull !p = Behavior $ do
578− val <- liftIO $ readIORef $ pullValue p
579− case val of
580− Just subscribed -> do
581− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
582− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
583− liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
584− return $ pullSubscribedValue subscribed
585− Nothing -> do
586− i <- liftIO $ newInvalidatorPull p
587− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
588− parentsRef <- liftIO $ newIORef []
589− holdInits <- askBehaviorHoldInits
590− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
591− invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
592− parents <- liftIO $ readIORef parentsRef
593− let subscribed = PullSubscribed
594− { pullSubscribedValue = a
595− , pullSubscribedInvalidators = invsRef
596− , pullSubscribedOwnInvalidator = i
597− , pullSubscribedParents = parents
598− }
599− liftIO $ writeIORef (pullValue p) $ Just subscribed
600− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
601− return a
602−
603−behaviorDyn :: R.Patch p => Dyn x p -> Behavior x (R.PatchTarget p)
604−behaviorDyn !d = Behavior $ readHoldTracked =<< getDynHold d
605−
606−{-# INLINE readHoldTracked #-}
607−readHoldTracked :: Hold x p -> BehaviorM x (R.PatchTarget p)
608−readHoldTracked h = do
609− result <- liftIO $ readIORef $ holdValue h
610− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
611− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
612− return result
613−
614−{-# SPECIALIZE readBehaviorUntracked :: Behavior x a -> BehaviorM x a #-}
615−{-# SPECIALIZE readBehaviorUntracked :: HasSpiderTimeline x => Behavior x a -> EventM x a #-}
616−readBehaviorUntracked :: Defer (SomeHoldInit x) m => Behavior x a -> m a
617−readBehaviorUntracked b = do
618− holdInits <- getDeferralQueue
619− liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
620−
621−--------------------------------------------------------------------------------
622−-- Dynamic
623−--------------------------------------------------------------------------------
624−
625−data Dynamic x p = Dynamic
626− { dynamicCurrent :: !(Behavior x (R.PatchTarget p))
627− , dynamicUpdated :: !(Event x p)
628− }
629−
630−dynamicHold :: HasSpiderTimeline x => Hold x p -> Dynamic x p
631−dynamicHold !h = Dynamic
632− { dynamicCurrent = behaviorHold h
633− , dynamicUpdated = eventHold h
634− }
635−
636−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
637−dynamicHoldIdentity = dynamicHold
638−
639−dynamicConst :: R.PatchTarget p -> Dynamic x p
640−dynamicConst !a = Dynamic
641− { dynamicCurrent = behaviorConst a
642− , dynamicUpdated = eventNever
643− }
644−
645−dynamicDyn :: (HasSpiderTimeline x, R.Patch p) => Dyn x p -> Dynamic x p
646−dynamicDyn !d = Dynamic
647− { dynamicCurrent = behaviorDyn d
648− , dynamicUpdated = eventDyn d
649− }
650−
651−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
652−dynamicDynIdentity = dynamicDyn
653−
654−--------------------------------------------------------------------------------
655−-- Combinators
656−--------------------------------------------------------------------------------
657−
658−--TODO: Figure out why certain things are not 'representational', then make them
659−--representational so we can use coerce
660−
661−--type role Hold representational
662−data Hold x p
663− = Hold { holdValue :: !(IORef (R.PatchTarget p))
664− , holdInvalidators :: !(IORef [Weak (Invalidator x)])
665− , holdEvent :: Event x p -- This must be lazy, or holds cannot be defined before their input Events
666− , holdParent :: !(IORef (Maybe (EventSubscription x))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
667−#ifdef DEBUG_NODEIDS
668− , holdNodeId :: Int
669−#endif
670− }
671−
672−data EventEnv x
673− = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
674− , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
675− , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
676− , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
677− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
678− , eventEnvRootClears :: !(IORef [SomeRootClear])
679− , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
680− , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
681− , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
682− }
683−
684−{-# INLINE runEventM #-}
685−runEventM :: EventM x a -> IO a
686−runEventM = unEventM
687−
688−asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
689−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimeline x)
690−
691−class MonadIO m => Defer a m where
692− getDeferralQueue :: m (IORef [a])
693−
694−{-# INLINE defer #-}
695−defer :: Defer a m => a -> m ()
696−defer a = do
697− q <- getDeferralQueue
698− liftIO $ modifyIORef' q (a:)
699−
700−instance HasSpiderTimeline x => Defer (SomeAssignment x) (EventM x) where
701− {-# INLINE getDeferralQueue #-}
702− getDeferralQueue = asksEventEnv eventEnvAssignments
703−
704−instance HasSpiderTimeline x => Defer (SomeHoldInit x) (EventM x) where
705− {-# INLINE getDeferralQueue #-}
706− getDeferralQueue = asksEventEnv eventEnvHoldInits
707−
708−instance Defer (SomeHoldInit x) (BehaviorM x) where
709− {-# INLINE getDeferralQueue #-}
710− getDeferralQueue = BehaviorM $ asks snd
711−
712−instance HasSpiderTimeline x => Defer (SomeMergeUpdate x) (EventM x) where
713− {-# INLINE getDeferralQueue #-}
714− getDeferralQueue = asksEventEnv eventEnvMergeUpdates
715−
716−instance HasSpiderTimeline x => Defer (SomeMergeInit x) (EventM x) where
717− {-# INLINE getDeferralQueue #-}
718− getDeferralQueue = asksEventEnv eventEnvMergeInits
719−
720−class HasSpiderTimeline x => HasCurrentHeight x m | m -> x where
721− getCurrentHeight :: m Height
722− scheduleMerge :: Height -> EventM x () -> m ()
723−
724−instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
725− {-# INLINE getCurrentHeight #-}
726− getCurrentHeight = do
727− heightRef <- asksEventEnv eventEnvCurrentHeight
728− liftIO $ readIORef heightRef
729− {-# INLINE scheduleMerge #-}
730− scheduleMerge height subscribed = do
731− delayedRef <- asksEventEnv eventEnvDelayedMerges
732− liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
733−
734−class HasSpiderTimeline x where
735− -- | Retrieve the current SpiderTimeline
736− spiderTimeline :: SpiderTimeline x
737−
738−instance HasSpiderTimeline Global where
739− spiderTimeline = globalSpiderTimeline
740−
741−putCurrentHeight :: HasSpiderTimeline x => Height -> EventM x ()
742−putCurrentHeight h = do
743− heightRef <- asksEventEnv eventEnvCurrentHeight
744− liftIO $ writeIORef heightRef $! h
745−
746−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
747− {-# INLINE getDeferralQueue #-}
748− getDeferralQueue = asksEventEnv eventEnvClears
749−
750−{-# INLINE scheduleClear #-}
751−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
752−scheduleClear r = defer $ SomeClear r
753−
754−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
755− {-# INLINE getDeferralQueue #-}
756− getDeferralQueue = asksEventEnv eventEnvRootClears
757−
758−{-# INLINE scheduleRootClear #-}
759−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
760−scheduleRootClear r = defer $ SomeRootClear r
761−
762−instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
763− {-# INLINE getDeferralQueue #-}
764− getDeferralQueue = asksEventEnv eventEnvResetCoincidences
765−
766−-- Note: hold cannot examine its event until after the phase is over
767−{- SPECIALIZE hold :: (HasSpiderTimeline x, R.Patch p) => R.PatchTarget p -> Event x p -> EventM x (Hold x p) #-}
768−{-# INLINE [1] hold #-}
769−hold :: (R.Patch p, Defer (SomeHoldInit x) m) => R.PatchTarget p -> Event x p -> m (Hold x p)
770−hold v0 e = do
771− valRef <- liftIO $ newIORef v0
772− invsRef <- liftIO $ newIORef []
773− parentRef <- liftIO $ newIORef Nothing
774−#ifdef DEBUG_NODEIDS
775− nodeId <- liftIO newNodeId
776−#endif
777− let h = Hold
778− { holdValue = valRef
779− , holdInvalidators = invsRef
780− , holdEvent = e
781− , holdParent = parentRef
782−#ifdef DEBUG_NODEIDS
783− , holdNodeId = nodeId
784−#endif
785− }
786− defer $ SomeHoldInit h
787− return h
788−
789−{-# INLINE getHoldEventSubscription #-}
790−getHoldEventSubscription :: forall m p x. (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer SomeClear m, R.Patch p, HasCurrentHeight x m, Defer (SomeMergeInit x) m, Defer (SomeResetCoincidence x) m, HasSpiderTimeline x, m ~ EventM x) => Hold x p -> m (EventSubscription x)
791−getHoldEventSubscription h = do
792− ep <- liftIO $ readIORef $ holdParent h
793− case ep of
794− Just subd -> return subd
795− Nothing -> do
796− let e = holdEvent h
797− subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
798− (subscription@(EventSubscription _ _), occ) <- subscribeAndRead e =<< liftIO (newSubscriberHold h)
799− liftIO $ writeIORef subscriptionRef $! subscription
800− case occ of
801− Nothing -> return ()
802− Just o -> do
803− old <- liftIO $ readIORef $ holdValue h
804− case R.apply o old of
805− Nothing -> return ()
806− Just new -> do
807− -- Need to evaluate these so that we don't retain the Hold itself
808− v <- liftIO $ evaluate $ holdValue h
809− i <- liftIO $ evaluate $ holdInvalidators h
810− defer $ SomeAssignment v i new
811− liftIO $ writeIORef (holdParent h) $ Just subscription
812− return subscription
813−
814−type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
815−
816−--type role BehaviorM representational
817−-- BehaviorM can sample behaviors
818−newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderT (BehaviorEnv x) IO a } deriving (Functor, Applicative, MonadIO, MonadFix)
819−
820−instance Monad (BehaviorM x) where
821− {-# INLINE (>>=) #-}
822− BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
823− {-# INLINE (>>) #-}
824− BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
825− {-# INLINE return #-}
826− return x = BehaviorM $ return x
827− {-# INLINE fail #-}
828− fail s = BehaviorM $ fail s
829−
830−data BehaviorSubscribed x a
831− = forall p. BehaviorSubscribedHold (Hold x p)
832− | BehaviorSubscribedPull (PullSubscribed x a)
833−
834−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
835−
836−--type role PullSubscribed representational
837−data PullSubscribed x a
838− = PullSubscribed { pullSubscribedValue :: !a
839− , pullSubscribedInvalidators :: !(IORef [Weak (Invalidator x)])
840− , pullSubscribedOwnInvalidator :: !(Invalidator x)
841− , pullSubscribedParents :: ![SomeBehaviorSubscribed x] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
842− }
843−
844−--type role Pull representational
845−data Pull x a
846− = Pull { pullValue :: !(IORef (Maybe (PullSubscribed x a)))
847− , pullCompute :: !(BehaviorM x a)
848−#ifdef DEBUG_NODEIDS
849− , pullNodeId :: Int
850−#endif
851− }
852−
853−data Invalidator x
854− = forall a. InvalidatorPull (Pull x a)
855− | forall a. InvalidatorSwitch (SwitchSubscribed x a)
856−
857−data RootSubscribed x a = forall k. GCompare k => RootSubscribed
858− { rootSubscribedKey :: !(k a)
859− , rootSubscribedCachedSubscribed :: !(IORef (DMap k (RootSubscribed x))) -- From the original Root
860− , rootSubscribedSubscribers :: !(WeakBag (Subscriber x a))
861− , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
862− , rootSubscribedUninit :: IO ()
863− , rootSubscribedWeakSelf :: !(IORef (Weak (RootSubscribed x a))) --TODO: Can we make this a lazy non-IORef and then force it manually to avoid an indirection each time we use it?
864−#ifdef DEBUG_NODEIDS
865− , rootSubscribedNodeId :: Int
866−#endif
867− }
868−
869−data Root x (k :: * -> *)
870− = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
871− , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
872− , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
873− }
874−
875−data SomeHoldInit x = forall p. R.Patch p => SomeHoldInit !(Hold x p)
876−
877−data SomeMergeUpdate x = SomeMergeUpdate
878− { _someMergeUpdate_update :: !(EventM x [EventSubscription x])
879− , _someMergeUpdate_invalidateHeight :: !(IO ())
880− , _someMergeUpdate_recalculateHeight :: !(IO ())
881− }
882−
883−newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
884−
885−-- EventM can do everything BehaviorM can, plus create holds
886−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
887−
888−newtype ComputeM x a = ComputeM (ReaderT (IORef [SomeHoldInit x]) IO a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
889−
890−instance Defer (SomeHoldInit x) (ComputeM x) where
891− getDeferralQueue = ComputeM ask
892−
893−{-# SPECIALIZE runComputeM :: HasSpiderTimeline x => ComputeM x a -> EventM x a #-}
894−runComputeM :: Defer (SomeHoldInit x) m => ComputeM x a -> m a
895−runComputeM (ComputeM a) = liftIO . runReaderT a =<< getDeferralQueue
896−
897−newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
898−
899−data HeightBag = HeightBag
900− { _heightBag_size :: {-# UNPACK #-} !Int
901− , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
902− }
903− deriving (Show, Read, Eq, Ord)
904−
905−heightBagEmpty :: HeightBag
906−heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
907−
908−heightBagSize :: HeightBag -> Int
909−heightBagSize = _heightBag_size
910−
911−heightBagFromList :: [Height] -> HeightBag
912−heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
913−
914−heightBagAdd :: Height -> HeightBag -> HeightBag
915−heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
916−
917−heightBagRemove :: Height -> HeightBag -> HeightBag
918−heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
919− Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
920− Just old -> HeightBag (pred s) $ case old of
921− 0 -> IntMap.delete h c
922− _ -> IntMap.insert h (pred old) c
923−
924−heightBagMax :: HeightBag -> Height
925−heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
926− Just ((h, _), _) -> Height h
927− Nothing -> zeroHeight
928−
929−heightBagVerify :: HeightBag -> HeightBag
930−#ifdef DEBUG
931−heightBagVerify b@(HeightBag s c) = if
932− | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
933− -> error $ "heightBagVerify: size doesn't match: " <> show b
934− | unHeight invalidHeight `IntMap.member` c
935− -> error $ "heightBagVerify: contains invalid height: " <> show b
936− | otherwise -> b
937−#else
938−heightBagVerify = id
939−#endif
940−
941−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
942− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
943− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
944− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
945− }
946−
947−data FanSubscribed (x :: *) k
948− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
949− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
950− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
951− , fanSubscribedParent :: !(EventSubscription x)
952−#ifdef DEBUG_NODEIDS
953− , fanSubscribedNodeId :: Int
954−#endif
955− }
956−
957−data Fan x k
958− = Fan { fanParent :: !(Event x (DMap k Identity))
959− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
960− }
961−
962−data SwitchSubscribed x a
963− = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
964− , switchSubscribedOccurrence :: !(IORef (Maybe a))
965− , switchSubscribedHeight :: !(IORef Height)
966− , switchSubscribedSubscribers :: !(WeakBag (Subscriber x a))
967− , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !(Invalidator x)
968− , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak (Invalidator x)))
969− , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed x])
970− , switchSubscribedParent :: !(Behavior x (Event x a))
971− , switchSubscribedCurrentParent :: !(IORef (EventSubscription x))
972− , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed x a)))
973−#ifdef DEBUG_NODEIDS
974− , switchSubscribedNodeId :: Int
975−#endif
976− }
977−
978−data Switch x a
979− = Switch { switchParent :: !(Behavior x (Event x a))
980− , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
981− }
982−
983−{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
984−data CoincidenceSubscribed x a
985− = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
986− , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
987− , coincidenceSubscribedSubscribers :: !(WeakBag (Subscriber x a))
988− , coincidenceSubscribedHeight :: !(IORef Height)
989− , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber x (Event x a))
990− , coincidenceSubscribedOuterParent :: !(EventSubscription x)
991− , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed x)))
992− , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed x a)))
993−#ifdef DEBUG_NODEIDS
994− , coincidenceSubscribedNodeId :: Int
995−#endif
996− }
997−
998−data Coincidence x a
999− = Coincidence { coincidenceParent :: !(Event x (Event x a))
1000− , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
1001− }
1002−
1003−{-# NOINLINE newInvalidatorSwitch #-}
1004−newInvalidatorSwitch :: SwitchSubscribed x a -> IO (Invalidator x)
1005−newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
1006−
1007−{-# NOINLINE newInvalidatorPull #-}
1008−newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1009−newInvalidatorPull p = return $! InvalidatorPull p
1010−
1011−instance HasSpiderTimeline x => R.FunctorMaybe (Event x) where
1012− fmapMaybe f = push $ return . f
1013−
1014−instance HasSpiderTimeline x => Align (Event x) where
1015− nil = eventNever
1016− align ea eb = R.fmapMaybe R.dmapToThese $ merge $ dynamicConst $ DMap.fromList [R.LeftTag :=> ea, R.RightTag :=> eb]
1017−
1018−newtype Dyn x p = Dyn { unDyn :: IORef (Either (BehaviorM x (R.PatchTarget p), Event x p) (Hold x p)) }
1019−
1020−newMapDyn :: HasSpiderTimeline x => (a -> b) -> Dynamic x (Identity a) -> Dynamic x (Identity b)
1021−newMapDyn f d = dynamicDynIdentity $ unsafeDyn (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1022−
1023−--TODO: Avoid the duplication between this and R.zipDynWith
1024−zipDynWith :: HasSpiderTimeline x => (a -> b -> c) -> Dynamic x (Identity a) -> Dynamic x (Identity b) -> Dynamic x (Identity c)
1025−zipDynWith f da db =
1026− let eab = align (dynamicUpdated da) (dynamicUpdated db)
1027− ec = flip push eab $ \o -> do
1028− (a, b) <- case o of
1029− This (Identity a) -> do
1030− b <- readBehaviorUntracked $ dynamicCurrent db
1031− return (a, b)
1032− That (Identity b) -> do
1033− a <- readBehaviorUntracked $ dynamicCurrent da
1034− return (a, b)
1035− These (Identity a) (Identity b) -> return (a, b)
1036− return $ Just $ Identity $ f a b
1037− in dynamicDynIdentity $ unsafeDyn (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1038−
1039−unsafeDyn :: BehaviorM x (R.PatchTarget p) -> Event x p -> Dyn x p
1040−unsafeDyn readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1041− where x = (readV0, v')
1042−
1043−newJoinDyn :: HasSpiderTimeline x => Dynamic x (Identity (Dynamic x (Identity a))) -> Dyn x (Identity a)
1044−newJoinDyn d =
1045− let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
1046− eOuter = push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
1047− eInner = switch $ dynamicUpdated <$> dynamicCurrent d
1048− eBoth = coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
1049− v' = unSpiderEvent $ R.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
1050− in unsafeDyn readV0 v'
1051−
1052−-- ResultM can read behaviors and events
1053−type ResultM = EventM
1054−
1055−{-# NOINLINE unsafeNewIORef #-}
1056−unsafeNewIORef :: a -> b -> IORef b
1057−unsafeNewIORef _ b = unsafePerformIO $ newIORef b
1058−
1059−instance HasSpiderTimeline x => Functor (Event x) where
1060− fmap f = push $ return . Just . f
1061−
1062−instance Functor (Behavior x) where
1063− fmap f = pull . fmap f . readBehaviorTracked
1064−
1065−{-# INLINE push #-}
1066−push :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
1067−push f e = cacheEvent (pushCheap f e)
1068−
1069−{-# INLINABLE pull #-}
1070−pull :: BehaviorM x a -> Behavior x a
1071−pull a = behaviorPull $ Pull
1072− { pullCompute = a
1073− , pullValue = unsafeNewIORef a Nothing
1074−#ifdef DEBUG_NODEIDS
1075− , pullNodeId = unsafeNodeId a
1076−#endif
1077− }
1078−
1079−{-# INLINABLE switch #-}
1080−switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1081−switch a = eventSwitch $ Switch
1082− { switchParent = a
1083− , switchSubscribed = unsafeNewIORef a Nothing
1084− }
1085−
1086−coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1087−coincidence a = eventCoincidence $ Coincidence
1088− { coincidenceParent = a
1089− , coincidenceSubscribed = unsafeNewIORef a Nothing
1090− }
1091−
1092−-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1093−run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1094−run roots after = do
1095− tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1096− t <- SpiderHost ask
1097− result <- SpiderHost $ lift $ withMVar (_spiderTimeline_lock t) $ \_ -> flip runReaderT t $ unSpiderHost $ runFrame $ do
1098− rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1099− occBefore <- liftIO $ do
1100− occBefore <- readIORef occRef
1101− writeIORef occRef $! DMap.insert k a occBefore
1102− return occBefore
1103− if DMap.null occBefore
1104− then do scheduleRootClear occRef
1105− return $ Just r
1106− else return Nothing
1107− forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
1108− propagate a subscribersRef
1109− delayedRef <- asksEventEnv eventEnvDelayedMerges
1110− let go = do
1111− delayed <- liftIO $ readIORef delayedRef
1112− case IntMap.minViewWithKey delayed of
1113− Nothing -> return ()
1114− Just ((currentHeight, cur), future) -> do
1115− tracePropagate (Proxy :: Proxy x) $ "Running height " ++ show currentHeight
1116− putCurrentHeight $ Height currentHeight
1117− liftIO $ writeIORef delayedRef $! future
1118− sequence_ cur
1119− go
1120− go
1121− putCurrentHeight maxBound
1122− after
1123− tracePropagate (Proxy :: Proxy x) "Done running an event frame"
1124− return result
1125−
1126−scheduleMerge' :: HasSpiderTimeline x => Height -> IORef Height -> EventM x () -> EventM x ()
1127−scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1128− height <- liftIO $ readIORef heightRef
1129− currentHeight <- getCurrentHeight
1130− case height `compare` currentHeight of
1131− LT -> error "Somehow a merge's height has been decreased after it was scheduled"
1132− GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1133− EQ -> a
1134−
1135−data SomeClear = forall a. SomeClear (IORef (Maybe a))
1136−
1137−data SomeRootClear = forall k. SomeRootClear (IORef (DMap k Identity))
1138−
1139−data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1140−
1141−debugFinalize :: Bool
1142−debugFinalize = False
1143−
1144−mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
1145−mkWeakPtrWithDebug x debugNote = do
1146− x' <- evaluate x
1147− mkWeakPtr x' $
1148− if debugFinalize
1149− then Just $ putStrLn $ "finalizing: " ++ debugNote
1150− else Nothing
1151−
1152−type WeakList a = [Weak a]
1153−
1154−{-# INLINE withIncreasedDepth #-}
1155−#ifdef DEBUG
1156−withIncreasedDepth :: CanTrace x m => m a -> m a
1157−withIncreasedDepth a = do
1158− spiderTimeline <- askSpiderTimeline
1159− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
1160− result <- a
1161− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1162− return result
1163−#else
1164−withIncreasedDepth :: m a -> m a
1165−withIncreasedDepth = id
1166−#endif
1167−
1168−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1169−
1170−{-# INLINE tracePropagate #-}
1171−tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1172−tracePropagate p = traceWhen p debugPropagate
1173−
1174−{-# INLINE traceInvalidate #-}
1175−traceInvalidate :: String -> IO ()
1176−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1177−
1178−{-# INLINE traceWhen #-}
1179−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1180−traceWhen p b message = traceMWhen p b $ return message
1181−
1182−{-# INLINE traceMWhen #-}
1183−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1184−traceMWhen _ b getMessage = when b $ do
1185− message <- getMessage
1186−#ifdef DEBUG
1187− spiderTimeline <- askSpiderTimeline
1188− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1189−#else
1190− let d = 0
1191−#endif
1192− liftIO $ putStrLn $ replicate d ' ' <> message
1193−
1194−whoCreatedIORef :: IORef a -> IO [String]
1195−whoCreatedIORef (IORef a) = whoCreated $! a
1196−
1197−#ifdef DEBUG_CYCLES
1198−groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1199−groupByHead = \case
1200− [] -> []
1201− (x :| xs) : t -> case groupByHead t of
1202− [] -> [(x, xs :| [])]
1203− l@((y, yss) : t')
1204− | x == y -> (x, xs `NonEmpty.cons` yss) : t'
1205− | otherwise -> (x, xs :| []) : l
1206−
1207−listsToForest :: Eq a => [[a]] -> Forest a
1208−listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
1209−#endif
1210−
1211−{-# INLINE propagateSubscriberHold #-}
1212−propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, R.Patch p) => Hold x p -> p -> EventM x ()
1213−propagateSubscriberHold h a = do
1214− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1215− invalidators <- liftIO $ readIORef $ holdInvalidators h
1216− return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1217− v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1218− case {-# SCC "apply" #-} R.apply a v of
1219− Nothing -> return ()
1220− Just v' -> do
1221− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1222− vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1223− iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1224− defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1225−
1226−data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1227−
1228−runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1229−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1230−
1231−askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1232−askInvalidator = do
1233− (!m, _) <- BehaviorM ask
1234− case m of
1235− Nothing -> return Nothing
1236− Just (!wi, _) -> return $ Just wi
1237−
1238−askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1239−askParentsRef = do
1240− (!m, _) <- BehaviorM ask
1241− case m of
1242− Nothing -> return Nothing
1243− Just (_, !p) -> return $ Just p
1244−
1245−askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1246−askBehaviorHoldInits = do
1247− (_, !his) <- BehaviorM ask
1248− return his
1249−
1250−{-# INLINE getDynHold #-}
1251−getDynHold :: (Defer (SomeHoldInit x) m, R.Patch p) => Dyn x p -> m (Hold x p)
1252−getDynHold d = do
1253− mh <- liftIO $ readIORef $ unDyn d
1254− case mh of
1255− Right h -> return h
1256− Left (readV0, v') -> do
1257− holdInits <- getDeferralQueue
1258− v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1259− h <- hold v0 v'
1260− liftIO $ writeIORef (unDyn d) $ Right h
1261− return h
1262−
1263−-- Always refers to 0
1264−{-# NOINLINE zeroRef #-}
1265−zeroRef :: IORef Height
1266−zeroRef = unsafePerformIO $ newIORef zeroHeight
1267−
1268−type CanSubscribe x m =
1269− ( HasSpiderTimeline x
1270− , HasCurrentHeight x m
1271− , Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m -- The things we need to lazily initialize state
1272− , Defer SomeClear m -- Wiping out event firings
1273− , Defer (SomeAssignment x) m -- Updating state
1274− , Defer (SomeResetCoincidence x) m
1275− , m ~ EventM x
1276− )
1277−
1278−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1279−getRootSubscribed k r sub = do
1280− mSubscribed <- readIORef $ rootSubscribed r
1281− let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1282− case DMap.lookup k mSubscribed of
1283− Just subscribed -> {-# SCC "hitRoot" #-} do
1284− sln <- subscribeRootSubscribed subscribed sub
1285− occ <- getOcc
1286− return (sln, subscribed, occ)
1287− Nothing -> {-# SCC "missRoot" #-} do
1288− weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1289− let !cached = rootSubscribed r
1290− uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1291− (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1292− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1293− uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1294− writeIORef uninitRef $! uninit
1295− let subscribed = RootSubscribed
1296− { rootSubscribedKey = k
1297− , rootSubscribedCachedSubscribed = cached
1298− , rootSubscribedOccurrence = getOcc
1299− , rootSubscribedSubscribers = subs
1300− , rootSubscribedUninit = uninit
1301− , rootSubscribedWeakSelf = weakSelf
1302−#ifdef DEBUG_NODEIDS
1303− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1304−#endif
1305− }
1306− writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "RootSubscribed"
1307− modifyIORef' (rootSubscribed r) $ DMap.insertWith (error $ "getRootSubscribed: duplicate key inserted into Root") k subscribed --TODO: I think we can just write back mSubscribed rather than re-reading it
1308− occ <- getOcc
1309− return (sln, subscribed, occ)
1310−
1311−{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1312−cleanupRootSubscribed :: RootSubscribed x a -> IO ()
1313−cleanupRootSubscribed self@(RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached }) = do
1314− rootSubscribedUninit self
1315− modifyIORef' cached $ DMap.delete k
1316−
1317−{-# INLINE subscribeRootSubscribed #-}
1318−subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1319−subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1320−
1321−{-# SPECIALIZE getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k -> Subscriber x a -> EventM x (WeakBagTicket, FanSubscribed x k, Maybe a) #-}
1322−getFanSubscribed :: (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, HasCurrentHeight x m, Defer (SomeResetCoincidence x) m, HasSpiderTimeline x, m ~ EventM x, GCompare k) => k a -> Fan x k -> Subscriber x a -> m (WeakBagTicket, FanSubscribed x k, Maybe a)
1323−getFanSubscribed k f sub = do
1324− mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1325− case mSubscribed of
1326− Just subscribed -> {-# SCC "hitFan" #-} liftIO $ do
1327− sln <- subscribeFanSubscribed k subscribed sub
1328− occ <- readIORef $ fanSubscribedOccurrence subscribed
1329− return (sln, subscribed, coerce $ DMap.lookup k =<< occ)
1330− Nothing -> {-# SCC "missFan" #-} do
1331− subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1332− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1333− s <- liftIO $ newSubscriberFan subscribedUnsafe
1334− (subscription, parentOcc) <- subscribeAndRead (fanParent f) s
1335− weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1336− (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1337− subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1338− occRef <- liftIO $ newIORef parentOcc
1339− when (isJust parentOcc) $ scheduleClear occRef
1340− let subscribed = FanSubscribed
1341− { fanSubscribedCachedSubscribed = fanSubscribed f
1342− , fanSubscribedOccurrence = occRef
1343− , fanSubscribedParent = subscription
1344− , fanSubscribedSubscribers = subscribersRef
1345−#ifdef DEBUG_NODEIDS
1346− , fanSubscribedNodeId = unsafeNodeId f
1347−#endif
1348− }
1349− let !self = (k, subscribed)
1350− liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1351− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1352− liftIO $ writeIORef subscribedRef $! subscribed
1353− liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1354− return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1355−
1356−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1357−cleanupFanSubscribed (k, subscribed) = do
1358− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1359− let reducedSubscribers = DMap.delete k subscribers
1360− if DMap.null reducedSubscribers
1361− then do
1362− unsubscribe $ fanSubscribedParent subscribed
1363− -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1364− writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1365− else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1366−
1367−{-# INLINE subscribeFanSubscribed #-}
1368−subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k -> Subscriber x a -> IO WeakBagTicket
1369−subscribeFanSubscribed k subscribed sub = do
1370− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1371− case DMap.lookup k subscribers of
1372− Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1373− let !self = (k, subscribed)
1374− weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1375− (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1376− writeIORef (fanSubscribedSubscribers subscribed) $! DMap.insertWith (error "subscribeFanSubscribed: key that we just failed to find is present - should be impossible") k (FanSubscribedChildren list self weakSelf) subscribers
1377− return sln
1378− Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1379−
1380−{-# SPECIALIZE getSwitchSubscribed :: HasSpiderTimeline x => Switch x a -> Subscriber x a -> EventM x (WeakBagTicket, SwitchSubscribed x a, Maybe a) #-}
1381−getSwitchSubscribed :: (Defer (SomeHoldInit x) m, Defer (SomeAssignment x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, Defer (SomeResetCoincidence x) m, HasCurrentHeight x m, HasSpiderTimeline x, m ~ EventM x) => Switch x a -> Subscriber x a -> m (WeakBagTicket, SwitchSubscribed x a, Maybe a)
1382−getSwitchSubscribed s sub = do
1383− mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1384− case mSubscribed of
1385− Just subscribed -> {-# SCC "hitSwitch" #-} liftIO $ do
1386− sln <- subscribeSwitchSubscribed subscribed sub
1387− occ <- readIORef $ switchSubscribedOccurrence subscribed
1388− return (sln, subscribed, occ)
1389− Nothing -> {-# SCC "missSwitch" #-} do
1390− subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1391− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1392− i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1393− mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1394− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1395− wiRef <- liftIO $ newIORef wi
1396− parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1397− holdInits <- getDeferralQueue
1398− e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1399− (subscription@(EventSubscription _ subd), parentOcc) <- subscribeAndRead e mySub
1400− heightRef <- liftIO $ newIORef =<< getEventSubscribedHeight subd
1401− subscriptionRef <- liftIO $ newIORef subscription
1402− occRef <- liftIO $ newIORef parentOcc
1403− when (isJust parentOcc) $ scheduleClear occRef
1404− weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1405− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1406− let !subscribed = SwitchSubscribed
1407− { switchSubscribedCachedSubscribed = switchSubscribed s
1408− , switchSubscribedOccurrence = occRef
1409− , switchSubscribedHeight = heightRef
1410− , switchSubscribedSubscribers = subs
1411− , switchSubscribedOwnInvalidator = i
1412− , switchSubscribedOwnWeakInvalidator = wiRef
1413− , switchSubscribedBehaviorParents = parentsRef
1414− , switchSubscribedParent = switchParent s
1415− , switchSubscribedCurrentParent = subscriptionRef
1416− , switchSubscribedWeakSelf = weakSelf
1417−#ifdef DEBUG_NODEIDS
1418− , switchSubscribedNodeId = unsafeNodeId s
1419−#endif
1420− }
1421− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1422− liftIO $ writeIORef subscribedRef $! subscribed
1423− liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1424− return (slnForSub, subscribed, parentOcc)
1425−
1426−cleanupSwitchSubscribed :: SwitchSubscribed x a -> IO ()
1427−cleanupSwitchSubscribed subscribed = do
1428− unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1429− finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1430− writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1431−
1432−{-# INLINE subscribeSwitchSubscribed #-}
1433−subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1434−subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1435−
1436−{-# SPECIALIZE getCoincidenceSubscribed :: HasSpiderTimeline x => Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket, CoincidenceSubscribed x a, Maybe a) #-}
1437−getCoincidenceSubscribed :: forall x a m. (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, HasCurrentHeight x m, Defer (SomeResetCoincidence x) m, HasSpiderTimeline x, m ~ EventM x) => Coincidence x a -> Subscriber x a -> m (WeakBagTicket, CoincidenceSubscribed x a, Maybe a)
1438−getCoincidenceSubscribed c sub = do
1439− mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1440− case mSubscribed of
1441− Just subscribed -> {-# SCC "hitCoincidence" #-} liftIO $ do
1442− sln <- subscribeCoincidenceSubscribed subscribed sub
1443− occ <- readIORef $ coincidenceSubscribedOccurrence subscribed
1444− return (sln, subscribed, occ)
1445− Nothing -> {-# SCC "missCoincidence" #-} do
1446− subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1447− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1448− subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1449− (outerSubscription@(EventSubscription _ outerSubd), outerOcc) <- subscribeAndRead (coincidenceParent c) subOuter
1450− outerHeight <- liftIO $ getEventSubscribedHeight outerSubd
1451− (occ, height, mInnerSubd) <- case outerOcc of
1452− Nothing -> return (Nothing, outerHeight, Nothing)
1453− Just o -> do
1454− (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1455− return (occ, height, Just innerSubd)
1456− occRef <- liftIO $ newIORef occ
1457− when (isJust occ) $ scheduleClear occRef
1458− heightRef <- liftIO $ newIORef height
1459− innerSubdRef <- liftIO $ newIORef mInnerSubd
1460− scheduleClear innerSubdRef
1461− weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1462− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1463− let subscribed = CoincidenceSubscribed
1464− { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1465− , coincidenceSubscribedOccurrence = occRef
1466− , coincidenceSubscribedHeight = heightRef
1467− , coincidenceSubscribedSubscribers = subs
1468− , coincidenceSubscribedOuter = subOuter
1469− , coincidenceSubscribedOuterParent = outerSubscription
1470− , coincidenceSubscribedInnerParent = innerSubdRef
1471− , coincidenceSubscribedWeakSelf = weakSelf
1472−#ifdef DEBUG_NODEIDS
1473− , coincidenceSubscribedNodeId = unsafeNodeId c
1474−#endif
1475− }
1476− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1477− liftIO $ writeIORef subscribedRef $! subscribed
1478− liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1479− return (slnForSub, subscribed, occ)
1480−
1481−cleanupCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO ()
1482−cleanupCoincidenceSubscribed subscribed = do
1483− unsubscribe $ coincidenceSubscribedOuterParent subscribed
1484− writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1485−
1486−{-# INLINE subscribeCoincidenceSubscribed #-}
1487−subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1488−subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1489−
1490−{-# INLINE merge #-}
1491−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (R.PatchDMap k (Event x)) -> Event x (DMap k Identity)
1492−merge d = cacheEvent (mergeCheap d)
1493−
1494−{-# INLINE [1] mergeCheap #-}
1495−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (R.PatchDMap k (Event x)) -> Event x (DMap k Identity)
1496−mergeCheap d = Event $ \sub -> do
1497− initialParents <- readBehaviorUntracked $ dynamicCurrent d
1498− accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
1499− heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
1500− heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
1501− parentsRef <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1502− let scheduleSelf height = scheduleMerge' height heightRef $ do
1503− m <- liftIO $ readIORef accumRef
1504− liftIO $ writeIORef accumRef $! DMap.empty
1505− --TODO: Assert that m is not empty
1506− subscriberPropagate sub m
1507− invalidateMyHeight = do
1508− oldHeight <- readIORef heightRef
1509− 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
1510− writeIORef heightRef $! invalidHeight
1511− subscriberInvalidateHeight sub oldHeight
1512− revalidateMyHeight = do
1513− currentHeight <- readIORef heightRef
1514− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1515− heights <- readIORef heightBagRef
1516− parents <- readIORef parentsRef
1517− -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1518− case heightBagSize heights `compare` DMap.size parents of
1519− LT -> return ()
1520− EQ -> do
1521− let height = succHeight $ heightBagMax heights
1522− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1523− writeIORef heightRef $! height
1524− subscriberRecalculateHeight sub height
1525− GT -> error $ "revalidateMergeHeight: more heights than parents for Merge"
1526− subscriber :: forall a. k a -> Subscriber x a
1527− subscriber k = Subscriber
1528− { subscriberPropagate = \a -> do
1529− oldM <- liftIO $ readIORef accumRef
1530− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge") k (Identity a) oldM
1531− tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
1532− liftIO $ writeIORef accumRef $! newM
1533− when (DMap.null oldM) $ do -- Only schedule the firing once
1534− height <- liftIO $ readIORef heightRef
1535− --TODO: assertions about height
1536− currentHeight <- getCurrentHeight
1537− when (height <= currentHeight) $ do
1538− if height /= invalidHeight
1539− then do
1540− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1541− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1542− else liftIO $ do
1543−#ifdef DEBUG_CYCLES
1544− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1545− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
1546− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1547−#else
1548− let cycleInfo = ""
1549−#endif
1550− error $ "Causality loop found" <> cycleInfo
1551− scheduleSelf height
1552− , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
1553− modifyIORef' heightBagRef $ heightBagRemove old
1554− invalidateMyHeight
1555− , subscriberRecalculateHeight = \new -> do
1556− modifyIORef' heightBagRef $ heightBagAdd new
1557− revalidateMyHeight
1558− }
1559− subscribers :: [(Maybe (DSum k Identity), Height, DSum k (MergeSubscribedParent x))] <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1560− let s = subscriber k
1561− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1562− height <- liftIO $ getEventSubscribedHeight parentSubd
1563− return $ (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1564− let dm = DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1565− heights = fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1566− myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1567− myHeight = if invalidHeight `elem` heights
1568− then invalidHeight
1569− else succHeight $ heightBagMax myHeightBag
1570− currentHeight <- getCurrentHeight
1571− let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1572− then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1573− else (Nothing, dm)
1574− unless (DMap.null accum) $ do
1575− scheduleSelf myHeight
1576− occRef <- liftIO $ newIORef occ
1577− when (isJust occ) $ scheduleClear occRef
1578− liftIO $ writeIORef accumRef $! accum
1579− liftIO $ writeIORef heightRef $! myHeight
1580− liftIO $ writeIORef heightBagRef $! myHeightBag
1581− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1582− liftIO $ writeIORef parentsRef $! DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1583− let updateMe (R.PatchDMap p) = do
1584− oldParents <- liftIO $ readIORef parentsRef
1585− let f (subscriptionsToKill, ps) (k :=> R.ComposeMaybe me) = do
1586− (mOldSubd, newPs) <- case me of
1587− Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1588− Just e -> do
1589− let s = subscriber k
1590− subscription@(EventSubscription _ subd) <- subscribe e s
1591− newParentHeight <- liftIO $ getEventSubscribedHeight subd
1592− let newParent = MergeSubscribedParent subscription
1593− liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1594− return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1595− forM_ mOldSubd $ \oldSubd -> do
1596− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1597− liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1598− return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1599− (subscriptionsToKill, newParents) <- foldM f ([], oldParents) $ DMap.toList p --TODO: I think this runEventM is OK, since no events are firing at this time, but it might not be
1600− liftIO $ writeIORef parentsRef $! newParents
1601− return subscriptionsToKill
1602− defer $ SomeMergeInit $ do
1603− let s = Subscriber
1604− { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1605− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1606− defer $ SomeMergeUpdate (updateMe a) invalidateMyHeight revalidateMyHeight
1607− , subscriberInvalidateHeight = \_ -> return ()
1608− , subscriberRecalculateHeight = \_ -> return ()
1609− }
1610− (EventSubscription _ changeSubd, change) <- subscribeAndRead (dynamicUpdated d) s
1611− forM_ change $ \c -> defer $ SomeMergeUpdate (updateMe c) invalidateMyHeight revalidateMyHeight
1612− liftIO $ writeIORef changeSubdRef (s, changeSubd)
1613− let unsubscribeAll = do
1614− parents <- readIORef parentsRef
1615− forM_ (DMap.toList parents) $ \(_ :=> MergeSubscribedParent s) -> unsubscribe s
1616− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1617− , occ
1618− )
1619−
1620−newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
1621−
1622−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
1623−fan e =
1624− let f = Fan
1625− { fanParent = e
1626− , fanSubscribed = unsafeNewIORef e Nothing
1627− }
1628− in EventSelector $ \k -> eventFan k f
1629−
1630−runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeMergeInit x] -> EventM x ()
1631−runHoldInits holdInitRef mergeInitRef = do
1632− holdInits <- liftIO $ readIORef holdInitRef
1633− mergeInits <- liftIO $ readIORef mergeInitRef
1634− unless (null holdInits && null mergeInits) $ do
1635− liftIO $ writeIORef holdInitRef []
1636− liftIO $ writeIORef mergeInitRef []
1637− mapM_ initHold holdInits
1638− mapM_ unSomeMergeInit mergeInits
1639− runHoldInits holdInitRef mergeInitRef
1640−
1641−initHold :: HasSpiderTimeline x => SomeHoldInit x -> EventM x ()
1642−initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
1643−
1644−newEventEnv :: IO (EventEnv x)
1645−newEventEnv = do
1646− toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1647− holdInitRef <- newIORef []
1648− mergeUpdateRef <- newIORef []
1649− mergeInitRef <- newIORef []
1650− heightRef <- newIORef zeroHeight
1651− toClearRef <- newIORef []
1652− toClearRootRef <- newIORef []
1653− coincidenceInfosRef <- newIORef []
1654− delayedRef <- newIORef IntMap.empty
1655− return $ EventEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef
1656−
1657−clearEventEnv :: EventEnv x -> IO ()
1658−clearEventEnv (EventEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef) = do
1659− writeIORef toAssignRef []
1660− writeIORef holdInitRef []
1661− writeIORef mergeUpdateRef []
1662− writeIORef mergeInitRef []
1663− writeIORef heightRef zeroHeight
1664− writeIORef toClearRef []
1665− writeIORef toClearRootRef []
1666− writeIORef coincidenceInfosRef []
1667− writeIORef delayedRef IntMap.empty
1668−
1669−-- | Run an event action outside of a frame
1670−runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
1671−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
1672− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimeline x)
1673− let go = do
1674− result <- a
1675− runHoldInits (eventEnvHoldInits 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
1676− return result
1677− result <- runEventM go
1678− toClear <- readIORef $ eventEnvClears env
1679− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
1680− toClearRoot <- readIORef $ eventEnvRootClears env
1681− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
1682− toAssign <- readIORef $ eventEnvAssignments env
1683− toReconnectRef <- newIORef []
1684− coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
1685− forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
1686− writeIORef vRef v
1687− when debugInvalidate $ putStrLn $ "Invalidating Hold"
1688− writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
1689− mergeUpdates <- readIORef $ eventEnvMergeUpdates env
1690− writeIORef (eventEnvMergeUpdates env) []
1691− when debugPropagate $ putStrLn "Updating merges"
1692− mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
1693− when debugPropagate $ putStrLn "Updating merges done"
1694− toReconnect <- readIORef toReconnectRef
1695− clearEventEnv env
1696− switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1697− oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
1698− wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1699− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
1700− finalize wi
1701− i <- evaluate $ switchSubscribedOwnInvalidator subscribed
1702− wi' <- mkWeakPtrWithDebug i "wi'"
1703− writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
1704− writeIORef (switchSubscribedBehaviorParents subscribed) []
1705− writeIORef (eventEnvHoldInits env) [] --TODO: Should we reuse this?
1706− e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) $ eventEnvHoldInits env
1707− runEventM $ runHoldInits (eventEnvHoldInits 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
1708− --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1709− sub <- newSubscriberSwitch subscribed
1710− 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
1711− {-
1712− stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1713− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1714− EventRoot _ -> "EventRoot"
1715− EventNever -> "EventNever"
1716− _ -> "something else"
1717− -}
1718− writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
1719− return oldSubscription
1720− liftIO $ mapM_ unsubscribe mergeSubscriptionsToKill
1721− liftIO $ mapM_ unsubscribe switchSubscriptionsToKill
1722− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1723− EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
1724− parentHeight <- getEventSubscribedHeight subd'
1725− myHeight <- readIORef $ switchSubscribedHeight subscribed
1726− when (parentHeight /= myHeight) $ do
1727− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1728− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
1729− 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
1730− forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
1731− unsubscribe subscription
1732− mapM_ invalidateCoincidenceHeight mcs
1733− forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
1734− mapM_ _someMergeUpdate_recalculateHeight mergeUpdates
1735− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1736− height <- calculateSwitchHeight subscribed
1737− updateSwitchHeight height subscribed
1738− return result
1739−
1740−newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
1741−
1742−{-# INLINE zeroHeight #-}
1743−zeroHeight :: Height
1744−zeroHeight = Height 0
1745−
1746−{-# INLINE invalidHeight #-}
1747−invalidHeight :: Height
1748−invalidHeight = Height (-1000)
1749−
1750−#ifdef DEBUG_CYCLES
1751−-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
1752−{-# INLINE invalidHeightBeingTraversed #-}
1753−invalidHeightBeingTraversed :: Height
1754−invalidHeightBeingTraversed = Height (-1001)
1755−#endif
1756−
1757−{-# INLINE succHeight #-}
1758−succHeight :: Height -> Height
1759−succHeight h@(Height a) =
1760− if h == invalidHeight
1761− then invalidHeight
1762− else Height $ succ a
1763−
1764−invalidateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1765−invalidateCoincidenceHeight subscribed = do
1766− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1767− when (oldHeight /= invalidHeight) $ do
1768− writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
1769− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1770−
1771−updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
1772−updateSwitchHeight new subscribed = do
1773− oldHeight <- readIORef $ switchSubscribedHeight subscribed
1774− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1775− when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1776− writeIORef (switchSubscribedHeight subscribed) $! new
1777− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1778−
1779−recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1780−recalculateCoincidenceHeight subscribed = do
1781− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1782− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1783− height <- calculateCoincidenceHeight subscribed
1784− when (height /= invalidHeight) $ do
1785− writeIORef (coincidenceSubscribedHeight subscribed) $! height
1786− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1787−
1788−calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
1789−calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
1790−
1791−calculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO Height
1792−calculateCoincidenceHeight subscribed = do
1793− outerHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1794− innerHeight <- maybe (return zeroHeight) getEventSubscribedHeight =<< readIORef (coincidenceSubscribedInnerParent subscribed)
1795− return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
1796−
1797−data SomeSwitchSubscribed x = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed x a)
1798−
1799−invalidate :: IORef [SomeSwitchSubscribed x] -> WeakList (Invalidator x) -> IO (WeakList (Invalidator x))
1800−invalidate toReconnectRef wis = do
1801− forM_ wis $ \wi -> do
1802− mi <- deRefWeak wi
1803− case mi of
1804− Nothing -> do
1805− traceInvalidate "invalidate Dead"
1806− return () --TODO: Should we clean this up here?
1807− Just i -> do
1808− finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
1809− case i of
1810− InvalidatorPull p -> do
1811− traceInvalidate $ "invalidate: Pull" <> showNodeId p
1812− mVal <- readIORef $ pullValue p
1813− forM_ mVal $ \val -> do
1814− writeIORef (pullValue p) Nothing
1815− writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
1816− InvalidatorSwitch subscribed -> do
1817− traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
1818− modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
1819− return [] -- Since we always finalize everything, always return an empty list --TODO: There are some things that will need to be re-subscribed every time; we should try to avoid finalizing them
1820−
1821−--------------------------------------------------------------------------------
1822−-- Reflex integration
1823−--------------------------------------------------------------------------------
1824−
1825−-- | The default, global Spider environment
1826−type Spider = SpiderTimeline Global
1827−
1828−-- | Designates the default, global Spider timeline
1829−data Global
1830−
1831−{-# NOINLINE globalSpiderTimeline #-}
1832−globalSpiderTimeline :: SpiderTimeline Global
1833−!globalSpiderTimeline = unsafePerformIO unsafeNewSpiderTimeline
1834−
1835−-- | Stores all global data relevant to a particular Spider timeline; only one
1836−-- value should exist for each type @x@
1837−data SpiderTimeline x = SpiderTimeline
1838− { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
1839− , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
1840−#ifdef DEBUG
1841− , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
1842−#endif
1843− }
1844−type role SpiderTimeline nominal
1845−
1846−instance GEq SpiderTimeline where
1847− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
1848− then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimeline can't have two different 'x' arguments
1849− else Nothing
1850−
1851−unsafeNewSpiderTimeline :: forall x. IO (SpiderTimeline x)
1852−unsafeNewSpiderTimeline = do
1853− lock <- newMVar ()
1854− env <- newEventEnv
1855−#ifdef DEBUG
1856− depthRef <- newIORef 0
1857−#endif
1858− return $ SpiderTimeline
1859− { _spiderTimeline_lock = lock
1860− , _spiderTimeline_eventEnv = env
1861−#ifdef DEBUG
1862− , _spiderTimeline_depth = depthRef
1863−#endif
1864− }
1865−
1866−-- | Create a new SpiderTimeline
1867−newSpiderTimeline :: IO (Some SpiderTimeline)
1868−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
1869−
1870−-- | Pass a new timeline to the given function.
1871−withSpiderTimeline :: (forall x. SpiderTimeline x -> IO r) -> IO r
1872−withSpiderTimeline k = unsafeNewSpiderTimeline >>= k
1873−
1874−newtype SpiderPullM x a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
1875−
1876−newtype SpiderPushM x a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
1877−
1878−instance HasSpiderTimeline x => Functor (R.Dynamic (SpiderTimeline x)) where
1879− fmap f = SpiderDynamic . newMapDyn f . unSpiderDynamic
1880−
1881−instance HasSpiderTimeline x => Applicative (R.Dynamic (SpiderTimeline x)) where
1882− pure = SpiderDynamic . dynamicConst
1883− SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ zipDynWith ($) a b
1884− _ *> b = b
1885− a <* _ = a
1886−
1887−instance HasSpiderTimeline x => Monad (R.Dynamic (SpiderTimeline x)) where
1888− {-# INLINE return #-}
1889− return = pure
1890− {-# INLINE (>>=) #-}
1891− x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
1892− {-# INLINE (>>) #-}
1893− _ >> y = y
1894− {-# INLINE fail #-}
1895− fail _ = error "Dynamic does not support 'fail'"
1896−
1897−instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
1898− {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
1899− newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
1900− newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
1901− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
1902− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
1903− type PullM (SpiderTimeline x) = SpiderPullM x
1904− type PushM (SpiderTimeline x) = SpiderPushM x
1905− {-# INLINABLE never #-}
1906− never = SpiderEvent eventNever
1907− {-# INLINABLE constant #-}
1908− constant = SpiderBehavior . behaviorConst
1909− {-# INLINE push #-}
1910− push f = SpiderEvent . push (coerce f) . unSpiderEvent
1911− {-# INLINABLE pull #-}
1912− pull = SpiderBehavior . pull . coerce
1913− {-# INLINABLE merge #-}
1914− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
1915− {-# INLINABLE fan #-}
1916− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
1917− {-# INLINABLE switch #-}
1918− switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
1919− {-# INLINABLE coincidence #-}
1920− coincidence = SpiderEvent . coincidence . (coerce :: Event x (R.Event (SpiderTimeline x) a) -> Event x (Event x a)) . unSpiderEvent
1921− {-# INLINABLE current #-}
1922− current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
1923− {-# INLINABLE updated #-}
1924− updated = SpiderEvent . fmap runIdentity . dynamicUpdated . unSpiderDynamic
1925− {-# INLINABLE unsafeBuildDynamic #-}
1926− unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeDyn (coerce readV0) $ coerce $ unSpiderEvent v'
1927− {-# INLINABLE unsafeBuildIncremental #-}
1928− unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
1929− {-# INLINABLE mergeIncremental #-}
1930− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (R.PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (R.PatchDMap k (Event x))) . unSpiderIncremental
1931− {-# INLINABLE currentIncremental #-}
1932− currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
1933− {-# INLINABLE updatedIncremental #-}
1934− updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
1935− {-# INLINABLE incrementalToDynamic #-}
1936− incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ dynamicCurrent i) $ flip push (dynamicUpdated i) $ \p -> do
1937− c <- readBehaviorUntracked $ dynamicCurrent i
1938− return $ Identity <$> R.apply p c --TODO: Avoid the redundant 'apply'
1939− eventCoercion Coercion = Coercion
1940− behaviorCoercion Coercion = Coercion
1941− dynamicCoercion = unsafeCoerce --TODO: How can we avoid this unsafeCoerce? This is safe only because we know how Identity works as a Patch instance
1942−
1943−instance HasSpiderTimeline x => R.MonadSample (SpiderTimeline x) (EventM x) where
1944− {-# INLINABLE sample #-}
1945− sample (SpiderBehavior b) = readBehaviorUntracked b
1946−
1947−instance HasSpiderTimeline x => R.MonadHold (SpiderTimeline x) (EventM x) where
1948− {-# INLINABLE hold #-}
1949− hold = holdSpiderEventM
1950− {-# INLINABLE holdDyn #-}
1951− holdDyn = holdDynSpiderEventM
1952− {-# INLINABLE holdIncremental #-}
1953− holdIncremental = holdIncrementalSpiderEventM
1954−
1955−holdSpiderEventM :: HasSpiderTimeline x => a -> R.Event (SpiderTimeline x) a -> EventM x (R.Behavior (SpiderTimeline x) a)
1956−holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
1957−
1958−holdDynSpiderEventM :: HasSpiderTimeline x => a -> R.Event (SpiderTimeline x) a -> EventM x (R.Dynamic (SpiderTimeline x) a)
1959−holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
1960−
1961−holdIncrementalSpiderEventM :: (HasSpiderTimeline x, R.Patch p) => R.PatchTarget p -> R.Event (SpiderTimeline x) p -> EventM x (R.Incremental (SpiderTimeline x) p)
1962−holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ hold v0 $ unSpiderEvent e
1963−
1964−instance HasSpiderTimeline x => R.MonadHold (SpiderTimeline x) (SpiderHost x) where
1965− {-# INLINABLE hold #-}
1966− hold v0 e = R.runHostFrame $ R.hold v0 e
1967− {-# INLINABLE holdDyn #-}
1968− holdDyn v0 e = R.runHostFrame $ R.holdDyn v0 e
1969− {-# INLINABLE holdIncremental #-}
1970− holdIncremental v0 e = R.runHostFrame $ R.holdIncremental v0 e
1971−
1972−instance HasSpiderTimeline x => R.MonadSample (SpiderTimeline x) (SpiderHost x) where
1973− {-# INLINABLE sample #-}
1974− sample = runFrame . readBehaviorUntracked . unSpiderBehavior
1975−
1976−instance R.MonadSample (SpiderTimeline x) (SpiderPullM x) where
1977− {-# INLINABLE sample #-}
1978− sample = coerce . readBehaviorTracked . unSpiderBehavior
1979−
1980−instance R.MonadSample (SpiderTimeline x) (SpiderPushM x) where
1981− {-# INLINABLE sample #-}
1982− sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
1983−
1984−instance HasSpiderTimeline x => R.MonadHold (SpiderTimeline x) (SpiderPushM x) where
1985− {-# INLINABLE hold #-}
1986− hold v0 e = R.current <$> R.holdDyn v0 e
1987− {-# INLINABLE holdDyn #-}
1988− holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ hold v0 $ coerce e
1989− {-# INLINABLE holdIncremental #-}
1990− holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> hold v0 e
1991−
1992−data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
1993−
1994−data SpiderEventHandle x a = SpiderEventHandle
1995− { spiderEventHandleSubscription :: EventSubscription x
1996− , spiderEventHandleValue :: IORef (Maybe a)
1997− }
1998−
1999−instance HasSpiderTimeline x => R.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2000− {-# INLINABLE subscribeEvent #-}
2001− subscribeEvent e = SpiderHostFrame $ do
2002− --TODO: Unsubscribe eventually (manually and/or with weak ref)
2003− val <- liftIO $ newIORef Nothing
2004− subscription <- subscribe (unSpiderEvent e) $ Subscriber
2005− { subscriberPropagate = \a -> do
2006− liftIO $ writeIORef val $ Just a
2007− scheduleClear val
2008− , subscriberInvalidateHeight = \_ -> return ()
2009− , subscriberRecalculateHeight = \_ -> return ()
2010− }
2011− return $ SpiderEventHandle
2012− { spiderEventHandleSubscription = subscription
2013− , spiderEventHandleValue = val
2014− }
2015−
2016−instance HasSpiderTimeline x => R.ReflexHost (SpiderTimeline x) where
2017− type EventTrigger (SpiderTimeline x) = RootTrigger x
2018− type EventHandle (SpiderTimeline x) = SpiderEventHandle x
2019− type HostFrame (SpiderTimeline x) = SpiderHostFrame x
2020−
2021−instance HasSpiderTimeline x => R.MonadReadEvent (SpiderTimeline x) (ReadPhase x) where
2022− {-# NOINLINE readEvent #-}
2023− readEvent h = ReadPhase $ fmap (fmap return) $ liftIO $ do
2024− result <- readIORef $ spiderEventHandleValue h
2025− touch h
2026− return result
2027−
2028−instance MonadRef (EventM x) where
2029− type Ref (EventM x) = Ref IO
2030− {-# INLINABLE newRef #-}
2031− {-# INLINABLE readRef #-}
2032− {-# INLINABLE writeRef #-}
2033− newRef = liftIO . newRef
2034− readRef = liftIO . readRef
2035− writeRef r a = liftIO $ writeRef r a
2036−
2037−instance MonadAtomicRef (EventM x) where
2038− {-# INLINABLE atomicModifyRef #-}
2039− atomicModifyRef r f = liftIO $ atomicModifyRef r f
2040−
2041−-- | The monad for actions that manipulate a Spider timeline identified by @x@
2042−newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderTimeline x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2043−
2044−instance Monad (SpiderHost x) where
2045− {-# INLINABLE (>>=) #-}
2046− SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2047− {-# INLINABLE (>>) #-}
2048− SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2049− {-# INLINABLE return #-}
2050− return x = SpiderHost $ return x
2051− {-# INLINABLE fail #-}
2052− fail s = SpiderHost $ fail s
2053−
2054−-- | Run an action affecting the global Spider timeline; this will be guarded by
2055−-- a mutex for that timeline
2056−runSpiderHost :: SpiderHost Global a -> IO a
2057−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimeline
2058−
2059−-- | Run an action affecting a given Spider timeline; this will be guarded by a
2060−-- mutex for that timeline
2061−runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimeline x -> IO a
2062−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2063−
2064−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2065−
2066−instance Monad (SpiderHostFrame x) where
2067− {-# INLINABLE (>>=) #-}
2068− SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2069− {-# INLINABLE (>>) #-}
2070− SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2071− {-# INLINABLE return #-}
2072− return x = SpiderHostFrame $ return x
2073− {-# INLINABLE fail #-}
2074− fail s = SpiderHostFrame $ fail s
2075−
2076−instance HasSpiderTimeline x => R.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2077− sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2078−
2079−instance HasSpiderTimeline x => R.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
2080− {-# INLINABLE hold #-}
2081− hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
2082− {-# INLINABLE holdDyn #-}
2083− holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
2084− {-# INLINABLE holdIncremental #-}
2085− holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ hold v0 $ unSpiderEvent e
2086−
2087−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2088−newEventWithTriggerIO f = do
2089− es <- newFanEventWithTriggerIO $ \Refl -> f
2090− return $ select es Refl
2091−
2092−newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2093−newFanEventWithTriggerIO f = do
2094− occRef <- newIORef DMap.empty
2095− subscribedRef <- newIORef DMap.empty
2096− let !r = Root
2097− { rootOccurrence = occRef
2098− , rootSubscribed = subscribedRef
2099− , rootInit = f
2100− }
2101− return $ EventSelector $ \k -> eventRoot k r
2102−
2103−instance R.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2104− newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
2105− newFanEventWithTrigger f = SpiderHost $ lift $ do
2106− es <- newFanEventWithTriggerIO f
2107− return $ R.EventSelector $ SpiderEvent . select es
2108−
2109−instance R.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2110− newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2111− newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2112− es <- newFanEventWithTriggerIO f
2113− return $ R.EventSelector $ SpiderEvent . select es
2114−
2115−instance HasSpiderTimeline x => R.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
2116− {-# INLINABLE subscribeEvent #-}
2117− subscribeEvent = runFrame . runSpiderHostFrame . R.subscribeEvent
2118−
2119−newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2120−
2121−instance HasSpiderTimeline x => R.MonadSample (SpiderTimeline x) (ReadPhase x) where
2122− {-# INLINABLE sample #-}
2123− sample = ReadPhase . R.sample
2124−
2125−instance HasSpiderTimeline x => R.MonadHold (SpiderTimeline x) (ReadPhase x) where
2126− {-# INLINABLE hold #-}
2127− hold v0 e = ReadPhase $ R.hold v0 e
2128− {-# INLINABLE holdDyn #-}
2129− holdDyn v0 e = ReadPhase $ R.holdDyn v0 e
2130− {-# INLINABLE holdIncremental #-}
2131− holdIncremental v0 e = ReadPhase $ R.holdIncremental v0 e
2132−
2133−instance HasSpiderTimeline x => R.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
2134− type ReadPhase (SpiderHost x) = ReadPhase x
2135− fireEventsAndRead es (ReadPhase a) = run es a
2136− runHostFrame = runFrame . runSpiderHostFrame
2137−
2138−instance MonadRef (SpiderHost x) where
2139− type Ref (SpiderHost x) = Ref IO
2140− newRef = SpiderHost . newRef
2141− readRef = SpiderHost . readRef
2142− writeRef r = SpiderHost . writeRef r
2143−
2144−instance MonadAtomicRef (SpiderHost x) where
2145− atomicModifyRef r = SpiderHost . atomicModifyRef r
2146−
2147−instance MonadRef (SpiderHostFrame x) where
2148− type Ref (SpiderHostFrame x) = Ref IO
2149− newRef = SpiderHostFrame . newRef
2150− readRef = SpiderHostFrame . readRef
2151− writeRef r = SpiderHostFrame . writeRef r
2152−
2153−instance MonadAtomicRef (SpiderHostFrame x) where
2154− atomicModifyRef r = SpiderHostFrame . atomicModifyRef r
2155−
2156−instance PrimMonad (SpiderHostFrame x) where
2157− type PrimState (SpiderHostFrame x) = PrimState IO
2158− primitive = SpiderHostFrame . EventM . primitive
2159−
2160−--------------------------------------------------------------------------------
2161−-- Deprecated items
2162−--------------------------------------------------------------------------------
2163−
2164−{-# DEPRECATED SpiderEnv "Use 'SpiderTimeline' instead" #-}
2165−type SpiderEnv = SpiderTimeline
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/Reflex/Bench/Focused.hsdeleted−369
@@ -1,369 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE RankNTypes #-}
7−{-# LANGUAGE RecursiveDo #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TupleSections #-}
10−{-# LANGUAGE TypeSynonymInstances #-}
11−
12−module Reflex.Bench.Focused where
13−
14−import Reflex
15−import Reflex.TestPlan
16−
17−import Control.Applicative
18−import Control.Monad
19−import Control.Monad.Fix
20−import Control.Monad.Identity
21−import Data.Traversable (for, traverse)
22−
23−import qualified Data.Dependent.Map as DMap
24−import Data.Map (Map)
25−import qualified Data.Map as Map
26−import Data.Maybe
27−
28−import Data.Functor.Misc
29−
30−import Data.List
31−import Data.List.Split
32−import Data.Tuple
33−
34−import Data.Monoid
35−import Data.Word
36−
37−import Control.DeepSeq
38−
39−import Prelude hiding (concat, sum)
40−
41−
42−mergeTree :: Num a => (Monoid (f [a]), Functor f) => Int -> [f a] -> f a
43−mergeTree n es | length es <= n = sum' es
44− | otherwise = mergeTree n subTrees
45− where
46− merges = chunksOf n es
47− subTrees = map sum' merges
48− sum' = fmap sum . mconcat . fmap (fmap (:[]) )
49−
50−mergeListDyn :: Reflex t => [Dynamic t a] -> Dynamic t [a]
51−mergeListDyn = mconcat . fmap (fmap pure)
52−
53−mergeTreeDyn :: (Num a, Reflex t) => Int -> [Dynamic t a] -> Dynamic t a
54−mergeTreeDyn n dyns | length dyns <= n = sumDyns dyns
55− | otherwise = mergeTreeDyn n $ fmap sumDyns merges
56− where
57− merges = chunksOf n dyns
58− sumDyns = fmap sum . mergeListDyn
59−
60−
61−
62−-- N events all firing for N frames
63−continuous :: TestPlan t m => Word -> Word -> m [Event t Word]
64−continuous n frames = for [1..n] $ \i -> plan $ (, i) <$> [1..frames]
65−
66−-- Fire N events once every P frames for total N frames (interspersed evenly)
67−occasional :: TestPlan t m => Word -> Word -> Word -> m [Event t Word]
68−occasional n period frames = traverse plan $ zipWith occs [1..] phases
69− where
70− phases = take (fromIntegral n) $ concat (repeat [1..period])
71− occs i phase = (, i) <$> [1, phase+1..frames]
72−
73−
74−
75−-- Event which never fires (but isn't 'never')
76−never' :: TestPlan t m => m (Event t Word)
77−never' = plan []
78−
79−
80−-- Event which fires once on first frame
81−event :: TestPlan t m => m (Event t Word)
82−event = plan [(1, 0)]
83−
84−-- Event which fires constantly over N frames
85−events :: TestPlan t m => Word -> m (Event t Word)
86−events n = plan $ (\i -> (i, i)) <$> [1..n]
87−
88−
89−-- N events all originating from one event
90−fmapFan :: Reflex t => Word -> Event t Word -> [Event t Word]
91−fmapFan n e = (\i -> (+i) <$> e) <$> [1..n]
92−
93−
94−-- Make a fan using the value in the event converting it to a singleton Map
95−-- use a fan of size n (key is the value mod n)
96−fanMerge :: Reflex t => Word -> Event t Word -> Event t Word
97−fanMerge n e = leftmost $ s <$> [0..n - 1] where
98− s k = select f (Const2 k)
99− f = fan (toMap <$> e)
100− toMap k = DMap.singleton (Const2 $ k `mod` n) (Identity k)
101−
102−-- Dumb version of the above using simple fmapMaybe to filter
103−fmapFanMerge :: Reflex t => Word -> Event t Word -> Event t Word
104−fmapFanMerge n e = leftmost $ s <$> [0..n - 1] where
105− s k = flip fmapMaybe e $ \j -> if k == j `mod` n
106− then Just k
107− else Nothing
108−
109−
110−
111−-- Create an Event with a Map which is dense to size N
112−denseMap :: TestPlan t m => Word -> m (Event t (Map Word Word))
113−denseMap n = plan [(1, m)] where
114− m = Map.fromList $ zip [1..n] [1..n]
115−
116−iter :: (a -> a) -> Word -> a -> a
117−iter _ 0 a = a
118−iter f n a = iter f (n - 1) (f a)
119−
120−iterM :: Monad m => (a -> m a) -> Word -> a -> m a
121−iterM _ 0 a = return a
122−iterM f n a = iterM f (n - 1) =<< f a
123−
124−fmapChain :: (Functor f) => Word -> f Word -> f Word
125−fmapChain = iter (fmap (+1))
126−
127−mapDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
128−mapDynChain = iterM (return . fmap (+1))
129−
130−joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
131−joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
132−
133−combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134−combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
135−
136−pingPong :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> Event t a -> m (Event t a)
137−pingPong e1 e2 = do
138− rec
139− d <- foldDyn (const swap) (e1, e2) e
140− let e = switch (fst <$> current d)
141− return e
142−
143−switchFactors :: (Reflex t, MonadHold t m) => Word -> Event t Word -> m (Event t Word)
144−switchFactors 0 e = return e
145−switchFactors i e = do
146− b <- hold ((+1) <$> e) (e <$ ffilter ((== 0) . (i `mod`)) e)
147− switchFactors (i - 1) (switch b)
148−
149−
150−switchChain :: (Reflex t, MonadHold t m, MonadFix m) => Word -> Event t Word -> m (Event t Word)
151−switchChain = iterM (\e -> pingPong e ((+1) <$> e))
152−
153−
154−switchChain2 :: (Reflex t, MonadHold t m, MonadFix m) => Word -> Event t Word -> m (Event t Word)
155−switchChain2 = iterM (\e -> pingPong e ((+1) <$> leftmost [e, e]))
156−
157−switchPromptlyChain :: (Reflex t, MonadHold t m) => Word -> Event t Word -> m (Event t Word)
158−switchPromptlyChain = iterM $ \e ->
159− switchPromptlyDyn <$> holdDyn e (e <$ e)
160−
161−
162−coinChain :: Reflex t => Word -> Event t Word -> Event t Word
163−coinChain = iter $ \e -> coincidence (e <$ e)
164−
165−fanMergeChain :: Reflex t => Word -> Word -> Event t Word -> Event t Word
166−fanMergeChain width = iter $ fanMerge width
167−
168−fmapFanMergeChain :: Reflex t => Word -> Word -> Event t Word -> Event t Word
169−fmapFanMergeChain width = iter $ fmapFanMerge width
170−
171−-- | Data type for a collection (a map) which is updated by providing differences
172−data UpdatedMap t k a = UpdatedMap (Map k a) (Event t (Map k (Maybe a)))
173−
174−-- This will hopefully become a primitive (faster!)
175−switchMergeEvents :: (MonadFix m, MonadHold t m, Reflex t, Ord k) => UpdatedMap t k (Event t a) -> m (Event t (Map k a))
176−switchMergeEvents mapChanges = switch . fmap mergeMap <$> holdMap mapChanges
177−
178−-- switchMergeMaybe :: (MonadFix m, MonadHold t m, Reflex t, Ord k) => UpdatedMap t k (Event t a) -> m (Event t (Map k a))
179−-- switchMergeMaybe (UpdatedMap initial changes) = switchMergeMap initial (fmap (fromMaybe never) <$> changes)
180−
181−switchMergeBehaviors :: forall a t m k. (MonadFix m, MonadHold t m, Reflex t, Ord k) => UpdatedMap t k (Behavior t a) -> m (Behavior t (Map k a))
182−switchMergeBehaviors mapChanges = pull . joinMap <$> holdMap mapChanges
183− where joinMap m = traverse sample =<< sample m
184−
185−-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
186−holdMapDyn :: (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
188−
189− where
190− modify k Nothing items = Map.delete k items
191− modify k (Just item) items = Map.insert k item items
192−
193−
194−-- | Hold an UpdatedMap as a behavior by applying differences to the initial value
195−holdMap :: (Reflex t, MonadHold t m, MonadFix m, Ord k) => UpdatedMap t k a -> m (Behavior t (Map k a))
196−holdMap = (current <$>) . holdMapDyn
197−
198−
199−increasingMerge :: TestPlan t m => [a] -> m (UpdatedMap t Int a)
200−increasingMerge xs = do
201− e <- planList (zipWith Map.singleton [1..] (Just <$> xs) ++ [reset])
202− return (UpdatedMap Map.empty e)
203− where
204− reset = Map.fromList $ zip [1..] (const Nothing <$> xs)
205−
206−decreasingMerge :: (TestPlan t m) => [a] -> m (UpdatedMap t Int a)
207−decreasingMerge xs = do
208− e <- planList (zipWith Map.singleton [1..] (const Nothing <$> xs) ++ [reset])
209− return (UpdatedMap initial e)
210− where
211− initial = Map.fromList $ zip [1..] xs
212− reset = Just <$> initial
213−
214−modifyMerge :: (TestPlan t m) => [a] -> m (UpdatedMap t Int a)
215−modifyMerge xs = do
216− e <- planList $ zipWith Map.singleton [1..] (Just <$> xs)
217− return (UpdatedMap initial e)
218− where
219− initial = Map.fromList $ zip [1..] xs
220−
221−
222−countMany :: (Reflex t, MonadHold t m, MonadFix m) => [Event t a] -> m [Behavior t Int]
223−countMany = traverse (fmap current . count)
224−
225−countManyDyn :: (Reflex t, MonadHold t m, MonadFix m) => [Event t a] -> m [Dynamic t Int]
226−countManyDyn = traverse count
227−
228−
229−-- Given a function which creates a sub-network (from a single event)
230−-- Create a plan which uses a switch to substitute it
231−switches :: TestPlan t m => Word -> (forall n. (MonadHold t n, MonadFix n) => Event t Word -> n (Event t a)) -> m (Event t a)
232−switches numFrames f = do
233− es <- events numFrames
234− switch <$> hold never (makeEvents es)
235−
236− where
237− makeEvents es = pushAlways (\n -> f (fmap (+n) es)) es
238−
239−
240−
241−-- Two sets of benchmarks, one which we're interested in testing subscribe time (as well as time to fire frames)
242−-- the other, which we're only interested in time for running frames
243−subscribing :: Word -> Word -> [(String, TestCase)]
244−subscribing n frames =
245− [ testSub "fmapFanMerge" $ return . mergeList . fmapFan n
246− , testSub "fanMerge" $ return . fanMerge n
247− , testSub "fmapFan/mergeTree" $ return . mergeTree 8 . fmapFan n
248− , testSub "fmapChain" $ return . fmapChain n
249− , testSub "switchChain" $ switchChain n
250− , testSub "switchPromptlyChain" $ switchPromptlyChain n
251− , testSub "switchFactors" $ switchFactors n
252− , testSub "coincidenceChain" $ return . coinChain n
253− ]
254−
255− where
256− testSub :: (Eq a, Show a, NFData a) => String -> (forall t n. (Reflex t, MonadHold t n, MonadFix n) => Event t Word -> n (Event t a)) -> (String, TestCase)
257− testSub name test = testE name (switches frames test)
258−
259−-- Set of benchmark to test specifically merging dynamic collections
260−-- a pattern which occurs frequently in reflex-dom collections
261−merging :: Word -> [(String, TestCase)]
262−merging n =
263− [ testE "static events" $ mergeList <$> sparse
264− , testE "increasing events" $ switchMergeEvents =<< increasingMerge =<< sparse
265− , testE "decreasing events" $ switchMergeEvents =<< decreasingMerge =<< sparse
266− , testE "modify events" $ switchMergeEvents =<< modifyMerge =<< sparse
267−
268− , testB "static behaviors" $ pull . traverse sample <$> counters
269− , testB "increasing behaviors" $ switchMergeBehaviors =<< increasingMerge =<< counters
270− , testB "decreasing behaviors" $ switchMergeBehaviors =<< decreasingMerge =<< counters
271− , testB "modify behaviors" $ switchMergeBehaviors =<< modifyMerge =<< counters
272−
273−
274− -- , testE "increasing events/switchMerge" $ switchMergeMaybe =<< increasingMerge =<< sparse
275− -- , testE "decreasing events/switchMerge" $ switchMergeMaybe =<< decreasingMerge =<< sparse
276− -- , testE "modify events/switchMerge" $ switchMergeMaybe =<< modifyMerge =<< sparse
277− ]
278−
279− where
280− sparse :: TestPlan t m => m [Event t Word]
281− sparse = fmap (fmap (+1)) <$> occasional n 8 n
282−
283− counters :: TestPlan t m => m [Behavior t Int]
284− counters = countMany =<< sparse
285−
286−
287−
288−fans :: Word -> [(String, TestCase)]
289−fans n =
290− [ testE "fanMapChain" $ fanMergeChain n 10 <$> e
291− , testE "fmapFanMapChain" $ fmapFanMergeChain n 10 <$> e
292−
293− , testE "fanMerge " $ fanMerge n <$> events n
294−
295− , testE "fmapFanMerge " $ fmapFanMerge n <$> events n
296− , testE "triggerMerge" $ leftmost <$> for [1..n] (\i -> plan [(i, i)])
297−
298− ]
299− where
300−
301− e :: TestPlan t m => m (Event t Word)
302− e = events 100
303−
304−
305−
306−
307−dynamics :: Word -> [(String, TestCase)]
308−dynamics n =
309− [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
310− , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
311− , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
312− , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
313− , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
314− , testE "mergeDyn" $ fmap (updated . fmap sum . mergeListDyn) sparse
315− ] where
316−
317− d :: TestPlan t m => m (Dynamic t Word)
318− d = count =<< events 10
319−
320− sparse, dense :: TestPlan t m => m [Dynamic t Int]
321− sparse = countManyDyn =<< occasional n 8 16
322− dense = countManyDyn =<< continuous n 2
323−
324−
325−firing :: Word -> [(String, TestCase)]
326−firing n =
327− [ testE "fmapChain" $ fmapChain n <$> e
328− , testE "switchChain2" $ switchChain2 n =<< e
329− , testE "switchPromptlyChain" $ switchPromptlyChain n =<< e
330− , testE "switchFactors" $ switchFactors n =<< e
331− , testE "coincidenceChain" $ coinChain n <$> e
332−
333− , testE "dense mergeTree" $ mergeTree 8 <$> dense
334− , testE "sparse mergeTree" $ mergeTree 8 <$> sparse
335−
336− -- Triggers test failure in Spider
337− --, testE "runFrame" $ events n
338−
339− , testB "sum counters" $ do
340− counts <- counters
341− return $ pull $ sum <$> traverse sample counts
342−
343− , testB "pullChain" $ fmapChain n . current <$> (count =<< events 4)
344− , testB "pullChain2" $ do
345− es <- events 4
346− e' <- plan [(0, ())]
347−
348− b <- hold (constant 0) $
349− pushAlways (const $ fmapChain n <$> hold 0 es) e'
350−
351− return (join b)
352− , testB "counters/pullTree" $ mergeTree 8 <$> counters
353−
354− ]
355− where
356− e :: TestPlan t m => m (Event t Word)
357− e = events 10
358−
359− dense, sparse :: TestPlan t m => m [Event t Word]
360− dense = continuous n 2
361− sparse = occasional n 8 16
362−
363− counters :: TestPlan t m => m [Behavior t Int]
364− counters = countMany =<< sparse
365−
366−
367−
368−
369−
test/Reflex/Plan/Pure.hsdeleted−70
@@ -1,70 +0,0 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE FlexibleInstances #-}
3−{-# LANGUAGE GADTs #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE RankNTypes #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−
9−module Reflex.Plan.Pure where
10−
11−import Reflex
12−import Reflex.Pure
13−import Reflex.TestPlan
14−
15−import Control.Applicative
16−import Control.Monad.Fix
17−import Control.Monad.State
18−import Data.IntMap (IntMap)
19−import qualified Data.IntMap as IntMap
20−import Data.IntSet (IntSet)
21−import qualified Data.IntSet as IntSet
22−
23−import Data.Bifunctor
24−import Data.Maybe
25−import Data.Monoid
26−import Prelude
27−
28−
29−mapToPureEvent :: IntMap a -> Event (Pure Int) a
30−mapToPureEvent m = Event $ flip IntMap.lookup m
31−
32−type TimeM = (->) Int
33−newtype PurePlan a = PurePlan { unPlan :: StateT IntSet TimeM a } deriving (Functor, Applicative, Monad, MonadFix)
34−
35−liftPlan :: TimeM a -> PurePlan a
36−liftPlan = PurePlan . lift
37−
38−instance MonadHold (Pure Int) PurePlan where
39− hold initial = liftPlan . hold initial
40− holdDyn initial = liftPlan . holdDyn initial
41− holdIncremental initial = liftPlan . holdIncremental initial
42−
43−instance MonadSample (Pure Int) PurePlan where
44− sample = liftPlan . sample
45−
46−
47−instance TestPlan (Pure Int) PurePlan where
48− plan occs = do
49− PurePlan . modify $ IntSet.union (IntMap.keysSet m)
50− return $ mapToPureEvent m
51− where m = IntMap.fromList (first fromIntegral <$> occs)
52−
53−runPure :: PurePlan a -> (a, IntSet)
54−runPure (PurePlan p) = runStateT p mempty $ 0
55−
56−relavantTimes :: IntSet -> IntSet
57−relavantTimes occs = IntSet.fromList [0..l + 1]
58− where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
59−
60−testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
61−testBehavior (b, occs) = IntMap.fromSet (sample b) (relavantTimes occs)
62−
63−testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
64−testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relavantTimes occs)
65−
66−
67−
68−
69−
70−
test/Reflex/Plan/Reflex.hsdeleted−135
@@ -1,135 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE StandaloneDeriving #-}
10−{-# LANGUAGE UndecidableInstances #-}
11−module Reflex.Plan.Reflex
12− ( TestPlan(..)
13− , runPlan
14− , Plan (..)
15− , Schedule
16− , Firing (..)
17− , MonadIORef
18−
19−
20− , readSchedule
21− , readSchedule_
22− , testSchedule
23− , readEvent'
24− , makeDense
25−
26− , runTestE
27− , runTestB
28−
29− ) where
30−
31−import Reflex.Class
32−import Reflex.Host.Class
33−import Reflex.TestPlan
34−
35−import Control.Applicative
36−import Control.Monad
37−import Control.Monad.Identity
38−import Control.Monad.State.Strict
39−
40−import Control.Monad.Ref
41−import Data.Dependent.Sum (DSum (..))
42−import qualified Data.IntMap.Strict as IntMap
43−import Data.Maybe
44−import Data.Monoid
45−import Data.Traversable (sequenceA, traverse)
46−
47−import Control.DeepSeq
48−import Control.Exception
49−import Data.IntMap.Strict (IntMap)
50−import Data.IORef
51−import System.Mem
52−
53−-- Note: this import must come last to silence warnings from AMP
54−import Prelude
55−
56−type MonadIORef m = (MonadIO m, MonadRef m, Ref m ~ Ref IO)
57−
58−data Firing t where
59− Firing :: IORef (Maybe (EventTrigger t a)) -> a -> Firing t
60−
61−
62−type Schedule t = IntMap [Firing t]
63−
64−-- Implementation of a TestPlan in terms of ReflexHost
65−newtype Plan t a = Plan (StateT (Schedule t) (HostFrame t) a)
66−
67−deriving instance ReflexHost t => Functor (Plan t)
68−deriving instance ReflexHost t => Applicative (Plan t)
69−deriving instance ReflexHost t => Monad (Plan t)
70−
71−deriving instance ReflexHost t => MonadSample t (Plan t)
72−deriving instance ReflexHost t => MonadHold t (Plan t)
73−deriving instance ReflexHost t => MonadFix (Plan t)
74−
75−
76−instance (ReflexHost t, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO) => TestPlan t (Plan t) where
77− plan occurances = Plan $ do
78− (e, ref) <- newEventWithTriggerRef
79− modify (IntMap.unionWith mappend (firings ref))
80− return e
81−
82− where
83− firings ref = IntMap.fromList (makeFiring ref <$> occurances)
84− makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
85−
86−
87−firingTrigger :: (MonadReflexHost t m, MonadIORef m) => Firing t -> m (Maybe (DSum (EventTrigger t) Identity))
88−firingTrigger (Firing ref a) = fmap (:=> Identity a) <$> readRef ref
89−
90−runPlan :: (MonadReflexHost t m) => Plan t a -> m (a, Schedule t)
91−runPlan (Plan p) = runHostFrame $ runStateT p mempty
92−
93−
94−makeDense :: Schedule t -> Schedule t
95−makeDense s = fromMaybe (emptyRange 0) $ do
96− (end, _) <- fst <$> IntMap.maxViewWithKey s
97− return $ IntMap.union s (emptyRange end)
98− where
99− emptyRange end = IntMap.fromList (zip [0..end + 1] (repeat []))
100−
101−
102−-- For the purposes of testing, we add in a zero frame and extend one frame (to observe changes to behaviors
103−-- after the last event)
104−-- performGC is called at each frame to test for GC issues
105−testSchedule :: (MonadReflexHost t m, MonadIORef m, NFData a) => Schedule t -> ReadPhase m a -> m (IntMap a)
106−testSchedule schedule readResult = IntMap.traverseWithKey (\t occs -> liftIO performGC *> triggerFrame readResult t occs) (makeDense schedule)
107−
108−readSchedule :: (MonadReflexHost t m, MonadIORef m, NFData a) => Schedule t -> ReadPhase m a -> m (IntMap a)
109−readSchedule schedule readResult = IntMap.traverseWithKey (triggerFrame readResult) schedule
110−
111−readSchedule_ :: (MonadReflexHost t m, MonadIORef m, NFData a) => Schedule t -> ReadPhase m a -> m ()
112−readSchedule_ schedule readResult = mapM_ (uncurry $ triggerFrame readResult) $ IntMap.toList schedule
113−
114−triggerFrame :: (MonadReflexHost t m, MonadIORef m, NFData a) => ReadPhase m a -> Int -> [Firing t] -> m a
115−triggerFrame readResult _ occs = do
116− triggers <- catMaybes <$> traverse firingTrigger occs
117− liftIO . evaluate . force =<< fireEventsAndRead triggers readResult
118−
119−readEvent' :: MonadReadEvent t m => EventHandle t a -> m (Maybe a)
120−readEvent' = readEvent >=> sequenceA
121−
122−
123−-- Convenience functions for running tests producing Events/Behaviors
124−runTestB :: (MonadReflexHost t m, MonadIORef m, NFData a) => Plan t (Behavior t a) -> m (IntMap a)
125−runTestB p = do
126− (b, s) <- runPlan p
127− testSchedule s $ sample b
128−
129−runTestE :: (MonadReflexHost t m, MonadIORef m, NFData a) => Plan t (Event t a) -> m (IntMap (Maybe a))
130−runTestE p = do
131− (e, s) <- runPlan p
132− h <- subscribeEvent e
133− testSchedule s (readEvent' h)
134−
135−
test/Reflex/Test.hsdeleted−66
@@ -1,66 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE RankNTypes #-}
7−
8−module Reflex.Test
9− ( testAgreement
10− , compareResult
11− , runTests
12−
13− , module Reflex.TestPlan
14−
15− ) where
16−
17−import Reflex.Spider
18−
19−import Reflex.TestPlan
20−
21−import Reflex.Plan.Pure
22−import Reflex.Plan.Reflex
23−
24−import Control.Monad
25−import Data.Monoid
26−
27−import Data.IntMap (IntMap)
28−
29−--import Data.Foldable
30−import System.Exit
31−
32−import Prelude
33−
34−
35−testAgreement :: TestCase -> IO Bool
36−testAgreement (TestE p) = do
37− spider <- runSpiderHost $ runTestE p
38− let results = [("spider", spider)]
39−
40− compareResult results (testEvent $ runPure p)
41−
42−testAgreement (TestB p) = do
43− spider <- runSpiderHost $ runTestB p
44− let results = [("spider", spider)]
45−
46− compareResult results (testBehavior $ runPure p)
47−
48−
49−compareResult :: (Show a, Eq a) => [(String, IntMap a)] -> IntMap a -> IO Bool
50−compareResult results expected = fmap and $ forM results $ \(name, r) -> do
51−
52− when (r /= expected) $ do
53− putStrLn ("Got: " ++ show (name, r))
54− putStrLn ("Expected: " ++ show expected)
55− return (r == expected)
56−
57−
58−runTests :: [(String, TestCase)] -> IO ()
59−runTests testCases = do
60− results <- forM testCases $ \(name, test) -> do
61− putStrLn $ "Test: " <> name
62− testAgreement test
63− exitWith $ if and results
64− then ExitSuccess
65− else ExitFailure 1
66−
test/Reflex/Test/CrossImpl.hsdeleted−244
@@ -1,244 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE NoMonomorphismRestriction #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−module Reflex.Test.CrossImpl (test) where
16−
17−import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
18−
19−import Control.Monad.Ref
20−import Reflex.Class
21−import Reflex.Dynamic
22−import Reflex.Host.Class
23−import qualified Reflex.Pure as P
24−import qualified Reflex.Spider.Internal as S
25−
26−import Control.Arrow (second, (&&&))
27−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
29−import Control.Monad.Writer hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
30−import Data.Dependent.Map (DSum (..))
31−import Data.Foldable
32−import Data.Map.Strict (Map)
33−import qualified Data.Map.Strict as Map
34−import qualified Data.Set as Set
35−import Data.Traversable
36−import System.Exit
37−import System.Mem
38−
39−import System.IO.Unsafe
40−
41−mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
42−mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
43− Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
44− Just (_, v) -> v
45−
46−mapToPureEvent :: Map Int a -> Event PureReflexDomain a
47−mapToPureEvent m = P.Event $ flip Map.lookup m
48−
49−relevantTestingTimes :: (Map Int a, Map Int b) -> [Int]
50−relevantTestingTimes (b, e) = case Set.minView &&& Set.maxView $ Map.keysSet b `Set.union` Map.keysSet e of
51− (Just (t0, _), Just (t1, _)) -> [t0..t1+1] -- We need to go to b+1 to see the result of the final event
52− _ -> [] -- Doesn't actually make much sense
53−
54−type PureReflexDomain = P.Pure Int
55−type TimeM = (->) Int
56−
57−testPure :: (t ~ PureReflexDomain, m ~ TimeM) => ((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)
58−testPure builder (b, e) =
59− let (P.Behavior b', P.Event e') = ($ 0) $ builder (mapToPureBehavior b, mapToPureEvent e)
60− relevantTimes = relevantTestingTimes (b, e)
61− e'' = Map.mapMaybe id $ Map.fromList $ map (id &&& e') relevantTimes
62− b'' = Map.fromList $ map (id &&& b') relevantTimes
63− in (b'', e'')
64−
65−class MapMSignals a a' t t' | a -> t, a' -> t', a t' -> a', a' t -> a where
66− mapMSignals :: Monad m => (forall b. Behavior t b -> m (Behavior t' b)) -> (forall b. Event t b -> m (Event t' b)) -> a -> m a'
67−
68−instance MapMSignals (Behavior t a) (Behavior t' a) t t' where
69− mapMSignals fb _ = fb
70−
71−instance MapMSignals (Event t a) (Event t' a) t t' where
72− mapMSignals _ fe = fe
73−
74−instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
75− mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
76−
77−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)
78−testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
79− (re, reTrigger) <- newEventWithTriggerRef
80− (rb, rbTrigger) <- newEventWithTriggerRef
81− b <- runHostFrame $ hold (error "testSpider: No value for input behavior yet") rb
82− (b', e') <- runHostFrame $ builder (b, re)
83− e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
84− let times = relevantTestingTimes (bMap, eMap)
85− liftIO performGC
86− outputs <- forM times $ \t -> do
87− forM_ (Map.lookup t bMap) $ \val -> mapM_ (\ rbt -> fireEvents [rbt :=> Identity val]) =<< readRef rbTrigger
88− bOutput <- sample b'
89− eOutput <- fmap join $ forM (Map.lookup t eMap) $ \val -> do
90− mret <- readRef reTrigger
91− let firing = case mret of
92− Just ret -> [ret :=> Identity val]
93− Nothing -> []
94− fireEventsAndRead firing $ sequence =<< readEvent e'Handle
95− liftIO performGC
96− return (t, (bOutput, eOutput))
97− return (Map.fromList $ map (second fst) outputs, Map.mapMaybe id $ Map.fromList $ map (second snd) outputs)
98−
99−tracePerf :: Show a => a -> b -> b
100−tracePerf = flip const
101−
102−testAgreement :: (Eq c, Eq d, Show c, Show d) => (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) -> IO Bool
103−testAgreement builder inputs = do
104− let identityResult = testPure builder inputs
105− tracePerf "---------" $ return ()
106− let spiderResult = testSpider builder inputs
107− tracePerf "---------" $ return ()
108− let resultsAgree = identityResult == spiderResult
109− if resultsAgree
110− then do putStrLn "Success:"
111− print identityResult
112− else do putStrLn "Failure:"
113− putStrLn $ "Pure result: " <> show identityResult
114− putStrLn $ "Spider result: " <> show spiderResult
115− return resultsAgree
116−
117−type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
118−
119−data TestCase = forall a b c d. (Eq c, Eq d, Show c, Show d) => TestCase (Map Int a, Map Int b) (forall m t. TestCaseConstraint t m => (Behavior t a, Event t b) -> m (Behavior t c, Event t d))
120−
121−testCases :: [(String, TestCase)]
122−testCases =
123− [ (,) "hold" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(_, e) -> do
124− b' <- hold "123" e
125− return (b', e)
126− , (,) "count" $ TestCase (Map.singleton 0 (), Map.fromList [(1, ()), (2, ()), (3, ())]) $ \(_, e) -> do
127− e' <- updated <$> count e
128− b' <- hold (0 :: Int) e'
129− return (b', e')
130− , (,) "onceE-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
131− e' <- onceE $ leftmost [e, e]
132− return (b, e')
133− , (,) "switch-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
134− let e' = fmap (const e) e
135− b' <- hold never e'
136− let e'' = switch b'
137− return (b, e'')
138− , (,) "switch-2" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
139− let e' = flip pushAlways e $ const $ do
140− let eab = splitRecombineEvent e
141− switch <$> hold eab never
142− e'' = coincidence e'
143− return (b, e'')
144− , (,) "switch-3" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
145− let e' = flip pushAlways e $ const $ do
146− let eab = splitRecombineEvent e
147− switch <$> hold eab (fmap (const e) e)
148− e'' = coincidence e'
149− return (b, e'')
150− , (,) "switch-4" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
151− let e' = leftmost [e, e]
152− e'' <- switch <$> hold e' (fmap (const e) e)
153− return (b, e'')
154− , (,) "switchPromptly-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
155− let e' = fmap (const e) e
156− e'' <- switchPromptly never e'
157− return (b, e'')
158− , (,) "switchPromptly-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
159− let e' = fmap (const e) e
160− e'' <- switchPromptly never $ leftmost [e', e']
161− return (b, e'')
162− , (,) "switchPromptly-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
163− let e' = leftmost [e, e]
164− e'' <- switchPromptly never (fmap (const e) e')
165− return (b, e'')
166− , (,) "switchPromptly-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
167− let e' = leftmost [e, e]
168− e'' <- switchPromptly never (fmap (const e') e)
169− return (b, e'')
170− , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
171− let e' = leftmost [e, e]
172− e'' <- switch <$> hold never (fmap (const e') e)
173− return (b, e'')
174− , (,) "switchPromptly-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175− let e' = flip push e $ \_ -> do
176− Just <$> onceE e
177− e'' <- switchPromptly never e'
178− return (b, e'')
179− , (,) "switchPromptly-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
180− let e' = flip pushAlways e $ \_ -> do
181− switchPromptly e never
182− e'' <- switchPromptly never e'
183− return (b, e'')
184− , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
185− let e' = flip pushAlways e $ \_ -> return e
186− e'' = coincidence e'
187− return (b, e'')
188− , (,) "coincidence-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
189− let e' = flip pushAlways e $ \_ -> return $ leftmost [e, e]
190− e'' = coincidence e'
191− return (b, e'')
192− , (,) "coincidence-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
193− let e' = flip pushAlways e $ \_ -> return $ coincidence $ fmap (const e) e
194− e'' = coincidence e'
195− return (b, e'')
196− , (,) "coincidence-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
197− let e' = flip pushAlways e $ \_ -> onceE e
198− e'' = coincidence e'
199− return (b, e'')
200− , (,) "coincidence-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer")]) $ \(b, e) -> do
201− let eChild = flip pushAlways e $ const $ do
202− let eNewValues = leftmost [e, e]
203− return $ coincidence $ fmap (const eNewValues) eNewValues
204− e' = coincidence eChild
205− return (b, e')
206− , (,) "coincidence-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer")]) $ \(b, e) -> do
207− let eChild = flip pushAlways e $ const $ do
208− let e' = coincidence $ fmap (const e) e
209− return $ leftmost [e', e']
210− e'' = coincidence eChild
211− return (b, e'')
212− , (,) "coincidence-7" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
213− let e' = leftmost [e, e]
214− eCoincidences = coincidence $ fmap (const e') e
215− return (b, eCoincidences)
216− , (,) "holdWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
217− eo <- onceE e
218− bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
219− let b' = pull $ sample =<< sample bb
220− return (b', e)
221− , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
222− bb <- hold "b" e
223− bd <- hold never . fmap (const e) =<< onceE e
224− eOuter <- pushAlways sample . fmap (const bb) <$> onceE e
225− let eInner = switch bd
226− e' = leftmost [eOuter, eInner]
227− return (b, e')
228− ]
229−
230−splitRecombineEvent :: Reflex t => Event t a -> Event t String
231−splitRecombineEvent e =
232− let ea = "a" <$ e
233− eb = "b" <$ e
234− in leftmost [ea, eb]
235−
236−
237−test :: IO ()
238−test = do
239− results <- forM testCases $ \(name, TestCase inputs builder) -> do
240− putStrLn $ "Test: " <> name
241− testAgreement builder inputs
242− exitWith $ if and results
243− then ExitSuccess
244− else ExitFailure 1
test/Reflex/Test/Micro.hsdeleted−280
@@ -1,280 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE RecursiveDo #-}
9−
10−module Reflex.Test.Micro (testCases) where
11−
12−import Reflex
13−import Reflex.TestPlan
14−
15−import Control.Applicative
16−import Control.Monad
17−import Control.Monad.Fix
18−import Data.Char
19−import Data.Foldable
20−import Data.Functor.Misc
21−import qualified Data.Map as Map
22−import Data.Monoid
23−
24−import Prelude
25−
26−{-# ANN testCases "HLint: ignore Functor law" #-}
27−testCases :: [(String, TestCase)]
28−testCases =
29− [ testB "hold" $ hold "0" =<< events1
30−
31− , testB "count" $ do
32− b <- current <$> (count =<< events2)
33− return $ (+ (0::Int)) <$> b
34−
35− , testB "pull-1" $ do
36− b <- hold "0" =<< events1
37− return (pull $ sample $ pull $ sample b)
38−
39− , testB "pull-2" $ do
40− b1 <- behavior1
41− return (pull $ liftA2 (<>) (sample b1) (sample b1))
42−
43− , testB "pull-3" $ do
44− b1 <- behavior1
45− b2 <- behavior2
46− return (pull $ liftA2 (<>) (sample b1) (sample b2))
47−
48− , testB "pull-4" $ do
49− es <- planList ["a", "b", "c"]
50− e <- plan [(0, ())]
51− b <- hold (constant "") $
52− pushAlways (const $ hold "z" es) e
53− return (join b)
54−
55− , testE "id" $ do
56− events2
57−
58− , testE "fmap-id" $ do
59− e <- events2
60− return $ fmap id e
61−
62− , testE "tag-1" $ do
63− b1 <- behavior1
64− e <- events2
65− return (tag b1 e)
66−
67− , testE "tag-2" $ do
68− b1 <- behavior1
69− e <- events2
70− return (tag (map toUpper <$> b1) e)
71−
72− , testE "attach-1" $ do
73− b1 <- behavior1
74− e <- events2
75− return (attachWith (++) (map toUpper <$> b1) e)
76−
77− , testE "leftmost" $ liftA2 leftmost2 events1 events2
78−
79− , testE "appendEvents-1" $ liftA2 mappend events1 events2
80−
81− , testE "appendEvents-2" $ liftA2 mappend events3 events2
82−
83− , testE "merge-1" $ do
84− e <- events1
85− return $ leftmost ["x" <$ e, "y" <$ e]
86−
87− , testE "merge-2" $ do
88− e <- events1
89− let m = mergeMap $ Map.fromList [(1::Int, "y" <$ e), (2, "z" <$ e)]
90− let ee = flip pushAlways e $ const $ return m
91− return $ coincidence ee
92−
93− , testE "headE-1" $ do
94− e <- events1
95− headE $ leftmost [e, e]
96−
97− , testE "headE-2" $ do
98− e <- events1
99− b <- hold never (e <$ e)
100− headE $ switch b
101−
102− , testE "switch-1" $ do
103− e <- events1
104− b <- hold never (e <$ e)
105− return $ switch b
106−
107− , testE "switch-2" $ do
108− e <- events1
109− return $ coincidence $ flip pushAlways e $ const $ do
110− switch <$> hold (leftmost ["x" <$ e, "y" <$ e, "z" <$ e]) (e <$ e)
111−
112− , testE "switch-3" $ do
113− e <- events1
114− return $ coincidence $ flip pushAlways e $ const $ do
115− switch <$> hold (leftmost ["x" <$ e, "y" <$ e, "z" <$ e]) never
116−
117− , testE "switch-4" $ do
118− e <- events1
119− switch <$> hold (deep e) (e <$ e)
120−
121− , testE "switch-5" $ do
122− e <- events1
123− return $ coincidence $ flip pushAlways e $ const $
124− return $ leftmost ["x" <$ e, "y" <$ e, "z" <$ e]
125−
126− , testE "switch-6" $ do
127− e <- events1
128− return $ coincidence $ flip pushAlways e $ const $ do
129− switch <$> hold ("x" <$ e) (e <$ e)
130−
131− , testE "switchPromptly-1" $ do
132− e <- events1
133− let e' = e <$ e
134− switchPromptly never $ e <$ e'
135−
136− , testE "switchPromptly-2" $ do
137− e <- events1
138− switchPromptly never $ deep (e <$ e)
139−
140− , testE "switchPromptly-3" $ do
141− e <- events1
142− switchPromptly never $ (e <$ deep e)
143−
144− , testE "switchPromptly-4" $ do
145− e <- events1
146− switchPromptly never $ (deep e <$ e)
147−
148− , testE "switch-5" $ do
149− e <- events1
150− switch <$> hold never (deep e <$ e)
151−
152− , testE "switchPromptly-5" $ do
153− e <- events1
154− switchPromptly never $ flip push e $
155− const (Just <$> headE e)
156−
157− , testE "switchPromptly-6" $ do
158− e <- events1
159− switchPromptly never $ flip pushAlways e $
160− const (switchPromptly e never)
161−
162− , testE "coincidence-1" $ do
163− e <- events1
164− return $ coincidence $ flip pushAlways e $
165− const $ return e
166−
167− , testE "coincidence-2" $ do
168− e <- events1
169− return $ coincidence $ flip pushAlways e $
170− const $ return (deep e)
171−
172− , testE "coincidence-3" $ do
173− e <- events1
174− return $ coincidence $ flip pushAlways e $
175− const $ return (coincidence (e <$ e))
176−
177− , testE "coincidence-4" $ do
178− e <- events1
179− return $ coincidence $ flip pushAlways e $
180− const (headE e)
181−
182− , testE "coincidence-5" $ do
183− e <- events1
184− return $ coincidence $ flip pushAlways e $ const $ do
185− let e' = deep e
186− return (coincidence (e' <$ e'))
187−
188− , testE "coincidence-6" $ do
189− e <- events1
190− return $ coincidence $ flip pushAlways e $ const $ do
191− let e' = coincidence (e <$ e)
192− return $ deep e'
193−
194− , testE "coincidence-7" $ do
195− e <- events1
196− return $ coincidence (deep e <$ e)
197−
198− , testB "holdWhileFiring" $ do
199− e <- events1
200− eo <- headE e
201− bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
202− return $ pull $ sample =<< sample bb
203−
204− , testE "joinDyn" $ do
205− e <- events1
206− bb <- hold "b" e
207− bd <- hold never . fmap (const e) =<< headE e
208−
209− eOuter <- pushAlways sample . fmap (const bb) <$> headE e
210− let eInner = switch bd
211− return $ leftmost [eOuter, eInner]
212−
213− , testB "foldDyn" $ do
214− d <- foldDyn (++) "0" =<< events1
215− return (current d)
216−
217− , testB "mapDyn" $ do
218− d <- foldDyn (++) "0" =<< events1
219− return $ current $ fmap (map toUpper) d
220−
221− , testB "combineDyn" $ do
222− d1 <- foldDyn (++) "0" =<< events1
223− d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
224−
225− return $ current $ zipDynWith (<>) d1 d2
226− , testE "fan-1" $ do
227− e <- fmap toMap <$> events1
228− let es = select (fanMap e) . Const2 <$> values
229−
230− return (mergeList es)
231−
232− , testE "fan-2" $ do
233− e <- fmap toMap <$> events3
234− let es = select (fanMap e) . Const2 <$> values
235−
236− return (mergeList es)
237−
238− , testE "fan-3" $ do
239− f <- fanMap . fmap toMap <$> events3
240− return $ select f (Const2 'c')
241−
242− , testE "fan-4" $ do
243− e <- fmap toMap <$> events1
244− return $ toUpper <$> select (fanMap e) (Const2 'a')
245−
246− , testE "fan-5" $ do
247− e <- fmap toMap <$> events2
248− return $ toUpper <$> select (fanMap e) (Const2 'c')
249−
250− , testE "fan-6" $ do
251− f <- fanMap . fmap toMap <$> events1
252− return $ toList <$> mergeList [ select f (Const2 'b'), select f (Const2 'b'), select f (Const2 'e'), select f (Const2 'e') ]
253−
254− , testE "lazy-hold" $ do
255− let lazyHold :: forall t m. (Reflex t, MonadHold t m, MonadFix m) => m (Event t ())
256− lazyHold = do
257− rec !b <- hold never e
258− let e = never <$ switch b
259− return $ void e
260− lazyHold
261−
262− ] where
263−
264− events1, events2, events3 :: TestPlan t m => m (Event t String)
265− events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
266− events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
267−
268− events3 = liftA2 mappend events1 events2
269−
270− values = "abcde"
271− toMap str = Map.fromList $ map (\c -> (c, c)) str
272−
273− behavior1, behavior2 :: forall t m. TestPlan t m => m (Behavior t String)
274− behavior1 = hold "1" =<< events1
275− behavior2 = hold "2" =<< events2
276−
277− deep e = leftmost [e, e]
278− leftmost2 e1 e2 = leftmost [e1, e2]
279−
280−
test/Reflex/TestPlan.hsdeleted−52
@@ -1,52 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE RankNTypes #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE UndecidableInstances #-}
9−module Reflex.TestPlan
10− ( TestPlan(..)
11−
12− , TestCase (..)
13− , testE, testB
14− , TestE, TestB
15−
16− , planList
17−
18− ) where
19−
20−import Control.DeepSeq
21−import Control.Monad.Fix
22−import Data.Word
23−import Reflex.Class
24−
25−
26−import Prelude
27−
28−class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
29− -- | Speicify a plan of an input Event firing
30− -- Occurances must be in the future (i.e. Time > 0)
31− -- Initial specification is
32−
33− plan :: [(Word, a)] -> m (Event t a)
34−
35−
36−planList :: TestPlan t m => [a] -> m (Event t a)
37−planList xs = plan $ zip [1..] xs
38−
39−type TestE a = forall t m. TestPlan t m => m (Event t a)
40−type TestB a = forall t m. TestPlan t m => m (Behavior t a)
41−
42−data TestCase where
43− TestE :: (Show a, Eq a, NFData a) => TestE a -> TestCase
44− TestB :: (Show a, Eq a, NFData a) => TestB a -> TestCase
45−
46−-- Helpers to declare test cases
47−testE :: (Eq a, Show a, NFData a) => String -> TestE a -> (String, TestCase)
48−testE name test = (name, TestE test)
49−
50−testB :: (Eq a, Show a, NFData a) => String -> TestB a -> (String, TestCase)
51−testB name test = (name, TestB test)
52−
test/hlint.hs+34−11
@@ -1,16 +1,39 @@
1−import Language.Haskell.HLint3 (hlint)
1+module Main where
2+
3+import Control.Monad
4+import Language.Haskell.HLint (hlint)
5+import System.Directory
26import System.Exit (exitFailure, exitSuccess)
7+import System.FilePath
8+import System.FilePath.Find
39
410main :: IO ()
511main = do
6− ideas <- hlint
7− [ "."
8− , "--ignore=Redundant do"
9− , "--ignore=Use camelCase"
10− , "--ignore=Redundant $"
11− , "--ignore=Use &&&"
12− , "--ignore=Use const"
13− , "--ignore=Use >=>"
14− , "--ignore=Use ."
15− ]
12+ pwd <- getCurrentDirectory
13+ let runHlint f = hlint $ f:
14+ [ "--ignore=Redundant do"
15+ , "--ignore=Use camelCase"
16+ , "--ignore=Redundant $"
17+ , "--ignore=Use &&"
18+ , "--ignore=Use &&&"
19+ , "--ignore=Use const"
20+ , "--ignore=Use >=>"
21+ , "--ignore=Use ."
22+ , "--ignore=Use unless"
23+ , "--ignore=Reduce duplication"
24+ , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--ignore=Use tuple-section"
26+ , "--ignore=Unused LANGUAGE pragma" -- hlint3 falsely believes that TypeOperators is not needed
27+ ]
28+ recurseInto = and <$> sequence
29+ [ fileType ==? Directory
30+ , fileName /=? ".git"
31+ ]
32+ matchFile = and <$> sequence
33+ [ extension ==? ".hs"
34+ ]
35+ files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
36+ ideas <- fmap concat $ forM files $ \f -> do
37+ putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
38+ runHlint f
1639 if null ideas then exitSuccess else exitFailure
test/semantics.hsdeleted−49
@@ -1,49 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE RankNTypes #-}
7−
8−module Main (main) where
9−
10−import Reflex.Test
11−
12−import Data.Bifunctor
13−import Data.Functor
14−import Data.List
15−import qualified Reflex.Bench.Focused as Focused
16−import qualified Reflex.Test.Micro as Micro
17−
18−import System.Environment
19−import System.Exit
20−
21−import Prelude
22−
23−matchPrefixes :: [String] -> (String -> Bool)
24−matchPrefixes [] = const True
25−matchPrefixes args = \name -> any (`isPrefixOf` name) args
26−
27−
28−main :: IO ()
29−main = do
30− args <- getArgs
31−
32− case args of
33− ["--list"] -> mapM_ putStrLn (fst <$> allTests) >> exitWith (ExitFailure 1)
34− _ -> case filter (matchPrefixes args . fst) allTests of
35− [] -> putStrLn "filter did not match any tests" >> exitWith (ExitFailure 1)
36− tests -> runTests tests
37−
38− where
39− allTests = concat
40− [ makeGroup "micro" Micro.testCases
41− , makeGroup "subscribing (100,40)" (Focused.subscribing 100 40)
42− , makeGroup "firing 1000" (Focused.firing 1000)
43− , makeGroup "merge 100" (Focused.merging 100)
44− , makeGroup "fan 50" (Focused.fans 50)
45− ]
46−
47− makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
48−
49−
test/tests.hsnew file+43
@@ -0,0 +1,43 @@
1+{-# LANGUAGE TemplateHaskell #-}
2+module Main where
3+
4+import Test.HUnit (runTestTT, (~:), assertEqual, errors, failures, test)
5+import Data.Patch ( Patch(apply) )
6+import Data.Patch.MapWithMove ( patchThatChangesMap )
7+import Data.Map as Map ( Map, fromList, singleton )
8+import Hedgehog (checkParallel, discover, Property, property, forAll, PropertyT, (===))
9+import Hedgehog.Gen as Gen ( int )
10+import Hedgehog.Range as Range ( linear )
11+import Control.Monad (replicateM)
12+import System.Exit (exitFailure, exitSuccess)
13+import Data.Sequence as Seq ( foldMapWithIndex, replicateM )
14+
15+main :: IO ()
16+main = do
17+ counts <- runTestTT $ test [
18+ "Simple Move" ~: (do
19+ let mapBefore = Map.fromList [(0,1)]
20+ mapAfter = Map.fromList [(0,0),(1,1)]
21+ patch = patchThatChangesMap mapBefore mapAfter
22+ afterPatch = apply patch mapBefore
23+ assertEqual "Patch creates the same Map" (Just mapAfter) afterPatch),
24+ "Property Checks" ~: propertyChecks
25+ ]
26+ if errors counts + failures counts == 0 then exitSuccess else exitFailure
27+
28+propertyChecks :: IO Bool
29+propertyChecks = checkParallel $$(discover)
30+
31+prop_patchThatChangesMap :: Property
32+prop_patchThatChangesMap = property $ do
33+ mapBefore <- makeRandomIntMap
34+ mapAfter <- makeRandomIntMap
35+ let patch = patchThatChangesMap mapBefore mapAfter
36+ Just mapAfter === apply patch mapBefore
37+
38+makeRandomIntMap :: Monad m => PropertyT m (Map Int Int)
39+makeRandomIntMap = do
40+ let genNum = Gen.int (Range.linear 0 100)
41+ length <- forAll genNum
42+ listOfNumbers <- forAll $ Seq.replicateM length genNum
43+ pure $ Seq.foldMapWithIndex Map.singleton listOfNumbers