on develop help sign in
50 files changed+2266−6339
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+47 .gitignore+4 .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−26 dep/reflex-platform/default.nix+8 dep/reflex-platform/github.json+8 patch.cabal+100 reflex.cabal−127 release.nix+49 src/Data/Functor/Misc.hs+119−57 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−120 src/Reflex.hs−9 src/Reflex/Class.hs−779 src/Reflex/Dynamic.hs−543 src/Reflex/Dynamic/TH.hs−88 src/Reflex/Dynamic/Uniq.hs−101 src/Reflex/Host/Class.hs−282 src/Reflex/Pure.hs−167 src/Reflex/Spider.hs−10 src/Reflex/Spider/Internal.hs−2261 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−279 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+4
@@ -1,4 +1,6 @@
11dist
2+cabal.sandbox.config
3+.cabal-sandbox/
24dist-*
35cabal-dev
46*.o
@@ -32,3 +34,5 @@ hsenv.log
3234.#*
3335/shell.nix
3436/ghci-tmp
37+*.dump-*
38+*.verbose-core2core
.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−26
@@ -1,26 +0,0 @@
1−{ mkDerivation, base, containers, dependent-map, dependent-sum
2−, exception-transformers, haskell-src-exts, haskell-src-meta
3−, MemoTrie, mtl, primitive, ref-tf, semigroups, stdenv, syb
4−, template-haskell, these, transformers, transformers-compat
5−, criterion, deepseq, split, stm, loch-th, hlint
6−}:
7−mkDerivation {
8− pname = "reflex";
9− version = "0.4.0";
10− src = builtins.filterSource (path: type: baseNameOf path != ".git") ./.;
11− libraryHaskellDepends = [
12− base containers dependent-map dependent-sum exception-transformers
13− haskell-src-exts haskell-src-meta mtl primitive ref-tf semigroups
14− syb template-haskell these transformers transformers-compat
15− ];
16− testHaskellDepends = [
17− base containers dependent-map MemoTrie mtl ref-tf
18− # Benchmark dependencies
19− criterion deepseq split stm loch-th
20− # HLint
21− hlint
22− ];
23− homepage = "https://github.com/reflex-frp/reflex";
24− description = "Higher-order Functional Reactive Programming";
25− license = stdenv.lib.licenses.bsd3;
26−}
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−127
@@ -1,127 +0,0 @@
1−Name: reflex
2−Version: 0.4.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− mtl >= 2.1 && < 2.3,
29− primitive >= 0.5 && < 0.7,
30− ref-tf == 0.4.*,
31− semigroupoids >= 4.0 && < 6,
32− semigroups >= 0.16 && < 0.19,
33− stm == 2.4.*,
34− syb >= 0.5 && < 0.7,
35− template-haskell >= 2.9 && < 2.12,
36− these >= 0.4 && < 0.8,
37− transformers >= 0.2,
38− transformers-compat >= 0.3
39−
40− exposed-modules:
41− Data.Functor.Misc,
42− Data.WeakBag,
43− Reflex,
44− Reflex.Class,
45− Reflex.Dynamic,
46− Reflex.Dynamic.TH,
47− Reflex.Dynamic.Uniq,
48− Reflex.Host.Class,
49− Reflex.Pure,
50− Reflex.Spider,
51− Reflex.Spider.Internal
52−
53− other-extensions: TemplateHaskell
54− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
55− ghc-prof-options: -auto-all
56−
57−test-suite semantics
58− type: exitcode-stdio-1.0
59− main-is: semantics.hs
60− hs-source-dirs: test
61− ghc-options: -O2 -Wall -rtsopts
62− build-depends:
63− base,
64− bifunctors,
65− containers,
66− deepseq >= 1.3 && < 1.5,
67− dependent-map,
68− dependent-sum,
69− mtl,
70− ref-tf,
71− reflex,
72− split,
73− transformers >= 0.3
74−
75−test-suite hlint
76− type: exitcode-stdio-1.0
77− main-is: hlint.hs
78− hs-source-dirs: test
79− build-depends: base, hlint == 1.9.*
80− if impl(ghcjs)
81− buildable: False
82−
83−benchmark spider-bench
84− type: exitcode-stdio-1.0
85− hs-source-dirs: bench
86− main-is: Main.hs
87− ghc-options: -Wall -O2 -rtsopts
88− build-depends:
89− base,
90− criterion == 1.1.*,
91− deepseq >= 1.3 && < 1.5,
92− dependent-map,
93− dependent-sum,
94− mtl,
95− primitive,
96− reflex,
97− stm,
98− transformers >= 0.3
99−
100−benchmark saulzar-bench
101− type: exitcode-stdio-1.0
102− hs-source-dirs: bench test
103− c-sources: bench-cbits/checkCapability.c
104− main-is: RunAll.hs
105− ghc-options: -Wall -O2 -rtsopts -threaded
106− ghc-prof-options: -auto-all
107− build-depends:
108− base,
109− containers == 0.5.*,
110− criterion == 1.1.*,
111− deepseq >= 1.3 && < 1.5,
112− dependent-map,
113− dependent-sum,
114− loch-th,
115− mtl,
116− primitive,
117− process,
118− ref-tf,
119− reflex,
120− split,
121− stm,
122− time,
123− transformers >= 0.3
124−
125−source-repository head
126− type: git
127− 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−57
@@ -1,8 +1,10 @@
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 #-}
@@ -12,34 +14,42 @@
1214-- which are relevant to the use of 'Functor'-based datastructures like
1315-- 'Data.Dependent.Map.DMap'.
1416module Data.Functor.Misc
15− ( -- * Const2
16− Const2 (..)
17− , dmapToMap
18− , mapToDMap
19− -- * WrapArg
20− , WrapArg (..)
21− -- * Convenience functions for DMap
22− , mapWithFunctorToDMap
23− , combineDMapsWithKey
24− -- * Deprecated functions
25− , sequenceDmap
26− , wrapDMap
27− , rewrapDMap
28− , unwrapDMap
29− , unwrapDMapMaybe
30− , extractFunctorDMap
31− ) where
32−
33−import Control.Applicative (Applicative, (<$>))
34−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 ((<$>))
3540import Data.Dependent.Map (DMap)
3641import qualified Data.Dependent.Map as DMap
3742import Data.Dependent.Sum
43+import Data.Functor.Identity
3844import Data.GADT.Compare
3945import Data.GADT.Show
46+import Data.IntMap (IntMap)
47+import qualified Data.IntMap as IntMap
4048import Data.Map (Map)
4149import qualified Data.Map as Map
50+import Data.Some (Some, mkSome)
4251import Data.These
52+import Data.Type.Equality ((:~:)(Refl))
4353import Data.Typeable hiding (Refl)
4454
4555--------------------------------------------------------------------------------
@@ -52,14 +62,18 @@ data Const2 :: * -> x -> x -> * where
5262 Const2 :: k -> Const2 k v v
5363 deriving (Typeable)
5464
55−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)
5673
5774instance Show k => GShow (Const2 k v) where
5875 gshowsPrec n x@(Const2 _) = showsPrec n x
5976
60−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
61− showTaggedPrec (Const2 _) = showsPrec
62−
6377instance Eq k => GEq (Const2 k v) where
6478 geq (Const2 a) (Const2 b) =
6579 if a == b
@@ -76,6 +90,15 @@ instance Ord k => GCompare (Const2 k v) where
7690dmapToMap :: DMap (Const2 k v) Identity -> Map k v
7791dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
7892
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+
79102-- | Convert a regular 'Map' to a 'DMap'
80103mapToDMap :: Map k v -> DMap (Const2 k v) Identity
81104mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
@@ -85,6 +108,16 @@ mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v)
85108mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
86109mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
87110
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+
88121--------------------------------------------------------------------------------
89122-- WrapArg
90123--------------------------------------------------------------------------------
@@ -95,6 +128,11 @@ mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v
95128data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
96129 WrapArg :: f a -> WrapArg g f (g a)
97130
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+
98136instance GEq f => GEq (WrapArg g f) where
99137 geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
100138
@@ -132,38 +170,62 @@ combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList m
132170 GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
133171 GGT -> (hk :=> f hk (That hv)) : go gs hs'
134172
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+
135221--------------------------------------------------------------------------------
136−-- Deprecated functions
222+-- ComposeMaybe
137223--------------------------------------------------------------------------------
138224
139−{-# INLINE sequenceDmap #-}
140−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ t -> fmap Identity t)' instead" #-}
141−-- | Run the actions contained in the 'DMap'
142−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
143−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
144−
145−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
146−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
147−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
148−wrapDMap f = DMap.map $ f . runIdentity
149−
150−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
151−-- | Replace one functor for a 'DMap''s values with a different functor
152−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
153−rewrapDMap = DMap.map
154−
155−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
156−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
157−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
158−unwrapDMap f = DMap.map $ Identity . f
159−
160−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
161−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
162−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
163−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
164−
165−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
166−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
167−-- underlying functor
168−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
169−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−120
@@ -1,120 +0,0 @@
1−-- | This module defines the 'WeakBag' type, which represents a mutable
2−-- collection of items that does not cause the items to be retained in memory.
3−-- This is useful for situations where a value needs to be inspected or modified
4−-- if it is still alive, but can be ignored if it is dead.
5−module Data.WeakBag
6− ( WeakBag
7− , WeakBagTicket
8− , empty
9− , singleton
10− , insert
11− , traverse
12− , remove
13− ) where
14−
15−import Control.Concurrent.STM
16−import Control.Exception
17−import Control.Monad hiding (forM_, mapM_)
18−import Control.Monad.IO.Class
19−import Data.Foldable (forM_, mapM_)
20−import Data.IntMap.Strict (IntMap)
21−import qualified Data.IntMap.Strict as IntMap
22−import Data.IORef
23−import System.Mem.Weak
24−
25−import Prelude hiding (mapM_, traverse)
26−
27−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
28−-- that is, they can still be garbage-collected. As long as the @a@s remain
29−-- alive, the 'WeakBag' will continue to refer to them.
30−data WeakBag a = WeakBag
31− { _weakBag_nextId :: {-# UNPACK #-} !(TVar Int) --TODO: what if this wraps around?
32− , _weakBag_children :: {-# UNPACK #-} !(TVar (IntMap (Weak a)))
33− }
34−
35−-- | When inserting an item into a 'WeakBag', a 'WeakBagTicket' is returned. If
36−-- the caller retains the ticket, the item is guranteed to stay in memory (and
37−-- thus in the 'WeakBag'). The ticket can also be used to remove the item from
38−-- the 'WeakBag' prematurely (i.e. while it is still alive), using 'remove'.
39−data WeakBagTicket a = WeakBagTicket
40− { _weakBagTicket_weakItem :: {-# UNPACK #-} !(Weak a)
41− , _weakBagTicket_item :: {-# NOUNPACK #-} !a
42− }
43−
44−-- | Insert an item into a 'WeakBag'.
45−{-# INLINE insert #-}
46−insert :: a -- ^ The item
47− -> WeakBag a -- ^ The 'WeakBag' to insert into
48− -> IORef (Weak b) -- ^ An arbitrary value to be used in the following
49− -- callback
50− -> (b -> IO ()) -- ^ A callback to be invoked when the item is removed
51− -- (whether automatically by the item being garbage
52− -- collected or manually via 'remove')
53− -> IO (WeakBagTicket a) -- ^ Returns a 'WeakBagTicket' that ensures the
54− -- item is retained and allows the item to be
55− -- removed.
56−insert a (WeakBag nextId children) wbRef finalizer = {-# SCC "insert" #-} do
57− a' <- evaluate a
58− wbRef' <- evaluate wbRef
59− myId <- atomically $ do
60− myId <- readTVar nextId
61− writeTVar nextId $! succ myId
62− return myId
63− let cleanup = do
64− wb <- readIORef wbRef'
65− mb <- deRefWeak wb
66− forM_ mb $ \b -> do
67− isLastNode <- atomically $ do --TODO: Should this run even when mb is Nothing?
68− cs <- readTVar children
69− let csWithoutMe = IntMap.delete myId cs
70− writeTVar children $! csWithoutMe
71− return $ IntMap.size csWithoutMe == 0
72− when isLastNode $ finalizer b
73− return ()
74− return ()
75− wa <- mkWeakPtr a' $ Just cleanup
76− atomically $ modifyTVar' children $ IntMap.insert myId wa
77− return $ WeakBagTicket
78− { _weakBagTicket_weakItem = wa
79− , _weakBagTicket_item = a'
80− }
81−
82−-- | Create an empty 'WeakBag'.
83−{-# INLINE empty #-}
84−empty :: IO (WeakBag a)
85−empty = {-# SCC "empty" #-} do
86− nextId <- newTVarIO 1
87− children <- newTVarIO IntMap.empty
88− let bag = WeakBag
89− { _weakBag_nextId = nextId
90− , _weakBag_children = children
91− }
92− return bag
93−
94−-- | Create a 'WeakBag' with one item; equivalent to creating the 'WeakBag' with
95−-- 'empty', then using 'insert'.
96−{-# INLINE singleton #-}
97−singleton :: a -> IORef (Weak b) -> (b -> IO ()) -> IO (WeakBag a, WeakBagTicket a)
98−singleton a wbRef finalizer = {-# SCC "singleton" #-} do
99− bag <- empty
100− ticket <- insert a bag wbRef finalizer
101− return (bag, ticket)
102−
103−{-# INLINE traverse #-}
104−-- | Visit every node in the given list. If new nodes are appended during the
105−-- traversal, they will not be visited. Every live node that was in the list
106−-- when the traversal began will be visited exactly once; however, no guarantee
107−-- is made about the order of the traversal.
108−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
109−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
110− cs <- liftIO $ readTVarIO children
111− forM_ cs $ \c -> do
112− ma <- liftIO $ deRefWeak c
113− mapM_ f ma
114−
115−-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
116−-- on the same 'WeakBagTicket'.
117−{-# INLINE remove #-}
118−remove :: WeakBagTicket a -> IO ()
119−remove = {-# SCC "remove" #-} finalize . _weakBagTicket_weakItem
120−--TODO: Should 'remove' also drop the reference to the item?
src/Reflex.hsdeleted−9
@@ -1,9 +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.Spider as X
src/Reflex/Class.hsdeleted−779
@@ -1,779 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE NoMonomorphismRestriction #-}
9−{-# LANGUAGE RankNTypes #-}
10−{-# LANGUAGE RecursiveDo #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−
16−-- | This module contains the Reflex interface, as well as a variety of
17−-- convenience functions for working with 'Event's, 'Behavior's, and other
18−-- signals.
19−module Reflex.Class
20− ( -- * Primitives
21− Reflex (..)
22− , MonadSample (..)
23− , MonadHold (..)
24− -- ** 'fan'-related types
25− , EventSelector (..)
26− -- ** 'Incremental'-related types
27− , Patch (..)
28− , PatchDMap (..)
29− -- * Convenience functions
30− , constDyn
31− , pushAlways
32− -- ** Combining 'Event's
33− , leftmost
34− , mergeMap
35− , mergeList
36− , mergeWith
37− -- ** Breaking up 'Event's
38− , splitE
39− , fanMap
40− , dmapToThese
41− , EitherTag (..)
42− , eitherToDSum
43− , dsumToEither
44− -- ** Switching between 'Event's
45− , switchPromptly
46− -- ** Using 'Event's to sample 'Behavior's
47− , tag
48− , attach
49− , attachWith
50− , attachWithMaybe
51− -- ** Blocking an 'Event' based on a 'Behavior'
52− , gate
53− -- ** Combining 'Dynamic's
54− , distributeDMapOverDynPure
55− , zipDyn
56− , zipDynWith
57− -- ** Accumulating state
58− , Accumulator (..)
59− , mapAccum_
60− , mapAccumM_
61− , mapAccumMaybe_
62− , mapAccumMaybeM_
63− , zipListWithEvent
64− , headE
65− , tailE
66− , switcher
67− -- * Debugging functions
68− , traceEvent
69− , traceEventWith
70− -- * Unsafe functions
71− , unsafeDynamic
72− -- * 'FunctorMaybe'
73− , FunctorMaybe (..)
74− , fforMaybe
75− , ffilter
76− -- * Miscellaneous convenience functions
77− , ffor
78− -- * Deprecated functions
79− , appendEvents
80− , onceE
81− , sequenceThese
82− ) where
83−
84−import Control.Applicative
85−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
86−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
87−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
88−import Control.Monad.Trans.Cont (ContT ())
89−import Control.Monad.Trans.Except (ExceptT ())
90−import Control.Monad.Trans.RWS (RWST ())
91−import Control.Monad.Trans.Writer (WriterT ())
92−import Data.Align
93−import Data.Bifunctor
94−import Data.Dependent.Map (DMap, DSum (..), GCompare (..), GOrdering (..))
95−import qualified Data.Dependent.Map as DMap
96−import Data.Dependent.Sum (ShowTag (..))
97−import Data.Foldable
98−import Data.Functor.Bind hiding (join)
99−import qualified Data.Functor.Bind as Bind
100−import Data.Functor.Compose
101−import Data.Functor.Constant
102−import Data.Functor.Misc
103−import Data.Functor.Plus
104−import Data.GADT.Compare ((:~:) (..), GEq (..))
105−import Data.GADT.Show (GShow (..))
106−import Data.List.NonEmpty (NonEmpty (..))
107−import Data.Map (Map)
108−import Data.Maybe
109−import Data.Monoid hiding (Alt, (<>))
110−import Data.Semigroup (Semigroup, sconcat, stimes, stimesIdempotentMonoid, (<>))
111−import Data.String
112−import Data.These
113−import Data.Traversable
114−
115−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
116−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
117−
118−import Debug.Trace (trace)
119−
120−-- | The 'Reflex' class contains all the primitive functionality needed for
121−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
122−-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
123−-- and the type of the timeline determines the FRP engine to be used. For most
124−-- purposes, the 'Reflex.Spider' implementation is recommended.
125−class ( MonadHold t (PushM t)
126− , MonadSample t (PullM t)
127− , MonadFix (PushM t)
128− , Functor (Event t)
129− , Functor (Behavior t)
130− , Functor (Dynamic t)
131− , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
132− , Monad (Dynamic t)
133− ) => Reflex t where
134− -- | A container for a value that can change over time. 'Behavior's can be
135− -- sampled at will, but it is not possible to be notified when they change
136− data Behavior t :: * -> *
137− -- | A stream of occurrences. During any given frame, an 'Event' is either
138− -- occurring or not occurring; if it is occurring, it will contain a value of
139− -- the given type (its "occurrence type")
140− data Event t :: * -> *
141− -- | A container for a value that can change over time and allows
142− -- notifications on changes. Basically a combination of a 'Behavior' and an
143− -- 'Event', with a rule that the 'Behavior' will change if and only if the
144− -- 'Event' fires.
145− data Dynamic t :: * -> *
146− -- | A container for a value that can change over time and allows
147− -- notifications on changes. Basically a combination of a 'Behavior' and an
148− -- 'Event', with a rule that the 'Behavior' will change if and only if the
149− -- 'Event' fires.
150− data Incremental t :: (* -> *) -> * -> *
151− -- | An 'Event' with no occurrences
152− never :: Event t a
153− -- | Create a 'Behavior' that always has the given value
154− 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
155− -- | Create an 'Event' from another 'Event'; the provided function can sample
156− -- 'Behavior's and hold 'Event's, and use the results to produce a occurring
157− -- (Just) or non-occurring (Nothing) result
158− push :: (a -> PushM t (Maybe b)) -> Event t a -> Event t b
159− -- | A monad for doing complex push-based calculations efficiently
160− type PushM t :: * -> *
161− -- | Create a 'Behavior' by reading from other 'Behavior's; the result will be
162− -- recomputed whenever any of the read 'Behavior's changes
163− pull :: PullM t a -> Behavior t a
164− -- | A monad for doing complex pull-based calculations efficiently
165− type PullM t :: * -> *
166− -- | Merge a collection of events; the resulting 'Event' will only occur if at
167− -- least one input event is occuring, and will contain all of the input keys
168− -- that are occurring simultaneously
169− 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
170− -- | Efficiently fan-out an event to many destinations. This function should
171− -- be partially applied, and then the result applied repeatedly to create
172− -- child events
173− 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
174− -- | Create an 'Event' that will occur whenever the currently-selected input
175− -- 'Event' occurs
176− switch :: Behavior t (Event t a) -> Event t a
177− -- | Create an 'Event' that will occur whenever the input event is occurring
178− -- and its occurrence value, another 'Event', is also occurring
179− coincidence :: Event t (Event t a) -> Event t a
180− -- | Extract the 'Behavior' of a 'Dynamic'.
181− current :: Dynamic t a -> Behavior t a
182− -- | Extract the 'Event' of the 'Dynamic'.
183− updated :: Dynamic t a -> Event t a
184− -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
185− -- recent firing of the given 'Event', if any.
186− unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
187− -- | Create a new 'Incremental'. The given 'PullM''s value must always change
188− -- in the same way that the accumulated application of patches would change
189− -- that value.
190− unsafeBuildIncremental :: Patch p => PullM t a -> Event t (p a) -> Incremental t p a
191− -- | Create a merge whose parents can change over time
192− mergeIncremental :: GCompare k => Incremental t PatchDMap (DMap k (Event t)) -> Event t (DMap k Identity)
193− -- | Extract the 'Behavior' component of an 'Incremental'
194− currentIncremental :: Patch p => Incremental t p a -> Behavior t a
195− -- | Extract the 'Event' component of an 'Incremental'
196− updatedIncremental :: Patch p => Incremental t p a -> Event t (p a)
197− -- | Convert an 'Incremental' to a 'Dynamic'
198− incrementalToDynamic :: Patch p => Incremental t p a -> Dynamic t a
199−
200−-- | A 'Patch' type represents a kind of change made to a datastructure.
201−class Patch p where
202− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
203− -- 'Nothing'.
204− apply :: p a -> a -> Maybe a
205−
206−instance Patch Identity where
207− apply (Identity a) _ = Just a
208−
209−-- | A set of changes to a 'DMap'. Only DMap types are allowed for @a@.
210−data PatchDMap a where
211− PatchDMap :: GCompare k => DMap k (Compose Maybe v) -> PatchDMap (DMap k v)
212−
213−instance GCompare k => Semigroup (PatchDMap (DMap k v)) where
214− PatchDMap a <> PatchDMap b = PatchDMap $ a `mappend` b --TODO: Add a semigroup instance for DMap
215− -- PatchDMap is idempotent, so stimes n is id for every n
216−#if MIN_VERSION_semigroups(0,17,0)
217− stimes = stimesIdempotentMonoid
218−#else
219− times1p n x = case compare n 0 of
220− LT -> error "stimesIdempotentMonoid: negative multiplier"
221− EQ -> mempty
222− GT -> x
223−#endif
224−
225−instance GCompare k => Monoid (PatchDMap (DMap k v)) where
226− mempty = PatchDMap mempty
227− mappend = (<>)
228−
229−instance Patch PatchDMap where
230− 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?
231− where insertions = DMap.mapMaybeWithKey (const $ getCompose) diff
232− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getCompose) diff
233− nothingToJust = \case
234− Nothing -> Just $ Constant ()
235− Just _ -> Nothing
236−
237−-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
238−-- _must_ change when and only when the 'Event' fires, such that the
239−-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
240−-- if this is not the case, the resulting 'Dynamic' will behave
241−-- nondeterministically.
242−unsafeDynamic :: Reflex t => Behavior t a -> Event t a -> Dynamic t a
243−unsafeDynamic = unsafeBuildDynamic . sample
244−
245−-- | Construct a 'Dynamic' value that never changes
246−constDyn :: Reflex t => a -> Dynamic t a
247−constDyn = pure
248−
249−-- | 'MonadSample' designates monads that can read the current value of a
250−-- 'Behavior'. This includes both 'PullM' and 'PushM'.
251−class (Applicative m, Monad m) => MonadSample t m | m -> t where
252− -- | Get the current value in the 'Behavior'
253− sample :: Behavior t a -> m a
254−
255−-- | 'MonadHold' designates monads that can create new 'Behavior's based on
256−-- 'Event's; usually this will be 'PushM' or a monad based on it. 'MonadHold'
257−-- is required to create any stateful computations with Reflex.
258−class MonadSample t m => MonadHold t m where
259− -- | Create a new 'Behavior' whose value will initially be equal to the given
260− -- value and will be updated whenever the given 'Event' occurs. The update
261− -- takes effect immediately after the 'Event' occurs; if the occurrence that
262− -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
263− -- the 'Behavior', it will see the _old_ value of the 'Behavior', not the new
264− -- one.
265− hold :: a -> Event t a -> m (Behavior t a)
266− -- | Create a 'Dynamic' value using the given initial value that changes every
267− -- time the 'Event' occurs.
268− holdDyn :: a -> Event t a -> m (Dynamic t a)
269− -- | Create an 'Incremental' value using the given initial value that changes
270− -- every time the 'Event' occurs.
271− holdIncremental :: Patch p => a -> Event t (p a) -> m (Incremental t p a)
272−
273−-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
274−-- key. This is much more efficient than filtering for each key with
275−-- 'fmapMaybe'.
276−newtype EventSelector t k = EventSelector
277− { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
278− -- determined by the type of the key, so this can be used to fan-out
279− -- 'Event's whose sub-'Event's have different types.
280− --
281− -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
282− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
283− -- occurrences of an 'Event'.
284− select :: forall a. k a -> Event t a
285− }
286−
287−--------------------------------------------------------------------------------
288−-- Instances
289−--------------------------------------------------------------------------------
290−
291−instance MonadSample t m => MonadSample t (ReaderT r m) where
292− sample = lift . sample
293−
294−instance MonadHold t m => MonadHold t (ReaderT r m) where
295− hold a0 = lift . hold a0
296− holdDyn a0 = lift . holdDyn a0
297− holdIncremental a0 = lift . holdIncremental a0
298−
299−instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
300− sample = lift . sample
301−
302−instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
303− hold a0 = lift . hold a0
304− holdDyn a0 = lift . holdDyn a0
305− holdIncremental a0 = lift . holdIncremental a0
306−
307−instance MonadSample t m => MonadSample t (StateT s m) where
308− sample = lift . sample
309−
310−instance MonadHold t m => MonadHold t (StateT s m) where
311− hold a0 = lift . hold a0
312− holdDyn a0 = lift . holdDyn a0
313− holdIncremental a0 = lift . holdIncremental a0
314−
315−instance MonadSample t m => MonadSample t (ExceptT e m) where
316− sample = lift . sample
317−
318−instance MonadHold t m => MonadHold t (ExceptT e m) where
319− hold a0 = lift . hold a0
320− holdDyn a0 = lift . holdDyn a0
321− holdIncremental a0 = lift . holdIncremental a0
322−
323−instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
324− sample = lift . sample
325−
326−instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
327− hold a0 = lift . hold a0
328− holdDyn a0 = lift . holdDyn a0
329− holdIncremental a0 = lift . holdIncremental a0
330−
331−instance MonadSample t m => MonadSample t (ContT r m) where
332− sample = lift . sample
333−
334−instance MonadHold t m => MonadHold t (ContT r m) where
335− hold a0 = lift . hold a0
336− holdDyn a0 = lift . holdDyn a0
337− holdIncremental a0 = lift . holdIncremental a0
338−
339−--------------------------------------------------------------------------------
340−-- Convenience functions
341−--------------------------------------------------------------------------------
342−
343−-- | Create an 'Event' from another 'Event'. The provided function can sample
344−-- 'Behavior's and hold 'Event's.
345−pushAlways :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
346−pushAlways f = push (fmap Just . f)
347−
348−-- | Flipped version of 'fmap'.
349−ffor :: Functor f => f a -> (a -> b) -> f b
350−ffor = flip fmap
351−
352−instance Reflex t => Applicative (Behavior t) where
353− pure = constant
354− f <*> x = pull $ sample f `ap` sample x
355− _ *> b = b
356− a <* _ = a
357−
358−instance Reflex t => Apply (Behavior t) where
359− (<.>) = (<*>)
360−
361−instance Reflex t => Bind (Behavior t) where
362− (>>-) = (>>=)
363−
364−instance (Reflex t, Fractional a) => Fractional (Behavior t a) where
365− (/) = liftA2 (/)
366− fromRational = pure . fromRational
367− recip = fmap recip
368−
369−instance Reflex t => Functor (Behavior t) where
370− fmap f = pull . fmap f . sample
371−
372−instance (Reflex t, IsString a) => IsString (Behavior t a) where
373− fromString = pure . fromString
374−
375−instance Reflex t => Monad (Behavior t) where
376− a >>= f = pull $ sample a >>= sample . f
377− -- 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.
378− return = constant
379− fail = error "Monad (Behavior t) does not support fail"
380−
381−instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
382− mempty = constant mempty
383− mappend a b = pull $ liftM2 mappend (sample a) (sample b)
384− mconcat = pull . fmap mconcat . mapM sample
385−
386−instance (Reflex t, Num a) => Num (Behavior t a) where
387− (+) = liftA2 (+)
388− (-) = liftA2 (-)
389− (*) = liftA2 (*)
390− abs = fmap abs
391− fromInteger = pure . fromInteger
392− negate = fmap negate
393− signum = fmap signum
394−
395−instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
396− a <> b = pull $ liftM2 (<>) (sample a) (sample b)
397− sconcat = pull . fmap sconcat . mapM sample
398−#if MIN_VERSION_semigroups(0,17,0)
399− stimes n = fmap $ stimes n
400−#else
401− times1p n = fmap $ times1p n
402−#endif
403−
404−--TODO: See if there's a better class in the standard libraries already
405−-- | A class for values that combines filtering and mapping using 'Maybe'.
406−class FunctorMaybe f where
407− -- | Combined mapping and filtering function.
408− fmapMaybe :: (a -> Maybe b) -> f a -> f b
409−
410−instance FunctorMaybe [] where
411− fmapMaybe f = catMaybes . fmap f
412−
413−-- | Flipped version of 'fmapMaybe'.
414−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
415−fforMaybe = flip fmapMaybe
416−
417−-- | Filter 'f a' using the provided predicate.
418−-- Relies on 'fforMaybe'.
419−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
420−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
421−
422−-- | Left-biased event union (prefers left event on simultaneous
423−-- occurrence).
424−instance Reflex t => Alt (Event t) where
425− ev1 <!> ev2 = leftmost [ev1, ev2]
426−
427−-- | 'Event' intersection (convenient interface to 'coincidence').
428−instance Reflex t => Apply (Event t) where
429− evf <.> evx = coincidence (fmap (<$> evx) evf)
430−
431−-- | 'Event' intersection (convenient interface to 'coincidence').
432−instance Reflex t => Bind (Event t) where
433− evx >>- f = coincidence (f <$> evx)
434− join = coincidence
435−
436−instance Reflex t => Functor (Event t) where
437− fmap f = fmapMaybe $ Just . f
438−
439−instance Reflex t => FunctorMaybe (Event t) where
440− fmapMaybe f = push $ return . f
441−
442−-- | Never: @'zero' = 'never'@.
443−instance Reflex t => Plus (Event t) where
444− zero = never
445−
446−-- | Replace each occurrence value of the 'Event' with the value of the
447−-- 'Behavior' at the time of that occurrence.
448−tag :: Reflex t => Behavior t b -> Event t a -> Event t b
449−tag b = pushAlways $ \_ -> sample b
450−
451−-- | Create a new 'Event' that combines occurences of supplied 'Event' with the
452−-- current value of the 'Behavior'.
453−attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
454−attach = attachWith (,)
455−
456−-- | Create a new 'Event' that occurs when the supplied 'Event' occurs by
457−-- combining it with the current value of the 'Behavior'.
458−attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
459−attachWith f = attachWithMaybe $ \a b -> Just $ f a b
460−
461−-- | Create a new 'Event' by combining each occurence with the current value of
462−-- the 'Behavior'. The occurrence is discarded if the combining function returns
463−-- Nothing
464−attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
465−attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
466−
467−-- | Create a new 'Event' that only occurs only once, on the first occurence of
468−-- the supplied 'Event'.
469−headE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
470−headE e = do
471− rec be <- hold e $ fmap (const never) e'
472− let e' = switch be
473− return e'
474−
475−-- | Create a new 'Event' that occurs on all but the first occurence of the
476−-- supplied 'Event'.
477−tailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
478−tailE e = snd <$> headTailE e
479−
480−-- | Create a tuple of two 'Event's with the first one occuring only the first
481−-- time the supplied 'Event' occurs and the second occuring on all but the first
482−-- occurence.
483−headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
484−headTailE e = do
485− eHead <- headE e
486− be <- hold never $ fmap (const e) eHead
487− return (eHead, switch be)
488−
489−-- | Split the supplied 'Event' into two individual 'Event's occuring at the
490−-- same time with the respective values from the tuple.
491−splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
492−splitE e = (fmap fst e, fmap snd e)
493−
494−-- | Print the supplied 'String' and the value of the 'Event' on each
495−-- occurence. This should /only/ be used for debugging.
496−--
497−-- Note: As with Debug.Trace.trace, the message will only be printed if the
498−-- 'Event' is actually used.
499−traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
500−traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
501−
502−-- | Print the output of the supplied function on each occurence of the
503−-- 'Event'. This should /only/ be used for debugging.
504−--
505−-- Note: As with Debug.Trace.trace, the message will only be printed if the
506−-- 'Event' is actually used.
507−traceEventWith :: Reflex t => (a -> String) -> Event t a -> Event t a
508−traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
509−
510−-- | Tag type for 'Either' to use it as a 'DSum'.
511−data EitherTag l r a where
512− LeftTag :: EitherTag l r l
513− RightTag :: EitherTag l r r
514−
515−instance GEq (EitherTag l r) where
516− geq a b = case (a, b) of
517− (LeftTag, LeftTag) -> Just Refl
518− (RightTag, RightTag) -> Just Refl
519− _ -> Nothing
520−
521−instance GCompare (EitherTag l r) where
522− gcompare a b = case (a, b) of
523− (LeftTag, LeftTag) -> GEQ
524− (LeftTag, RightTag) -> GLT
525− (RightTag, LeftTag) -> GGT
526− (RightTag, RightTag) -> GEQ
527−
528−instance GShow (EitherTag l r) where
529− gshowsPrec _ a = case a of
530− LeftTag -> showString "LeftTag"
531− RightTag -> showString "RightTag"
532−
533−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
534− showTaggedPrec t n (Identity a) = case t of
535− LeftTag -> showsPrec n a
536− RightTag -> showsPrec n a
537−
538−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
539−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
540−eitherToDSum = \case
541− Left a -> (LeftTag :=> Identity a)
542− Right b -> (RightTag :=> Identity b)
543−
544−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
545−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
546−dsumToEither = \case
547− (LeftTag :=> Identity a) -> Left a
548− (RightTag :=> Identity b) -> Right b
549−
550−-- | Extract the values of a 'DMap' of 'EitherTag's.
551−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
552−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
553− (Nothing, Nothing) -> Nothing
554− (Just (Identity a), Nothing) -> Just $ This a
555− (Nothing, Just (Identity b)) -> Just $ That b
556− (Just (Identity a), Just (Identity b)) -> Just $ These a b
557−
558−instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
559− (<>) = alignWith (mergeThese (<>))
560− sconcat = fmap sconcat . mergeList . toList
561−#if MIN_VERSION_semigroups(0,17,0)
562− stimes n = fmap $ stimes n
563−#else
564− times1p n = fmap $ times1p n
565−#endif
566−
567−instance (Semigroup a, Reflex t) => Monoid (Event t a) where
568− mempty = never
569− mappend = (<>)
570− mconcat = fmap sconcat . mergeList
571−
572−-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
573−-- list occurs. If multiple occur at the same time they are folded from the left
574−-- with the given function.
575−mergeWith :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
576−mergeWith f es = fmap (Prelude.foldl1 f . map (\(Const2 _ :=> Identity v) -> v) . DMap.toList)
577− . merge
578− . DMap.fromDistinctAscList
579− . map (\(k, v) -> Const2 k :=> v)
580− $ zip [0 :: Int ..] es
581−
582−-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
583−-- list occurs. If multiple occur at the same time the value is the value of the
584−-- leftmost event.
585−leftmost :: Reflex t => [Event t a] -> Event t a
586−leftmost = mergeWith const
587−
588−-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
589−-- list occurs and has a list of the values of all 'Event's occuring at that
590−-- time.
591−mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
592−mergeList [] = never
593−mergeList es = mergeWith (<>) $ map (fmap (:|[])) es
594−
595−-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
596−-- occurs if at least one of them occurs and has a map of values of all 'Event's
597−-- occuring at that time.
598−mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
599−mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
600−
601−-- | Split the event into an 'EventSelector' that allows efficient selection of
602−-- the individual 'Event's.
603−fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
604−fanMap = fan . fmap mapToDMap
605−
606−-- | Switches to the new event whenever it receives one; the new event is used
607−-- immediately, on the same frame that it is switched to
608−switchPromptly :: forall t m a. (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
609−switchPromptly ea0 eea = do
610− bea <- hold ea0 eea
611− let eLag = switch bea
612− eCoincidences = coincidence eea
613− return $ leftmost [eCoincidences, eLag]
614−
615−instance Reflex t => Align (Event t) where
616− nil = never
617− align ea eb = fmapMaybe dmapToThese $ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
618−
619−-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
620−-- the 'Behavior' is true at the time of occurence.
621−gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
622−gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
623−
624−-- | Create a new behavior given a starting behavior and switch to a the behvior
625−-- carried by the event when it fires.
626−switcher :: (Reflex t, MonadHold t m)
627− => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
628−switcher b eb = pull . (sample <=< sample) <$> hold b eb
629−
630−-- | Combine two 'Dynamic's. The result will change whenever either (or both)
631−-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
632−zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
633−zipDyn = zipDynWith (,)
634−
635−-- | Combine two 'Dynamic's with a combining function. The result will change
636−-- whenever either (or both) input 'Dynamic' changes.
637−zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
638−zipDynWith f da db =
639− let eab = align (updated da) (updated db)
640− ec = flip push eab $ \o -> do
641− (a, b) <- case o of
642− This a -> do
643− b <- sample $ current db
644− return (a, b)
645− That b -> do
646− a <- sample $ current da
647− return (a, b)
648− These a b -> return (a, b)
649− return $ Just $ f a b
650− in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
651−
652−instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
653− mconcat = fmap (mconcat . map (\(Const2 _ :=> Identity v) -> v) . DMap.toList) . distributeDMapOverDynPure . DMap.fromList . map (\(k, v) -> Const2 k :=> v) . zip [0 :: Int ..]
654− mempty = constDyn mempty
655− mappend = zipDynWith mappend
656−
657−-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
658−-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
659−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
660−distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
661−distributeDMapOverDynPure dm = case DMap.toList dm of
662− [] -> constDyn DMap.empty
663− [k :=> v] -> fmap (DMap.singleton k . Identity) v
664− _ ->
665− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
666− edmPre = merge $ DMap.map updated dm
667− result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
668− olds <- sample $ current result
669− return $ DMap.unionWithKey (\_ _ new -> new) olds news
670− in result
671−
672−--------------------------------------------------------------------------------
673−-- Accumulator
674−--------------------------------------------------------------------------------
675−
676−-- | An 'Accumulator' type can be built by accumulating occurrences of an
677−-- 'Event'.
678−class Reflex t => Accumulator t f | f -> t where
679− accum :: (MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (f a)
680− accum f = accumMaybe $ \v o -> Just $ f v o
681− accumM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (f a)
682− accumM f = accumMaybeM $ \v o -> Just <$> f v o
683− accumMaybe :: (MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (f a)
684− accumMaybe f = accumMaybeM $ \v o -> return $ f v o
685− accumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (f a)
686− mapAccum :: (MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (f a, Event t c)
687− mapAccum f = mapAccumMaybe $ \v o -> bimap Just Just $ f v o
688− mapAccumM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (f a, Event t c)
689− mapAccumM f = mapAccumMaybeM $ \v o -> bimap Just Just <$> f v o
690− mapAccumMaybe :: (MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
691− mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
692− mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
693−
694−-- | Accumulate occurrences of an 'Event', producing an output occurrence each
695−-- time. Discard the underlying 'Accumulator'.
696−mapAccum_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Event t c)
697−mapAccum_ f z e = do
698− (_ :: Behavior t a, result) <- mapAccum f z e
699− return result
700−
701−-- | Accumulate occurrences of an 'Event', possibly producing an output
702−-- occurrence each time. Discard the underlying 'Accumulator'.
703−mapAccumMaybe_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
704−mapAccumMaybe_ f z e = do
705− (_ :: Behavior t a, result) <- mapAccumMaybe f z e
706− return result
707−
708−-- | Accumulate occurrences of an 'Event', using a 'PushM' action and producing
709−-- an output occurrence each time. Discard the underlying 'Accumulator'.
710−mapAccumM_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Event t c)
711−mapAccumM_ f z e = do
712− (_ :: Behavior t a, result) <- mapAccumM f z e
713− return result
714−
715−-- | Accumulate occurrences of an 'Event', using a 'PushM' action and possibly
716−-- producing an output occurrence each time. Discard the underlying
717−-- 'Accumulator'.
718−mapAccumMaybeM_ :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
719−mapAccumMaybeM_ f z e = do
720− (_ :: Behavior t a, result) <- mapAccumMaybeM f z e
721− return result
722−
723−instance Reflex t => Accumulator t (Dynamic t) where
724− accumMaybeM f z e = do
725− rec let e' = flip push e $ \o -> do
726− v <- sample $ current d'
727− f v o
728− d' <- holdDyn z e'
729− return d'
730− mapAccumMaybeM f z e = do
731− rec let e' = flip push e $ \o -> do
732− v <- sample $ current d'
733− result <- f v o
734− return $ case result of
735− (Nothing, Nothing) -> Nothing
736− _ -> Just result
737− d' <- holdDyn z $ fmapMaybe fst e'
738− return (d', fmapMaybe snd e')
739−
740−instance Reflex t => Accumulator t (Behavior t) where
741− accumMaybeM f z e = current <$> accumMaybeM f z e
742− mapAccumMaybeM f z e = first current <$> mapAccumMaybeM f z e
743−
744−instance Reflex t => Accumulator t (Event t) where
745− accumMaybeM f z e = updated <$> accumMaybeM f z e
746− mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
747−
748−-- | Create a new 'Event' by combining each occurence with the next value of the
749−-- list using the supplied function. If the list runs out of items, all
750−-- subsequent 'Event' occurrences will be ignored.
751−zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
752−zipListWithEvent f l e = do
753− let f' a b = case a of
754− h:t -> (Just t, Just $ f h b)
755− _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
756− mapAccumMaybe_ f' l e
757−
758−--------------------------------------------------------------------------------
759−-- Deprecated functions
760−--------------------------------------------------------------------------------
761−
762−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
763−-- occurs. If both occur at the same time they are combined using 'mappend'.
764−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
765−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
766−appendEvents = alignWith $ mergeThese mappend
767−
768−-- | Alias for 'headE'
769−{-# DEPRECATED onceE "Use 'headE' instead" #-}
770−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
771−onceE = headE
772−
773−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
774−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
775−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
776−sequenceThese t = case t of
777− This ma -> liftM This ma
778− These ma mb -> liftM2 These ma mb
779− That mb -> liftM That mb
src/Reflex/Dynamic.hsdeleted−543
@@ -1,543 +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−-- | This module contains various functions for working with 'Dynamic' values.
16−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
17−module Reflex.Dynamic
18− ( -- * Basics
19− Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
20− , current
21− , updated
22− , holdDyn
23− , constDyn
24− , uniqDyn
25− , uniqDynBy
26− , count
27− , toggle
28− , switchPromptlyDyn
29− , tagPromptlyDyn
30− , attachPromptlyDyn
31− , attachPromptlyDynWith
32− , attachPromptlyDynWithMaybe
33− , foldDyn
34− , foldDynM
35− , foldDynMaybe
36− , foldDynMaybeM
37− , joinDynThroughMap
38− , traceDyn
39− , traceDynWith
40− , splitDynPure
41− , distributeDMapOverDynPure
42− , Demux
43− , demux
44− , demuxed
45− -- Things that probably aren't very useful:
46− , HList (..)
47− , FHList (..)
48− , collectDynPure
49− , distributeFHListOverDynPure
50− -- Unsafe
51− , unsafeDynamic
52− -- * Deprecated functions
53− , apDyn
54− , attachDyn
55− , attachDynWith
56− , attachDynWithMaybe
57− , collectDyn
58− , combineDyn
59− , distributeDMapOverDyn
60− , distributeFHListOverDyn
61− , forDyn
62− , getDemuxed
63− , joinDyn
64− , mapDyn
65− , mconcatDyn
66− , nubDyn
67− , splitDyn
68− , tagDyn
69− ) where
70−
71−import Prelude hiding (mapM, mapM_)
72−
73−import Data.Functor.Misc
74−import Reflex.Class
75−
76−import Control.Applicative ((<*>))
77−import Control.Monad hiding (forM, forM_, mapM, mapM_)
78−import Control.Monad.Fix
79−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
80−import Data.Align
81−import Data.Dependent.Map (DMap)
82−import qualified Data.Dependent.Map as DMap
83−import Data.Dependent.Sum (DSum (..))
84−import Data.GADT.Compare ((:~:) (..), GCompare (..), GEq (..), GOrdering (..))
85−import Data.Map (Map)
86−import Data.Monoid
87−import Data.These
88−
89−import Debug.Trace
90−
91−-- | Create a new 'Dynamic' that only signals changes if the values actually
92−-- changed.
93−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
94−uniqDyn = uniqDynBy (==)
95−
96−-- | Create a new 'Dynamic' that changes only when the underlying 'Dynamic'
97−-- changes and the given function returns 'False' when given both the old and
98−-- the new values.
99−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
100−uniqDynBy eq d =
101− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
102− in unsafeDynamic (current d) e'
103−
104−-- | Create a 'Dynamic' using the initial value and change it each time the
105−-- 'Event' occurs using a folding function on the previous value and the value
106−-- of the 'Event'.
107−foldDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> b) -> b -> Event t a -> m (Dynamic t b)
108−foldDyn = accum . flip
109−
110−-- | Like 'foldDyn', but the combining function is a 'PushM' action, so it
111−-- can 'sample' existing 'Behaviors' and 'hold' new ones.
112−foldDynM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t b) -> b -> Event t a -> m (Dynamic t b)
113−foldDynM = accumM . flip
114−
115−-- | Create a 'Dynamic' using the provided initial value and change it each time
116−-- the provided 'Event' occurs, using a function to combine the old value with
117−-- the 'Event''s value. If the function returns 'Nothing', the value is not
118−-- changed; this is distinct from returning 'Just' the old value, since the
119−-- 'Dynamic''s 'updated' 'Event' will fire in the 'Just' case, and will not fire
120−-- in the 'Nothing' case.
121−foldDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe b) -> b -> Event t a -> m (Dynamic t b)
122−foldDynMaybe = accumMaybe . flip
123−
124−-- | Like 'foldDynMaybe', but the combining function is a 'PushM' action, so it
125−-- can 'sample' existing 'Behaviors' and 'hold' new ones.
126−foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
127−foldDynMaybeM = accumMaybeM . flip
128−
129−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
130−count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
131−count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
132−
133−-- | Create a new 'Dynamic' using the initial value that flips its
134−-- value every time the 'Event' occurs.
135−toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
136−toggle = foldDyn (const not)
137−
138−-- | Switches to the new 'Event' whenever it receives one. Switching occurs
139−-- *before* the inner 'Event' fires - so if the 'Dynamic' changes and both the
140−-- old and new inner Events fire simultaneously, the output will fire with the
141−-- value of the *new* 'Event'.
142−switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
143−switchPromptlyDyn de =
144− let eLag = switch $ current de
145− eCoincidences = coincidence $ updated de
146− in leftmost [eCoincidences, eLag]
147−
148−-- | Split a 'Dynamic' pair into a pair of 'Dynamic's
149−splitDynPure :: Reflex t => Dynamic t (a, b) -> (Dynamic t a, Dynamic t b)
150−splitDynPure d = (fmap fst d, fmap snd d)
151−
152−-- | Create a 'Dynamic' with a 'DMap' of values out of a 'DMap' of 'Dynamic'
153−-- values. The resulting 'Dynamic' will change whenever one of the input
154−-- 'Dynamic's changes.
155−--
156−-- This function's implementation is more efficient than simply using
157−-- 'zipDynWith' or applicative syntax to achieve the same result, especially for
158−-- maps with many elements.
159−distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
160−distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
161−
162−--TODO: Generalize this to functors other than Maps
163−-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
164−-- with the current values of the 'Dynamic's in a map.
165−joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
166−joinDynThroughMap = joinDyn . fmap distributeMapOverDynPure
167−
168−-- | Print the value of the 'Dynamic' on each change and prefix it
169−-- with the provided string. This should /only/ be used for debugging.
170−--
171−-- Note: Just like Debug.Trace.trace, the value will only be shown if something
172−-- else in the system is depending on it.
173−traceDyn :: (Reflex t, Show a) => String -> Dynamic t a -> Dynamic t a
174−traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
175−
176−-- | Print the result of applying the provided function to the value
177−-- of the 'Dynamic' on each change. This should /only/ be used for
178−-- debugging.
179−--
180−-- Note: Just like Debug.Trace.trace, the value will only be shown if something
181−-- else in the system is depending on it.
182−traceDynWith :: Reflex t => (a -> String) -> Dynamic t a -> Dynamic t a
183−traceDynWith f d =
184− let e' = traceEventWith f $ updated d
185− getV0 = do
186− x <- sample $ current d
187− trace (f x) $ return x
188− in unsafeBuildDynamic getV0 e'
189−
190−-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
191−-- each time the 'Event' occurs.
192−--
193−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
194−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
195−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
196−-- will be used, since the 'Behavior' won't be updated until the end of the frame.
197−-- Additionally, this means that the output 'Event' may not be used to directly change
198−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
199−-- cyclic data flows, generally `tag (current d) e` is preferred.
200−tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
201−tagPromptlyDyn = attachPromptlyDynWith const
202−
203−-- | Attach the current value of the 'Dynamic' to the value of the
204−-- 'Event' each time it occurs.
205−--
206−-- Note: `attachPromptlyDyn d` is not the same as `attach (current d)`. See 'tagPromptlyDyn' for details.
207−attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
208−attachPromptlyDyn = attachPromptlyDynWith (,)
209−
210−-- | Combine the current value of the 'Dynamic' with the value of the
211−-- 'Event' each time it occurs.
212−--
213−-- Note: `attachPromptlyDynWith f d` is not the same as `attachWith f (current d)`. See 'tagPromptlyDyn' for details.
214−attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
215−attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
216−
217−-- | Create a new 'Event' by combining the value at each occurence with the
218−-- current value of the 'Dynamic' value and possibly filtering if the combining
219−-- function returns 'Nothing'.
220−--
221−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
222−-- (current d)`. See 'tagPromptlyDyn' for details.
223−attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
224−attachPromptlyDynWithMaybe f d e =
225− let e' = attach (current d) e
226− in fforMaybe (align e' $ updated d) $ \case
227− This (a, b) -> f a b -- Only the tagging event is firing, so use that
228− These (_, b) a -> f a b -- Both events are firing, so use the newer value
229− That _ -> Nothing -- The tagging event isn't firing, so don't fire
230−
231−--------------------------------------------------------------------------------
232−-- Demux
233−--------------------------------------------------------------------------------
234−
235−-- | Represents a time changing value together with an 'EventSelector' that can
236−-- efficiently detect when the underlying 'Dynamic' has a particular value.
237−-- This is useful for representing data like the current selection of a long
238−-- list.
239−--
240−-- Semantically,
241−--
242−-- > demuxed (demux d) k === fmap (== k) d
243−--
244−-- However, the when getDemuxed is used multiple times, the complexity is only
245−-- /O(log(n))/, rather than /O(n)/ for fmap.
246−data Demux t k = Demux { demuxValue :: Behavior t k
247− , demuxSelector :: EventSelector t (Const2 k Bool)
248− }
249−
250−-- | Demultiplex an input value to a 'Demux' with many outputs. At any given
251−-- time, whichever output is indicated by the given 'Dynamic' will be 'True'.
252−demux :: (Reflex t, Ord k) => Dynamic t k -> Demux t k
253−demux k = Demux (current k)
254− (fan $ attachWith (\k0 k1 -> if k0 == k1
255− then DMap.empty
256− else DMap.fromList [Const2 k0 :=> Identity False,
257− Const2 k1 :=> Identity True])
258− (current k) (updated k))
259−
260−-- | Select a particular output of the 'Demux'; this is equivalent to (but much
261−-- faster than) mapping over the original 'Dynamic' and checking whether it is
262−-- equal to the given key.
263−demuxed :: (Reflex t, Eq k) => Demux t k -> k -> Dynamic t Bool
264−demuxed d k =
265− let e = select (demuxSelector d) (Const2 k)
266− in unsafeBuildDynamic (fmap (==k) $ sample $ demuxValue d) e
267−
268−--------------------------------------------------------------------------------
269−-- collectDyn
270−--------------------------------------------------------------------------------
271−
272−--TODO: This whole section is badly in need of cleanup
273−
274−-- | A heterogeneous list whose type and length are fixed statically. This is
275−-- reproduced from the 'HList' package due to integration issues, and because
276−-- very little other functionality from that library is needed.
277−data HList (l::[*]) where
278− HNil :: HList '[]
279− HCons :: e -> HList l -> HList (e ': l)
280−
281−infixr 2 `HCons`
282−
283−type family HRevApp (l1 :: [k]) (l2 :: [k]) :: [k]
284−type instance HRevApp '[] l = l
285−type instance HRevApp (e ': l) l' = HRevApp l (e ': l')
286−
287−hRevApp :: HList l1 -> HList l2 -> HList (HRevApp l1 l2)
288−hRevApp HNil l = l
289−hRevApp (HCons x l) l' = hRevApp l (HCons x l')
290−
291−hReverse :: HList l -> HList (HRevApp l '[])
292−hReverse l = hRevApp l HNil
293−
294−hBuild :: (HBuild' '[] r) => r
295−hBuild = hBuild' HNil
296−
297−class HBuild' l r where
298− hBuild' :: HList l -> r
299−
300−instance (l' ~ HRevApp l '[])
301− => HBuild' l (HList l') where
302− hBuild' = hReverse
303−
304−instance HBuild' (a ': l) r
305− => HBuild' l (a->r) where
306− hBuild' l x = hBuild' (HCons x l)
307−
308−-- | Like 'HList', but with a functor wrapping each element.
309−data FHList f l where
310− FHNil :: FHList f '[]
311− FHCons :: f e -> FHList f l -> FHList f (e ': l)
312−
313−instance GEq (HListPtr l) where
314− HHeadPtr `geq` HHeadPtr = Just Refl
315− HHeadPtr `geq` HTailPtr _ = Nothing
316− HTailPtr _ `geq` HHeadPtr = Nothing
317− HTailPtr a `geq` HTailPtr b = a `geq` b
318−
319−instance GCompare (HListPtr l) where -- Warning: This ordering can't change, dmapTo*HList will break
320− HHeadPtr `gcompare` HHeadPtr = GEQ
321− HHeadPtr `gcompare` HTailPtr _ = GLT
322− HTailPtr _ `gcompare` HHeadPtr = GGT
323− HTailPtr a `gcompare` HTailPtr b = a `gcompare` b
324−
325−data HListPtr l a where
326− HHeadPtr :: HListPtr (h ': t) h
327− HTailPtr :: HListPtr t a -> HListPtr (h ': t) a
328−
329−fhlistToDMap :: forall (f :: * -> *) l. FHList f l -> DMap (HListPtr l) f
330−fhlistToDMap = DMap.fromList . go
331− where go :: forall l'. FHList f l' -> [DSum (HListPtr l') f]
332− go = \case
333− FHNil -> []
334− FHCons h t -> (HHeadPtr :=> h) : map (\(p :=> v) -> HTailPtr p :=> v) (go t)
335−
336−class RebuildSortedHList l where
337− rebuildSortedFHList :: [DSum (HListPtr l) f] -> FHList f l
338− rebuildSortedHList :: [DSum (HListPtr l) Identity] -> HList l
339−
340−instance RebuildSortedHList '[] where
341− rebuildSortedFHList l = case l of
342− [] -> FHNil
343− _ : _ -> error "rebuildSortedFHList{'[]}: empty list expected"
344− rebuildSortedHList l = case l of
345− [] -> HNil
346− _ : _ -> error "rebuildSortedHList{'[]}: empty list expected"
347−
348−instance RebuildSortedHList t => RebuildSortedHList (h ': t) where
349− rebuildSortedFHList l = case l of
350− ((HHeadPtr :=> h) : t) -> FHCons h . rebuildSortedFHList . map (\(HTailPtr p :=> v) -> p :=> v) $ t
351− _ -> error "rebuildSortedFHList{h':t}: non-empty list with HHeadPtr expected"
352− rebuildSortedHList l = case l of
353− ((HHeadPtr :=> Identity h) : t) -> HCons h . rebuildSortedHList . map (\(HTailPtr p :=> v) -> p :=> v) $ t
354− _ -> error "rebuildSortedHList{h':t}: non-empty list with HHeadPtr expected"
355−
356−dmapToHList :: forall l. RebuildSortedHList l => DMap (HListPtr l) Identity -> HList l
357−dmapToHList = rebuildSortedHList . DMap.toList
358−
359−-- | Collect a hetereogeneous list whose elements are all 'Dynamic's into a
360−-- single 'Dynamic' whose value represents the current values of all of the
361−-- input 'Dynamic's.
362−distributeFHListOverDynPure :: (Reflex t, RebuildSortedHList l) => FHList (Dynamic t) l -> Dynamic t (HList l)
363−distributeFHListOverDynPure l = fmap dmapToHList $ distributeDMapOverDynPure $ fhlistToDMap l
364−
365−class AllAreFunctors (f :: a -> *) (l :: [a]) where
366− type FunctorList f l :: [*]
367− toFHList :: HList (FunctorList f l) -> FHList f l
368− fromFHList :: FHList f l -> HList (FunctorList f l)
369−
370−instance AllAreFunctors f '[] where
371− type FunctorList f '[] = '[]
372− toFHList l = case l of
373− HNil -> FHNil
374−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
375− _ -> error "toFHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
376−#endif
377− fromFHList FHNil = HNil
378−
379−instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
380− type FunctorList f (h ': t) = f h ': FunctorList f t
381− toFHList l = case l of
382− a `HCons` b -> a `FHCons` toFHList b
383−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
384− _ -> error "toFHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
385−#endif
386− fromFHList (a `FHCons` b) = a `HCons` fromFHList b
387−
388−-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
389−-- single 'Dynamic' whose value represents all the current values of the input's
390−-- consitutent 'Dynamic's.
391−collectDynPure :: ( RebuildSortedHList (HListElems b)
392− , IsHList a, IsHList b
393− , AllAreFunctors (Dynamic t) (HListElems b)
394− , Reflex t
395− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
396− ) => a -> Dynamic t b
397−collectDynPure ds = fmap fromHList $ distributeFHListOverDynPure $ toFHList $ toHList ds
398−
399−-- Poor man's Generic
400−class IsHList a where
401− type HListElems a :: [*]
402− toHList :: a -> HList (HListElems a)
403− fromHList :: HList (HListElems a) -> a
404−
405−instance IsHList (a, b) where
406− type HListElems (a, b) = [a, b]
407− toHList (a, b) = hBuild a b
408− fromHList l = case l of
409− a `HCons` b `HCons` HNil -> (a, b)
410−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
411− _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
412−#endif
413−
414−instance IsHList (a, b, c, d) where
415− type HListElems (a, b, c, d) = [a, b, c, d]
416− toHList (a, b, c, d) = hBuild a b c d
417− fromHList l = case l of
418− a `HCons` b `HCons` c `HCons` d `HCons` HNil -> (a, b, c, d)
419−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
420− _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
421−#endif
422−
423−instance IsHList (a, b, c, d, e, f) where
424− type HListElems (a, b, c, d, e, f) = [a, b, c, d, e, f]
425− toHList (a, b, c, d, e, f) = hBuild a b c d e f
426− fromHList l = case l of
427− a `HCons` b `HCons` c `HCons` d `HCons` e `HCons` f `HCons` HNil -> (a, b, c, d, e, f)
428−#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
429− _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
430−#endif
431−
432−--------------------------------------------------------------------------------
433−-- Deprecated functions
434−--------------------------------------------------------------------------------
435−
436−-- | Map a function over a 'Dynamic'.
437−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
438−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
439−mapDyn f = return . fmap f
440−
441−-- | Flipped version of 'mapDyn'.
442−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
443−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
444−forDyn a = return . ffor a
445−
446−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
447−-- of the tuple.
448−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
449−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
450−splitDyn = return . splitDynPure
451−
452−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
453−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
454−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
455−mconcatDyn = return . mconcat
456−
457−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
458−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
459−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
460−distributeDMapOverDyn = return . distributeDMapOverDynPure
461−
462−-- | Merge two 'Dynamic's into a new one using the provided function. The new
463−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
464−-- its value.
465−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
466−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
467−combineDyn f a b = return $ zipDynWith f a b
468−
469−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
470−--
471−-- > do
472−-- > person <- Person `mapDyn` dynFirstName
473−-- > `apDyn` dynListName
474−-- > `apDyn` dynAge
475−-- > `apDyn` dynAddress
476−{-# 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" #-}
477−{-# ANN apDyn "HLint: ignore Use fmap" #-}
478−apDyn :: forall t m a b. (Reflex t, Monad m)
479− => m (Dynamic t (a -> b))
480− -> Dynamic t a
481− -> m (Dynamic t b)
482−apDyn m a = liftM (<*> a) m
483−
484−--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
485−-- | This function no longer needs to be monadic, so it has been replaced by
486−-- 'demuxed', which is pure.
487−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
488−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
489−getDemuxed d = return . demuxed d
490−
491−-- | This function no longer needs to be monadic, so it has been replaced by
492−-- 'distributeFHListOverDynPure', which is pure.
493−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
494−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
495−distributeFHListOverDyn = return . distributeFHListOverDynPure
496−
497−-- | This function no longer needs to be monadic, so it has been replaced by
498−-- 'collectDynPure', which is pure.
499−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
500−collectDyn :: ( RebuildSortedHList (HListElems b)
501− , IsHList a, IsHList b
502− , AllAreFunctors (Dynamic t) (HListElems b)
503− , Reflex t, Monad m
504− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
505− ) => a -> m (Dynamic t b)
506−collectDyn = return . collectDynPure
507−
508−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
509−-- semantics.
510−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
511−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
512−tagDyn = tagPromptlyDyn
513−
514−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
515−-- semantics.
516−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
517−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
518−attachDyn = attachPromptlyDyn
519−
520−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
521−-- semantics.
522−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
523−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
524−attachDynWith = attachPromptlyDynWith
525−
526−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
527−-- its semantics.
528−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
529−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
530−attachDynWithMaybe = attachPromptlyDynWithMaybe
531−
532−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
533−-- current value will always be equal to the current value's current value, and
534−-- will change whenever either the inner or the outer (or both) values change.
535−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
536−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
537−joinDyn = join
538−
539−-- | 'nubDyn''s behavior is not quite analogous to 'nub''s behavior, so it has
540−-- been renamed to 'uniqDyn'
541−{-# DEPRECATED nubDyn "Use 'uniqDyn' instead" #-}
542−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
543−nubDyn = uniqDyn
src/Reflex/Dynamic/TH.hsdeleted−88
@@ -1,88 +0,0 @@
1−{-# LANGUAGE EmptyDataDecls #-}
2−{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE PatternGuards #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE TemplateHaskell #-}
6−{-# LANGUAGE TypeOperators #-}
7−-- | Template Haskell helper functions for building complex 'Dynamic' values.
8−module Reflex.Dynamic.TH (qDyn, unqDyn, mkDyn) where
9−
10−import Reflex.Dynamic
11−
12−import Control.Monad.State
13−import Data.Data
14−import Data.Generics
15−import Data.Monoid
16−import qualified Language.Haskell.Exts as Hs
17−import qualified Language.Haskell.Meta.Syntax.Translate as Hs
18−import Language.Haskell.TH
19−import Language.Haskell.TH.Quote
20−import qualified Language.Haskell.TH.Syntax as TH
21−
22−-- | Quote a 'Dynamic' expression. Within the quoted expression, you can use
23−-- @$(unqDyn [| x |])@ to refer to any expression @x@ of type @Dynamic t a@; the
24−-- unquoted result will be of type @a@
25−qDyn :: Q Exp -> Q Exp
26−qDyn qe = do
27− e <- qe
28− let f :: forall d. Data d => d -> StateT [(Name, Exp)] Q d
29− f d = case eqT of
30− Just (Refl :: d :~: Exp)
31− | AppE (VarE m) eInner <- d
32− , m == 'unqMarker
33− -> do n <- lift $ newName "dynamicQuotedExpressionVariable"
34− modify ((n, eInner):)
35− return $ VarE n
36− _ -> gmapM f d
37− (e', exprsReversed) <- runStateT (gmapM f e) []
38− let exprs = reverse exprsReversed
39− arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
40− param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
41− [| return $ $(return $ LamE [param] e') $ distributeFHListOverDynPure $(return arg) |]
42−
43−-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
44−-- 'qDyn' quotation.
45−unqDyn :: Q Exp -> Q Exp
46−unqDyn e = [| unqMarker $e |]
47−
48−-- | This type represents an occurrence of unqDyn before it has been processed
49−-- by qDyn. If you see it in a type error, it probably means that unqDyn has
50−-- been used outside of a qDyn context.
51−data UnqDyn
52−
53−-- unqMarker must not be exported; it is used only as a way of smuggling data
54−-- from unqDyn to qDyn
55−
56−--TODO: It would be much nicer if the TH AST was extensible to support this kind of thing without trickery
57−unqMarker :: a -> UnqDyn
58−unqMarker = error "An unqDyn expression was used outside of a qDyn expression"
59−
60−-- | Create a 'Dynamic' value using other 'Dynamic's as inputs. The result is
61−-- sometimes more concise and readable than the equivalent 'Applicative'-based
62−-- expression. For example:
63−--
64−-- > [mkDyn| $x + $v * $t + 1/2 * $a * $t ^ 2 |]
65−--
66−-- would have a very cumbersome 'Applicative' encoding.
67−mkDyn :: QuasiQuoter
68−mkDyn = QuasiQuoter
69− { quoteExp = mkDynExp
70− , quotePat = error "mkDyn: pattern splices are not supported"
71− , quoteType = error "mkDyn: type splices are not supported"
72− , quoteDec = error "mkDyn: declaration splices are not supported"
73− }
74−
75−mkDynExp :: String -> Q Exp
76−mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] }) s of
77− Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
78− Hs.ParseOk e -> qDyn $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
79− where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
80− antiE x = case x of
81− Hs.SpliceExp se ->
82− Hs.App (Hs.Var $ Hs.Qual (Hs.ModuleName modName) (Hs.Ident occName)) $ case se of
83− Hs.IdSplice v -> Hs.Var $ Hs.UnQual $ Hs.Ident v
84− Hs.ParenSplice ps -> ps
85− _ -> x
86− reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
87− | modName == modName' && occName == occName' = 'unqMarker
88− reinstateUnqDyn x = x
src/Reflex/Dynamic/Uniq.hsdeleted−101
@@ -1,101 +0,0 @@
1−{-# LANGUAGE FlexibleInstances #-}
2−{-# LANGUAGE MagicHash #-}
3−{-# LANGUAGE MultiParamTypeClasses #-}
4−-- | This module provides a variation of 'Dynamic' values that uses cheap
5−-- pointer equality checks to reduce the amount of signal propagation needed.
6−module Reflex.Dynamic.Uniq
7− ( UniqDynamic
8− , uniqDynamic
9− , fromUniqDynamic
10− , alreadyUniqDynamic
11− ) where
12−
13−import Control.Applicative (Applicative (..))
14−import GHC.Exts
15−import Reflex.Class
16−import Reflex.Dynamic
17−
18−-- | A 'Dynamic' whose 'updated' 'Event' will never fire with the same value as
19−-- the 'current' 'Behavior''s contents. In order to maintain this constraint,
20−-- the value inside a 'UniqDynamic' is always evaluated to
21−-- <https://wiki.haskell.org/Weak_head_normal_form weak head normal form>.
22−--
23−-- Internally, 'UniqDynamic' uses pointer equality as a heuristic to avoid
24−-- unnecessary update propagation; this is much more efficient than performing
25−-- full comparisons. However, when the 'UniqDynamic' is converted back into a
26−-- regular 'Dynamic', a full comparison is performed.
27−newtype UniqDynamic t a = UniqDynamic { unUniqDynamic :: Dynamic t a }
28−
29−-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
30−uniqDynamic :: Reflex t => Dynamic t a -> UniqDynamic t a
31−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
32− old <- sample $ current d --TODO: Is it better to sample ourselves here?
33− return $ unsafeJustChanged old new
34−
35−-- | Retrieve a normal 'Dynamic' from a 'UniqDynamic'. This will perform a
36−-- final check using the output type's 'Eq' instance to ensure deterministic
37−-- behavior.
38−--
39−-- WARNING: If used with a type whose 'Eq' instance is not law-abiding -
40−-- specifically, if there are cases where @x /= x@, 'fromUniqDynamic' may
41−-- eliminate more 'updated' occurrences than it should. For example, NaN values
42−-- of 'Double' and 'Float' are considered unequal to themselves by the 'Eq'
43−-- instance, but can be equal by pointer equality. This may cause 'UniqDynamic'
44−-- to lose changes from NaN to NaN.
45−fromUniqDynamic :: (Reflex t, Eq a) => UniqDynamic t a -> Dynamic t a
46−fromUniqDynamic (UniqDynamic d) = uniqDynBy superEq d
47− where
48− -- Only consider values different if they fail both pointer equality /and/
49− -- 'Eq' equality. This is to make things a bit more deterministic in the
50− -- case of unlawful 'Eq' instances. However, it is still possible to
51− -- achieve nondeterminism by constructing elements that are identical in
52− -- value, unequal according to 'Eq', and nondeterministically equal or
53− -- nonequal by pointer quality. I suspect that it is impossible to make the
54− -- behavior deterministic in this case.
55− superEq a b = a `unsafePtrEq` b || a == b
56−
57−-- | Create a UniqDynamic without uniqing it on creation. This will be slightly
58−-- faster than uniqDynamic when used with a Dynamic whose values are always (or
59−-- nearly always) different from its previous values; if used with a Dynamic
60−-- whose values do not change frequently, it may be much slower than uniqDynamic
61−alreadyUniqDynamic :: Dynamic t a -> UniqDynamic t a
62−alreadyUniqDynamic = UniqDynamic
63−
64−unsafePtrEq :: a -> a -> Bool
65−unsafePtrEq a b = case a `seq` b `seq` reallyUnsafePtrEquality# a b of
66− 0# -> False
67− _ -> True
68−
69−unsafeJustChanged :: a -> a -> Maybe a
70−unsafeJustChanged old new =
71− if old `unsafePtrEq` new
72− then Nothing
73− else Just new
74−
75−instance Reflex t => Accumulator t (UniqDynamic t) where
76− accumMaybeM f z e = do
77− let f' old change = do
78− mNew <- f old change
79− return $ unsafeJustChanged old =<< mNew
80− d <- accumMaybeM f' z e
81− return $ UniqDynamic d
82− mapAccumMaybeM f z e = do
83− let f' old change = do
84− (mNew, output) <- f old change
85− return (unsafeJustChanged old =<< mNew, output)
86− (d, out) <- mapAccumMaybeM f' z e
87− return (UniqDynamic d, out)
88−
89−instance Reflex t => Functor (UniqDynamic t) where
90− fmap f (UniqDynamic d) = uniqDynamic $ fmap f d
91−
92−instance Reflex t => Applicative (UniqDynamic t) where
93− pure = UniqDynamic . constDyn
94− UniqDynamic a <*> UniqDynamic b = uniqDynamic $ a <*> b
95− _ *> b = b
96− a <* _ = a
97−
98−instance Reflex t => Monad (UniqDynamic t) where
99− UniqDynamic x >>= f = uniqDynamic $ x >>= unUniqDynamic . f
100− _ >> b = b
101− return = pure
src/Reflex/Host/Class.hsdeleted−282
@@ -1,282 +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−-- | This module provides the interface for hosting 'Reflex' engines. This
13−-- should only be necessary if you're writing a binding or some other library
14−-- that provides a core event loop.
15−module Reflex.Host.Class
16− ( ReflexHost (..)
17− , MonadSubscribeEvent (..)
18− , MonadReadEvent (..)
19− , MonadReflexCreateTrigger (..)
20− , MonadReflexHost (..)
21− , fireEvents
22− , newEventWithTriggerRef
23− , fireEventRef
24− , fireEventRefAndRead
25− ) where
26−
27−import Reflex.Class
28−
29−import Control.Applicative
30−import Control.Monad
31−import Control.Monad.Fix
32−import Control.Monad.Identity
33−import Control.Monad.Ref
34−import Control.Monad.Trans
35−import Control.Monad.Trans.Cont (ContT ())
36−import Control.Monad.Trans.Except (ExceptT ())
37−import Control.Monad.Trans.Reader (ReaderT ())
38−import Control.Monad.Trans.RWS (RWST ())
39−import Control.Monad.Trans.State (StateT ())
40−import qualified Control.Monad.Trans.State.Strict as Strict
41−import Control.Monad.Trans.Writer (WriterT ())
42−import Data.Dependent.Sum (DSum (..))
43−import Data.GADT.Compare
44−import Data.Monoid
45−
46−-- Note: this import must come last to silence warnings from AMP
47−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
48−
49−-- | Framework implementation support class for the reflex implementation
50−-- represented by @t@.
51−class ( Reflex t
52− , MonadReflexCreateTrigger t (HostFrame t)
53− , MonadSample t (HostFrame t)
54− , MonadHold t (HostFrame t)
55− , MonadFix (HostFrame t)
56− , MonadSubscribeEvent t (HostFrame t)
57− ) => ReflexHost t where
58− type EventTrigger t :: * -> *
59− type EventHandle t :: * -> *
60− type HostFrame t :: * -> *
61−
62−-- | Monad in which Events can be 'subscribed'. This forces all underlying
63−-- event sources to be initialized, so that the event will fire whenever it
64−-- ought to. Events must be subscribed before they are read using readEvent
65−class (Reflex t, Monad m) => MonadSubscribeEvent t m | m -> t where
66− -- | Subscribe to an event and set it up if needed.
67− --
68− -- This function will create a new 'EventHandle' from an 'Event'. This handle
69− -- may then be used via 'readEvent' in the read callback of
70− -- 'fireEventsAndRead'.
71− --
72− -- If the event wasn't subscribed to before (either manually or through a
73− -- dependent event or behavior) then this function will cause the event and
74− -- all dependencies of this event to be set up. For example, if the event was
75− -- created by 'newEventWithTrigger', then it's callback will be executed.
76− --
77− -- It's safe to call this function multiple times.
78− subscribeEvent :: Event t a -> m (EventHandle t a)
79−
80−-- | Monad that allows to read events' values.
81−class (ReflexHost t, Applicative m, Monad m) => MonadReadEvent t m | m -> t where
82− -- | Read the value of an 'Event' from an 'EventHandle' (created by calling
83− -- 'subscribeEvent').
84− --
85− -- After event propagation is done, all events can be in two states: either
86− -- they are firing with some value or they are not firing. In the former
87− -- case, this function returns @Just act@, where @act@ in an action to read
88− -- the current value of the event. In the latter case, the function returns
89− -- @Nothing@.
90− --
91− -- This function is normally used in the calllback for 'fireEventsAndRead'.
92− readEvent :: EventHandle t a -> m (Maybe (m a))
93−
94−-- | A monad where new events feed from external sources can be created.
95−class (Applicative m, Monad m) => MonadReflexCreateTrigger t m | m -> t where
96− -- | Creates a root 'Event' (one that is not based on any other event).
97− --
98− -- When a subscriber first subscribes to an event (building another event that
99− -- depends on the subscription) the given callback function is run and passed
100− -- a trigger. The callback function can then set up the event source in IO.
101− -- After this is done, the callback function must return an accompanying
102− -- teardown action.
103− --
104− -- Any time between setup and teardown the trigger can be used to fire the
105− -- event, by passing it to 'fireEventsAndRead'.
106− --
107− -- Note: An event may be set up multiple times. So after the teardown action
108− -- is executed, the event may still be set up again in the future.
109− newEventWithTrigger :: (EventTrigger t a -> IO (IO ())) -> m (Event t a)
110− newFanEventWithTrigger :: GCompare k => (forall a. k a -> EventTrigger t a -> IO (IO ())) -> m (EventSelector t k)
111−
112−-- | 'MonadReflexHost' designates monads that can run reflex frames.
113−class ( ReflexHost t
114− , MonadReflexCreateTrigger t m
115− , MonadSubscribeEvent t m
116− , MonadReadEvent t (ReadPhase m)
117− , MonadSample t (ReadPhase m)
118− , MonadHold t (ReadPhase m)
119− ) => MonadReflexHost t m | m -> t where
120− type ReadPhase m :: * -> *
121− -- | Propagate some events firings and read the values of events afterwards.
122− --
123− -- This function will create a new frame to fire the given events. It will
124− -- then update all dependent events and behaviors. After that is done, the
125− -- given callback is executed which allows to read the final values of events
126− -- and check whether they have fired in this frame or not.
127− --
128− -- All events that are given are fired at the same time.
129− --
130− -- This function is typically used in the main loop of a reflex framework
131− -- implementation. The main loop waits for external events to happen (such as
132− -- keyboard input or a mouse click) and then fires the corresponding events
133− -- using this function. The read callback can be used to read output events
134− -- and perform a corresponding response action to the external event.
135− fireEventsAndRead :: [DSum (EventTrigger t) Identity] -> ReadPhase m a -> m a
136−
137− -- | Run a frame without any events firing.
138− --
139− -- This function should be used when you want to use 'sample' and 'hold' when
140− -- no events are currently firing. Using this function in that case can
141− -- improve performance, since the implementation can assume that no events are
142− -- firing when 'sample' or 'hold' are called.
143− --
144− -- This function is commonly used to set up the basic event network when the
145− -- application starts up.
146− runHostFrame :: HostFrame t a -> m a
147−
148−-- | Like 'fireEventsAndRead', but without reading any events.
149−fireEvents :: MonadReflexHost t m => [DSum (EventTrigger t) Identity] -> m ()
150−fireEvents dm = fireEventsAndRead dm $ return ()
151−{-# INLINE fireEvents #-}
152−
153−-- | Create a new event and store its trigger in an 'IORef' while it's active.
154−--
155−-- An event is only active between the set up (when it's first subscribed to)
156−-- and the teardown phases (when noboby is subscribing the event anymore). This
157−-- function returns an Event and an 'IORef'. As long as the event is active, the
158−-- 'IORef' will contain 'Just' the event trigger to trigger this event. When the
159−-- event is not active, the 'IORef' will contain 'Nothing'. This allows event
160−-- sources to be more efficient, since they don't need to produce events when
161−-- nobody is listening.
162−newEventWithTriggerRef :: (MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref IO) => m (Event t a, Ref m (Maybe (EventTrigger t a)))
163−newEventWithTriggerRef = do
164− rt <- newRef Nothing
165− e <- newEventWithTrigger $ \t -> do
166− writeRef rt $ Just t
167− return $ writeRef rt Nothing
168− return (e, rt)
169−{-# INLINE newEventWithTriggerRef #-}
170−
171−-- | Fire the given trigger if it is not 'Nothing'.
172−fireEventRef :: (MonadReflexHost t m, MonadRef m, Ref m ~ Ref IO) => Ref m (Maybe (EventTrigger t a)) -> a -> m ()
173−fireEventRef mtRef input = do
174− mt <- readRef mtRef
175− case mt of
176− Nothing -> return ()
177− Just trigger -> fireEvents [trigger :=> Identity input]
178−
179−-- | Fire the given trigger if it is not 'Nothing', and read from the given
180−-- 'EventHandle'.
181−fireEventRefAndRead :: (MonadReflexHost t m, MonadRef m, Ref m ~ Ref IO) => Ref m (Maybe (EventTrigger t a)) -> a -> EventHandle t b -> m (Maybe b)
182−fireEventRefAndRead mtRef input e = do
183− mt <- readRef mtRef
184− case mt of
185− Nothing -> return Nothing -- Since we aren't firing the input, the output can't fire
186− Just trigger -> fireEventsAndRead [trigger :=> Identity input] $ do
187− mGetValue <- readEvent e
188− case mGetValue of
189− Nothing -> return Nothing
190− Just getValue -> fmap Just getValue
191−
192−
193−--------------------------------------------------------------------------------
194−-- Instances
195−--------------------------------------------------------------------------------
196−
197−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ReaderT r m) where
198− newEventWithTrigger = lift . newEventWithTrigger
199− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
200−
201−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (ReaderT r m) where
202− subscribeEvent = lift . subscribeEvent
203−
204−instance MonadReflexHost t m => MonadReflexHost t (ReaderT r m) where
205− type ReadPhase (ReaderT r m) = ReadPhase m
206− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
207− runHostFrame = lift . runHostFrame
208−
209−instance (MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (WriterT w m) where
210− newEventWithTrigger = lift . newEventWithTrigger
211− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
212−
213−instance (MonadSubscribeEvent t m, Monoid w) => MonadSubscribeEvent t (WriterT w m) where
214− subscribeEvent = lift . subscribeEvent
215−
216−instance (MonadReflexHost t m, Monoid w) => MonadReflexHost t (WriterT w m) where
217− type ReadPhase (WriterT w m) = ReadPhase m
218− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
219− runHostFrame = lift . runHostFrame
220−
221−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StateT s m) where
222− newEventWithTrigger = lift . newEventWithTrigger
223− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
224−
225−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (StateT r m) where
226− subscribeEvent = lift . subscribeEvent
227−
228−instance MonadReflexHost t m => MonadReflexHost t (StateT s m) where
229− type ReadPhase (StateT s m) = ReadPhase m
230− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
231− runHostFrame = lift . runHostFrame
232−
233−
234−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Strict.StateT s m) where
235− newEventWithTrigger = lift . newEventWithTrigger
236− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
237−
238−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (Strict.StateT r m) where
239− subscribeEvent = lift . subscribeEvent
240−
241−instance MonadReflexHost t m => MonadReflexHost t (Strict.StateT s m) where
242− type ReadPhase (Strict.StateT s m) = ReadPhase m
243− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
244− runHostFrame = lift . runHostFrame
245−
246−
247−
248−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ContT r m) where
249− newEventWithTrigger = lift . newEventWithTrigger
250− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
251−
252−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (ContT r m) where
253− subscribeEvent = lift . subscribeEvent
254−
255−instance MonadReflexHost t m => MonadReflexHost t (ContT r m) where
256− type ReadPhase (ContT r m) = ReadPhase m
257− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
258− runHostFrame = lift . runHostFrame
259−
260−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ExceptT e m) where
261− newEventWithTrigger = lift . newEventWithTrigger
262− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
263−
264−instance MonadSubscribeEvent t m => MonadSubscribeEvent t (ExceptT r m) where
265− subscribeEvent = lift . subscribeEvent
266−
267−instance MonadReflexHost t m => MonadReflexHost t (ExceptT e m) where
268− type ReadPhase (ExceptT e m) = ReadPhase m
269− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
270− runHostFrame = lift . runHostFrame
271−
272−instance (MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (RWST r w s m) where
273− newEventWithTrigger = lift . newEventWithTrigger
274− newFanEventWithTrigger initializer = lift $ newFanEventWithTrigger initializer
275−
276−instance (MonadSubscribeEvent t m, Monoid w) => MonadSubscribeEvent t (RWST r w s m) where
277− subscribeEvent = lift . subscribeEvent
278−
279−instance (MonadReflexHost t m, Monoid w) => MonadReflexHost t (RWST r w s m) where
280− type ReadPhase (RWST r w s m) = ReadPhase m
281− fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
282− runHostFrame = lift . runHostFrame
src/Reflex/Pure.hsdeleted−167
@@ -1,167 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE EmptyDataDecls #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE InstanceSigs #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TypeFamilies #-}
8−
9−-- There are two expected orphan instances in this module:
10−-- * MonadSample (Pure t) ((->) t)
11−-- * MonadHold (Pure t) ((->) t)
12−{-# OPTIONS_GHC -fno-warn-orphans #-}
13−
14−-- | This module provides a pure implementation of Reflex, which is intended to
15−-- serve as a reference for the semantics of the Reflex class. All
16−-- implementations of Reflex should produce the same results as this
17−-- implementation, although performance and laziness/strictness may differ.
18−module Reflex.Pure where
19−
20−#if !MIN_VERSION_base(4,8,0)
21−import Control.Applicative -- Necessary for GHC 7.8
22−#endif
23−
24−import Control.Monad
25−import Data.Dependent.Map (DMap, GCompare)
26−import qualified Data.Dependent.Map as DMap
27−import Data.Functor.Identity
28−import Data.Maybe
29−import Data.MemoTrie
30−import Data.Monoid
31−import Reflex.Class
32−
33−data Pure t
34−
35−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
36−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
37−-- exclusively to memoize functions of t, not for any of its other capabilities.
38−instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
39−
40− newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
41− newtype Event (Pure t) a = Event { unEvent :: t -> Maybe a }
42− newtype Dynamic (Pure t) a = Dynamic { unDynamic :: t -> (a, Maybe a) }
43− newtype Incremental (Pure t) p a = Incremental { unIncremental :: t -> (a, Maybe (p a)) }
44−
45− type PushM (Pure t) = (->) t
46− type PullM (Pure t) = (->) t
47−
48− never :: Event (Pure t) a
49− never = Event $ \_ -> Nothing
50−
51− constant :: a -> Behavior (Pure t) a
52− constant x = Behavior $ \_ -> x
53−
54− push :: (a -> PushM (Pure t) (Maybe b)) -> Event (Pure t) a -> Event (Pure t) b
55− push f e = Event $ memo $ \t -> unEvent e t >>= \o -> f o t
56−
57− pull :: PullM (Pure t) a -> Behavior (Pure t) a
58− pull = Behavior . memo
59−
60− -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
61− -- warning because the GCompare instance is not used; however, removing the
62− -- GCompare instance produces a different warning, due to that constraint
63− -- being present in the original class definition
64−
65− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
66− merge events = Event $ memo $ \t ->
67− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
68− in if DMap.null currentOccurrences
69− then Nothing
70− else Just currentOccurrences
71−
72− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
73− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
74−
75− switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
76− switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
77−
78− coincidence :: Event (Pure t) (Event (Pure t) a) -> Event (Pure t) a
79− coincidence e = Event $ memo $ \t -> unEvent e t >>= \o -> unEvent o t
80−
81− current :: Dynamic (Pure t) a -> Behavior (Pure t) a
82− current d = Behavior $ \t -> fst $ unDynamic d t
83−
84− updated :: Dynamic (Pure t) a -> Event (Pure t) a
85− updated d = Event $ \t -> snd $ unDynamic d t
86−
87− unsafeBuildDynamic :: PullM (Pure t) a -> Event (Pure t) a -> Dynamic (Pure t) a
88− unsafeBuildDynamic readV0 v' = Dynamic $ \t -> (readV0 t, unEvent v' t)
89−
90− -- See UNUSED_CONSTRAINT, above.
91−
92− --unsafeBuildIncremental :: Patch p => PullM (Pure t) a -> Event (Pure t) (p
93− --a) -> Incremental (Pure t) p a
94− unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
95−
96− mergeIncremental (Incremental f) = Event $ \t ->
97− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ f t
98− in if DMap.null results
99− then Nothing
100− else Just results
101−
102− currentIncremental (Incremental f) = Behavior $ \t -> fst $ f t
103−
104− updatedIncremental (Incremental f) = Event $ \t -> snd $ f t
105−
106− incrementalToDynamic (Incremental f) = Dynamic $ \t ->
107− let (old, mPatch) = f t
108− e = case mPatch of
109− Nothing -> Nothing
110− Just patch -> apply patch old
111− in (old, e)
112−
113−instance Functor (Dynamic (Pure t)) where
114− fmap f d = Dynamic $ \t -> let (cur, upd) = unDynamic d t
115− in (f cur, fmap f upd)
116−
117−instance Applicative (Dynamic (Pure t)) where
118− pure a = Dynamic $ \_ -> (a, Nothing)
119− (<*>) = ap
120−
121−instance Monad (Dynamic (Pure t)) where
122− return = pure
123− (x :: Dynamic (Pure t) a) >>= (f :: a -> Dynamic (Pure t) b) = Dynamic $ \t ->
124− let (curX :: a, updX :: Maybe a) = unDynamic x t
125− (cur :: b, updOuter :: Maybe b) = unDynamic (f curX) t
126− (updInner :: Maybe b, updBoth :: Maybe b) = case updX of
127− Nothing -> (Nothing, Nothing)
128− Just nextX -> let (c, u) = unDynamic (f nextX) t
129− in (Just c, u)
130− in (cur, getFirst $ mconcat $ map First [updBoth, updOuter, updInner])
131−
132−instance MonadSample (Pure t) ((->) t) where
133−
134− sample :: Behavior (Pure t) a -> (t -> a)
135− sample = unBehavior
136−
137−instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
138−
139− hold :: a -> Event (Pure t) a -> t -> Behavior (Pure t) a
140− hold initialValue e initialTime = Behavior f
141− where f = memo $ \sampleTime ->
142− -- Really, the sampleTime should never be prior to the initialTime,
143− -- because that would mean the Behavior is being sampled before
144− -- being created.
145− if sampleTime <= initialTime
146− then initialValue
147− else let lastTime = pred sampleTime
148− in fromMaybe (f lastTime) $ unEvent e lastTime
149−
150− holdDyn :: a -> Event (Pure t) a -> t -> Dynamic (Pure t) a
151− holdDyn initialValue e initialTime =
152− let Behavior f = hold initialValue e initialTime
153− in Dynamic $ \t -> (f t, unEvent e t)
154−
155− holdIncremental :: Patch p => a -> Event (Pure t) (p a) -> t -> Incremental (Pure t) p a
156− holdIncremental initialValue e initialTime = Incremental $ \t -> (f t, unEvent e t)
157− where f = memo $ \sampleTime ->
158− -- Really, the sampleTime should never be prior to the initialTime,
159− -- because that would mean the Behavior is being sampled before
160− -- being created.
161− if sampleTime <= initialTime
162− then initialValue
163− else let lastTime = pred sampleTime
164− lastValue = f lastTime
165− in case unEvent e lastTime of
166− Nothing -> lastValue
167− Just x -> fromMaybe lastValue $ apply x lastValue
src/Reflex/Spider.hsdeleted−10
@@ -1,10 +0,0 @@
1−-- | This module exports all of the user-facing functionality of the 'Spider'
2−-- 'Reflex' engine
3−module Reflex.Spider ( Spider
4− , SpiderEnv
5− , Global
6− , SpiderHost
7− , runSpiderHost
8− ) where
9−
10−import Reflex.Spider.Internal
src/Reflex/Spider/Internal.hsdeleted−2261
@@ -1,2261 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE ConstraintKinds #-}
4−{-# LANGUAGE EmptyDataDecls #-}
5−{-# LANGUAGE ExistentialQuantification #-}
6−{-# LANGUAGE FlexibleContexts #-}
7−{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE GADTs #-}
10−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11−{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
15−{-# LANGUAGE RankNTypes #-}
16−{-# LANGUAGE RoleAnnotations #-}
17−{-# LANGUAGE ScopedTypeVariables #-}
18−{-# LANGUAGE TypeFamilies #-}
19−{-# LANGUAGE TypeOperators #-}
20−{-# LANGUAGE UndecidableInstances #-}
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
24− ( Spider
25− , SpiderEnv (..)
26− , Global
27− , SpiderHost
28− , runSpiderHost
29− , newSpiderEnv
30− , askSpiderEnv
31− , SpiderEventHandle
32− ) where
33−
34−import Control.Applicative
35−import Control.Concurrent
36−import Control.Exception
37−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
38−import Control.Monad.Exception
39−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
40−import Control.Monad.Primitive
41−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
42−import Control.Monad.Ref
43−import Data.Align
44−import Data.Coerce
45−import Data.Dependent.Map (DMap, DSum (..))
46−import qualified Data.Dependent.Map as DMap
47−import Data.Foldable hiding (concat, elem, sequence_)
48−import Data.Function
49−import Data.Functor.Compose
50−import Data.Functor.Constant
51−import Data.Functor.Product
52−import Data.GADT.Compare
53−import Data.IntMap.Strict (IntMap)
54−import qualified Data.IntMap.Strict as IntMap
55−import Data.IORef
56−import Data.List hiding (foldl')
57−import Data.Maybe
58−import Data.Monoid ((<>))
59−import Data.Some (Some)
60−import qualified Data.Some as Some
61−import Data.These
62−import Data.Traversable
63−import Data.Word
64−import GHC.IORef (IORef (..))
65−import GHC.Stack
66−import System.IO.Unsafe
67−import System.Mem.Weak
68−import Unsafe.Coerce
69−
70−#ifdef DEBUG_CYCLES
71−import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
72−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
73−import qualified Data.List.NonEmpty as NonEmpty
74−import Data.Monoid (mempty)
75−import Data.Tree (Forest, Tree (..), drawForest)
76−#endif
77−
78−import Data.WeakBag (WeakBag, WeakBagTicket)
79−import qualified Data.WeakBag as WeakBag
80−import qualified Reflex.Class as R
81−import qualified Reflex.Host.Class as R
82−
83−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
84−import Prelude hiding (any, concat, mapM, mapM_, sequence)
85−
86−debugPropagate :: Bool
87−
88−debugInvalidateHeight :: Bool
89−
90−debugInvalidate :: Bool
91−
92−#ifdef DEBUG
93−
94−#define DEBUG_NODEIDS
95−
96−debugPropagate = True
97−
98−debugInvalidateHeight = False
99−
100−debugInvalidate = True
101−
102−class HasNodeId a where
103− getNodeId :: a -> Int
104−
105−instance HasNodeId (Hold x p a) where
106− getNodeId = holdNodeId
107−
108−instance HasNodeId (PushSubscribed x a b) where
109− getNodeId = pushSubscribedNodeId
110−
111−instance HasNodeId (SwitchSubscribed x a) where
112− getNodeId = switchSubscribedNodeId
113−
114−instance HasNodeId (MergeSubscribed x a) where
115− getNodeId = mergeSubscribedNodeId
116−
117−instance HasNodeId (FanSubscribed x a) where
118− getNodeId = fanSubscribedNodeId
119−
120−instance HasNodeId (CoincidenceSubscribed x a) where
121− getNodeId = coincidenceSubscribedNodeId
122−
123−instance HasNodeId (RootSubscribed x a) where
124− getNodeId = rootSubscribedNodeId
125−
126−instance HasNodeId (Pull x a) where
127− getNodeId = pullNodeId
128−
129−{-# INLINE showNodeId #-}
130−showNodeId :: HasNodeId a => a -> String
131−showNodeId = ("#"<>) . show . getNodeId
132−
133−showSubscriberType :: Subscriber x a -> String
134−showSubscriberType = \case
135− SubscriberPush _ _ -> "SubscriberPush"
136− SubscriberMerge _ _ -> "SubscriberMerge"
137− SubscriberFan _ -> "SubscriberFan"
138− SubscriberMergeChange _ -> "SubscriberMergeChange"
139− SubscriberHold _ -> "SubscriberHold"
140− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
141− SubscriberSwitch _ -> "SubscriberSwitch"
142− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
143− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
144− SubscriberHandle -> "SubscriberHandle"
145−
146−showEventType :: Event x a -> String
147−showEventType = \case
148− EventRoot _ _ -> "EventRoot"
149− EventNever -> "EventNever"
150− EventPush _ -> "EventPush"
151− EventMerge _ -> "EventMerge"
152− EventFan _ _ -> "EventFan"
153− EventSwitch _ -> "EventSwitch"
154− EventCoincidence _ -> "EventCoincidence"
155− EventHold _ -> "EventHold"
156− EventDyn _ -> "EventDyn"
157− EventHoldIdentity _ -> "EventHoldIdentity"
158− EventDynIdentity _ -> "EventDynIdentity"
159−
160−#else
161−
162−debugPropagate = False
163−
164−debugInvalidateHeight = False
165−
166−debugInvalidate = False
167−
168−-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
169−{-# INLINE showNodeId #-}
170−showNodeId :: a -> String
171−showNodeId _ = ""
172−
173−#endif
174−
175−#ifdef DEBUG_NODEIDS
176−{-# NOINLINE nextNodeIdRef #-}
177−nextNodeIdRef :: IORef Int
178−nextNodeIdRef = unsafePerformIO $ newIORef 1
179−
180−newNodeId :: IO Int
181−newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
182−
183−{-# NOINLINE unsafeNodeId #-}
184−unsafeNodeId :: a -> Int
185−unsafeNodeId a = unsafePerformIO $ do
186− touch a
187− newNodeId
188−#endif
189−
190−--------------------------------------------------------------------------------
191−-- Event
192−--------------------------------------------------------------------------------
193−
194−newtype Event x a = Event { subscribeAndRead :: Subscriber x a -> EventM x (EventSubscription x a, Maybe a) }
195−
196−subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x a)
197−subscribe e s = fst <$> subscribeAndRead e s
198−
199−{-# INLINE wrap #-}
200−wrap :: MonadIO m => (t -> EventSubscribed x a) -> (Subscriber x a -> m (WeakBagTicket (Subscriber x a), t, Maybe a)) -> Subscriber x a -> m (EventSubscription x a, Maybe a)
201−wrap tag getSpecificSubscribed sub = do
202− (sln, subd, occ) <- getSpecificSubscribed sub
203− let es = tag subd
204− return (EventSubscription (Just sln) es, occ)
205−
206−eventRoot :: GCompare k => k a -> Root x k -> Event x a
207−eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
208−
209−eventNever :: Event x a
210−eventNever = Event $ \_ -> return (EventSubscription Nothing eventSubscribedNever, Nothing)
211−
212−eventPush :: Push x b a -> Event x a
213−eventPush !p = Event $ wrap eventSubscribedPush $ getPushSubscribed p
214−
215−eventMerge :: (GCompare k, a ~ DMap k Identity) => Merge x k -> Event x a
216−eventMerge !m = Event $ wrap eventSubscribedMerge $ getMergeSubscribed m
217−
218−eventFan :: GCompare k => k a -> Fan x k -> Event x a
219−eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
220−
221−eventSwitch :: Switch x a -> Event x a
222−eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
223−
224−eventCoincidence :: Coincidence x a -> Event x a
225−eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
226−
227−eventHold :: a ~ p b => Hold x p b -> Event x a
228−eventHold !h = Event $ subscribeHoldEvent h
229−
230−eventDyn :: (a ~ p b, R.Patch p) => Dyn x p b -> Event x a
231−eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
232−
233−eventHoldIdentity :: (a ~ Identity b) => Hold x Identity b -> Event x a
234−eventHoldIdentity !h = Event $ subscribeHoldEvent h
235−
236−eventDynIdentity :: (a ~ Identity b) => Dyn x Identity b -> Event x a
237−eventDynIdentity !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
238−
239−{-# INLINE subscribeCoincidenceInner #-}
240−subscribeCoincidenceInner :: CanSubscribe x m => Event x a -> Height -> CoincidenceSubscribed x a -> m (Maybe a, Height, EventSubscribed x a)
241−subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
242− subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
243− (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
244− innerHeight <- liftIO $ getEventSubscribedHeight innerSubd
245− let height = max innerHeight outerHeight
246− defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
247− return (innerOcc, height, innerSubd)
248−
249−--------------------------------------------------------------------------------
250−-- Subscriber
251−--------------------------------------------------------------------------------
252−
253−data Subscriber x a = Subscriber
254− { subscriberPropagate :: !(a -> EventM x ())
255− , subscriberInvalidateHeight :: !(Height -> IO ())
256− , subscriberRecalculateHeight :: !(Height -> IO ())
257− }
258−
259−--TODO: Move this comment to WeakBag
260−-- These function are constructor functions that are marked NOINLINE so they are
261−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
262−-- so any weak references that are attached to the constructors will have their
263−-- finalizer run. Using the opaque constructor, does not see the
264−-- constructor application, so it behaves like an IORef and cannot be fused away.
265−--
266−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
267−-- the weak pointer to it in some cases.
268−
269−newSubscriberPush :: (a -> ComputeM x (Maybe b)) -> PushSubscribed x a b -> IO (Subscriber x a)
270−newSubscriberPush compute subscribed = return $ Subscriber
271− { subscriberPropagate = \a -> {-# SCC "traversePush" #-} do
272− tracePropagate $ "SubscriberPush" <> showNodeId subscribed
273− occ <- runComputeM $ compute a
274− case occ of
275− Nothing -> return () -- No need to write a Nothing back into the Ref
276− Just o -> do
277− liftIO $ writeIORef (pushSubscribedOccurrence subscribed) occ
278− scheduleClear $ pushSubscribedOccurrence subscribed
279− propagate o $ pushSubscribedSubscribers subscribed
280− , subscriberInvalidateHeight = \old -> do
281− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
282− WeakBag.traverse (pushSubscribedSubscribers subscribed) $ invalidateSubscriberHeight old
283− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
284− , subscriberRecalculateHeight = \new -> do
285− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
286− WeakBag.traverse (pushSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
287− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
288− }
289−
290−newSubscriberHold :: R.Patch p => Hold x p a -> IO (Subscriber x (p a))
291−newSubscriberHold h = return $ Subscriber
292− { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
293− , subscriberInvalidateHeight = \_ -> return ()
294− , subscriberRecalculateHeight = \_ -> return ()
295− }
296−
297−newSubscriberMerge :: GCompare k => k a -> MergeSubscribed x k -> IO (Subscriber x a)
298−newSubscriberMerge k subscribed = return $ Subscriber
299− { subscriberPropagate = \a -> {-# SCC "traverseMerge" #-} do
300− tracePropagate $ "SubscriberMerge" <> showNodeId subscribed
301− oldM <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
302− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge" <> showNodeId subscribed) k (Identity a) oldM
303− tracePropagate $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
304− liftIO $ writeIORef (mergeSubscribedAccum subscribed) $! newM
305− when (DMap.null oldM) $ do -- Only schedule the firing once
306− height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
307− --TODO: assertions about height
308− currentHeight <- getCurrentHeight
309− when (height <= currentHeight) $ do
310− if height /= invalidHeight
311− then do
312− myStack <- liftIO $ whoCreatedIORef $ mergeSubscribedCachedSubscribed subscribed
313− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
314− else liftIO $ do
315−#ifdef DEBUG_CYCLES
316− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
317− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
318− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
319−#else
320− let cycleInfo = ""
321−#endif
322− error $ "Causality loop found" <> cycleInfo
323− scheduleMerge height subscribed
324− , subscriberInvalidateHeight = \old -> do
325− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
326− removeMergeHeight old subscribed
327− invalidateMergeHeight subscribed
328− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
329− , subscriberRecalculateHeight = \new -> do
330− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
331− addMergeHeight new subscribed
332− revalidateMergeHeight subscribed
333− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
334− }
335−
336−newSubscriberMergeChange :: GCompare k => MergeSubscribed x k -> IO (Subscriber x (R.PatchDMap (DMap k (Event x))))
337−newSubscriberMergeChange subscribed = return $ Subscriber
338− { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
339− tracePropagate $ "SubscriberMerge" <> showNodeId subscribed
340− defer $ SomeMergeUpdate a subscribed
341− , subscriberInvalidateHeight = \_ -> return ()
342− , subscriberRecalculateHeight = \_ -> return ()
343− }
344−
345−newSubscriberFan :: GCompare k => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
346−newSubscriberFan subscribed = return $ Subscriber
347− { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
348− subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
349− tracePropagate $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
350− liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
351− scheduleClear $ fanSubscribedOccurrence subscribed
352− let f _ (Pair (Identity v) subsubs) = do
353− propagate v $ _fanSubscribedChildren_list subsubs
354− return $ Constant ()
355− _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
356− return ()
357− , subscriberInvalidateHeight = \old -> do
358− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
359− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
360− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
361− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
362− , subscriberRecalculateHeight = \new -> do
363− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
364− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
365− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
366− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
367− }
368−
369−newSubscriberSwitch :: SwitchSubscribed x a -> IO (Subscriber x a)
370−newSubscriberSwitch subscribed = return $ Subscriber
371− { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
372− tracePropagate $ "SubscriberSwitch" <> showNodeId subscribed
373− liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
374− scheduleClear $ switchSubscribedOccurrence subscribed
375− propagate a $ switchSubscribedSubscribers subscribed
376− , subscriberInvalidateHeight = \_ -> do
377− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
378− oldHeight <- readIORef $ switchSubscribedHeight subscribed
379− when (oldHeight /= invalidHeight) $ do
380− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
381− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
382− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
383− , subscriberRecalculateHeight = \new -> do
384− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
385− updateSwitchHeight new subscribed
386− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
387− }
388−
389−newSubscriberCoincidenceOuter :: CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
390−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
391− { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
392− tracePropagate $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
393− outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
394− tracePropagate $ " outerHeight = " <> show outerHeight
395− (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
396− tracePropagate $ " isJust occ = " <> show (isJust occ)
397− tracePropagate $ " innerHeight = " <> show innerHeight
398− liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
399− scheduleClear $ coincidenceSubscribedInnerParent subscribed
400− case occ of
401− Nothing -> do
402− when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
403− writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
404− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
405− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
406− Just o -> do -- Since it's already firing, no need to adjust height
407− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
408− scheduleClear $ coincidenceSubscribedOccurrence subscribed
409− propagate o $ coincidenceSubscribedSubscribers subscribed
410− , subscriberInvalidateHeight = \_ -> do
411− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
412− invalidateCoincidenceHeight subscribed
413− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
414− , subscriberRecalculateHeight = \_ -> do
415− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
416− recalculateCoincidenceHeight subscribed
417− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
418− }
419−
420−newSubscriberCoincidenceInner :: CoincidenceSubscribed x a -> IO (Subscriber x a)
421−newSubscriberCoincidenceInner subscribed = return $ Subscriber
422− { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
423− tracePropagate $ "SubscriberCoincidenceInner" <> showNodeId subscribed
424− occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
425− case occ of
426− Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
427− Nothing -> do
428− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
429− scheduleClear $ coincidenceSubscribedOccurrence subscribed
430− propagate a $ coincidenceSubscribedSubscribers subscribed
431− , subscriberInvalidateHeight = \_ -> do
432− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
433− invalidateCoincidenceHeight subscribed
434− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
435− , subscriberRecalculateHeight = \_ -> do
436− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
437− recalculateCoincidenceHeight subscribed
438− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
439− }
440−
441−invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
442−invalidateSubscriberHeight = flip subscriberInvalidateHeight
443−
444−recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
445−recalculateSubscriberHeight = flip subscriberRecalculateHeight
446−
447−-- | Propagate everything at the current height
448−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
449−propagate a subscribers = withIncreasedDepth $ do
450− -- 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
451− --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
452− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
453−
454−--------------------------------------------------------------------------------
455−-- EventSubscribed
456−--------------------------------------------------------------------------------
457−
458−data EventSubscribed x a = forall b. EventSubscribed
459− { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
460− , eventSubscribedRetained :: {-# NOUNPACK #-} !b
461−#ifdef DEBUG_CYCLES
462− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
463− , eventSubscribedHasOwnHeightRef :: !Bool
464− , eventSubscribedWhoCreated :: !(IO [String])
465−#endif
466− }
467−
468−eventSubscribedRoot :: RootSubscribed x a -> EventSubscribed x a
469−eventSubscribedRoot !r = EventSubscribed
470− { eventSubscribedHeightRef = zeroRef
471− , eventSubscribedRetained = r
472−#ifdef DEBUG_CYCLES
473− , eventSubscribedGetParents = return []
474− , eventSubscribedHasOwnHeightRef = False
475− , eventSubscribedWhoCreated = return ["root"]
476−#endif
477− }
478−
479−eventSubscribedNever :: EventSubscribed x a
480−eventSubscribedNever = EventSubscribed
481− { eventSubscribedHeightRef = zeroRef
482− , eventSubscribedRetained = ()
483−#ifdef DEBUG_CYCLES
484− , eventSubscribedGetParents = return []
485− , eventSubscribedHasOwnHeightRef = False
486− , eventSubscribedWhoCreated = return ["never"]
487−#endif
488− }
489−
490−eventSubscribedPush :: PushSubscribed x b a -> EventSubscribed x a
491−eventSubscribedPush !subscribed = EventSubscribed
492− { eventSubscribedHeightRef = pushSubscribedHeight subscribed
493− , eventSubscribedRetained = subscribed
494−#ifdef DEBUG_CYCLES
495− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ pushSubscribedParent subscribed]
496− , eventSubscribedHasOwnHeightRef = False
497− , eventSubscribedWhoCreated = whoCreatedIORef $ pushSubscribedCachedSubscribed subscribed
498−#endif
499− }
500−
501−eventSubscribedMerge :: MergeSubscribed x k -> EventSubscribed x a
502−eventSubscribedMerge !subscribed = EventSubscribed
503− { eventSubscribedHeightRef = mergeSubscribedHeight subscribed
504− , eventSubscribedRetained = subscribed
505−#ifdef DEBUG_CYCLES
506− , eventSubscribedGetParents = do
507− ps <- readIORef $ mergeSubscribedParents subscribed
508− return $ R.ffor (DMap.toList ps) $ \(_ :=> v) -> Some.This $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription v
509− , eventSubscribedHasOwnHeightRef = True
510− , eventSubscribedWhoCreated = whoCreatedIORef $ mergeSubscribedCachedSubscribed subscribed
511−#endif
512− }
513−
514−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x a
515−eventSubscribedFan !subscribed = EventSubscribed
516− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
517− , eventSubscribedRetained = subscribed
518−#ifdef DEBUG_CYCLES
519− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
520− , eventSubscribedHasOwnHeightRef = False
521− , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
522−#endif
523− }
524−
525−eventSubscribedSwitch :: SwitchSubscribed x a -> EventSubscribed x a
526−eventSubscribedSwitch !subscribed = EventSubscribed
527− { eventSubscribedHeightRef = switchSubscribedHeight subscribed
528− , eventSubscribedRetained = subscribed
529−#ifdef DEBUG_CYCLES
530− , eventSubscribedGetParents = do
531− s <- readIORef $ switchSubscribedCurrentParent subscribed
532− return [Some.This $ _eventSubscription_subscribed s]
533− , eventSubscribedHasOwnHeightRef = True
534− , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
535−#endif
536− }
537−
538−eventSubscribedCoincidence :: CoincidenceSubscribed x a -> EventSubscribed x a
539−eventSubscribedCoincidence !subscribed = EventSubscribed
540− { eventSubscribedHeightRef = coincidenceSubscribedHeight subscribed
541− , eventSubscribedRetained = subscribed
542−#ifdef DEBUG_CYCLES
543− , eventSubscribedGetParents = do
544− innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
545− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
546− innerParents = maybeToList $ fmap Some.This innerSubscription
547− return $ outerParent : innerParents
548− , eventSubscribedHasOwnHeightRef = True
549− , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
550−#endif
551− }
552−
553−getEventSubscribedHeight :: EventSubscribed x a -> IO Height
554−getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
555−
556−#ifdef DEBUG_CYCLES
557−whoCreatedEventSubscribed :: EventSubscribed x a -> IO [String]
558−whoCreatedEventSubscribed = eventSubscribedWhoCreated
559−
560−walkInvalidHeightParents :: EventSubscribed x a -> IO [Some (EventSubscribed x)]
561−walkInvalidHeightParents s0 = do
562− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
563− h <- liftIO $ readIORef $ eventSubscribedHeightRef s
564− when (h == invalidHeight) $ do
565− when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
566− modify (Some.This s :)
567− mapM_ loop =<< liftIO (eventSubscribedGetParents s)
568− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
569− return subscribers
570−#endif
571−
572−{-# INLINE subscribeHoldEvent #-}
573−subscribeHoldEvent :: CanSubscribe x m => Hold x p a -> Subscriber x (p a) -> m (EventSubscription x (p a), Maybe (p a))
574−subscribeHoldEvent = subscribeAndRead . holdEvent
575−
576−--------------------------------------------------------------------------------
577−-- EventSubscription
578−--------------------------------------------------------------------------------
579−
580−data EventSubscription x a = EventSubscription
581− { _eventSubscription_ticket :: !(Maybe (WeakBagTicket (Subscriber x a)))
582− , _eventSubscription_subscribed :: !(EventSubscribed x a)
583− }
584−
585−unsubscribe :: EventSubscription x a -> IO ()
586−unsubscribe (EventSubscription msln _) = forM_ msln $ \sln -> WeakBag.remove sln
587−
588−--------------------------------------------------------------------------------
589−-- Combinators
590−--------------------------------------------------------------------------------
591−
592−--TODO: Figure out why certain things are not 'representational', then make them
593−--representational so we can use coerce
594−
595−--type role Hold representational
596−data Hold x p a
597− = Hold { holdValue :: !(IORef a)
598− , holdInvalidators :: !(IORef [Weak (Invalidator x)])
599− , holdEvent :: Event x (p a) -- This must be lazy, or holds cannot be defined before their input Events
600− , holdParent :: !(IORef (Maybe (EventSubscription x (p a)))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
601−#ifdef DEBUG_NODEIDS
602− , holdNodeId :: Int
603−#endif
604− }
605−
606−data EventEnv x
607− = EventEnv { eventEnvSpiderEnv :: !(SpiderEnv x)
608− , eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
609− , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
610− , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
611− , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
612− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
613− , eventEnvRootClears :: !(IORef [SomeRootClear])
614− , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
615− , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
616− , eventEnvDelayedMerges :: !(IORef (IntMap [DelayedMerge x]))
617− }
618−
619−{-# INLINE runEventM #-}
620−runEventM :: EventM x a -> EventEnv x -> IO a
621−runEventM = runReaderT . unEventM
622−
623−class MonadIO m => Defer a m where
624− getDeferralQueue :: m (IORef [a])
625−
626−{-# INLINE defer #-}
627−defer :: Defer a m => a -> m ()
628−defer a = do
629− q <- getDeferralQueue
630− liftIO $ modifyIORef' q (a:)
631−
632−instance Defer (SomeAssignment x) (EventM x) where
633− {-# INLINE getDeferralQueue #-}
634− getDeferralQueue = EventM $ asks eventEnvAssignments
635−
636−instance Defer (SomeHoldInit x) (EventM x) where
637− {-# INLINE getDeferralQueue #-}
638− getDeferralQueue = EventM $ asks eventEnvHoldInits
639−
640−instance Defer (SomeHoldInit x) (BehaviorM x) where
641− {-# INLINE getDeferralQueue #-}
642− getDeferralQueue = BehaviorM $ asks snd
643−
644−instance Defer (SomeMergeUpdate x) (EventM x) where
645− {-# INLINE getDeferralQueue #-}
646− getDeferralQueue = EventM $ asks eventEnvMergeUpdates
647−
648−instance Defer (SomeMergeInit x) (EventM x) where
649− {-# INLINE getDeferralQueue #-}
650− getDeferralQueue = EventM $ asks eventEnvMergeInits
651−
652−class HasCurrentHeight x m | m -> x where
653− getCurrentHeight :: m Height
654− scheduleMerge :: Height -> MergeSubscribed x a -> m ()
655−
656−instance HasCurrentHeight x (EventM x) where
657− {-# INLINE getCurrentHeight #-}
658− getCurrentHeight = EventM $ do
659− heightRef <- asks eventEnvCurrentHeight
660− liftIO $ readIORef heightRef
661− {-# INLINE scheduleMerge #-}
662− scheduleMerge height subscribed = EventM $ do
663− delayedRef <- asks eventEnvDelayedMerges
664− liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [DelayedMerge subscribed]
665−
666−class HasSpiderEnv x m | m -> x where
667− -- | Retrieve the current SpiderEnv
668− askSpiderEnv :: m (SpiderEnv x)
669−
670−instance HasSpiderEnv x (EventM x) where
671− {-# INLINE askSpiderEnv #-}
672− askSpiderEnv = EventM $ asks eventEnvSpiderEnv
673−
674−instance HasSpiderEnv x (SpiderHost x) where
675− {-# INLINE askSpiderEnv #-}
676− askSpiderEnv = SpiderHost ask
677−
678−putCurrentHeight :: Height -> EventM x ()
679−putCurrentHeight h = EventM $ do
680− heightRef <- asks eventEnvCurrentHeight
681− liftIO $ writeIORef heightRef $! h
682−
683−instance Defer SomeClear (EventM x) where
684− {-# INLINE getDeferralQueue #-}
685− getDeferralQueue = EventM $ asks eventEnvClears
686−
687−{-# INLINE scheduleClear #-}
688−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
689−scheduleClear r = defer $ SomeClear r
690−
691−instance Defer SomeRootClear (EventM x) where
692− {-# INLINE getDeferralQueue #-}
693− getDeferralQueue = EventM $ asks eventEnvRootClears
694−
695−{-# INLINE scheduleRootClear #-}
696−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
697−scheduleRootClear r = defer $ SomeRootClear r
698−
699−instance Defer (SomeResetCoincidence x) (EventM x) where
700− {-# INLINE getDeferralQueue #-}
701− getDeferralQueue = EventM $ asks eventEnvResetCoincidences
702−
703−-- Note: hold cannot examine its event until after the phase is over
704−{-# SPECIALIZE hold :: R.Patch p => a -> Event x (p a) -> EventM x (Hold x p a) #-}
705−{-# SPECIALIZE hold :: R.Patch p => a -> Event x (p a) -> ComputeM x (Hold x p a) #-}
706−hold :: (R.Patch p, Defer (SomeHoldInit x) m) => a -> Event x (p a) -> m (Hold x p a)
707−hold v0 e = do
708− valRef <- liftIO $ newIORef v0
709− invsRef <- liftIO $ newIORef []
710− parentRef <- liftIO $ newIORef Nothing
711−#ifdef DEBUG_NODEIDS
712− nodeId <- liftIO newNodeId
713−#endif
714− let h = Hold
715− { holdValue = valRef
716− , holdInvalidators = invsRef
717− , holdEvent = e
718− , holdParent = parentRef
719−#ifdef DEBUG_NODEIDS
720− , holdNodeId = nodeId
721−#endif
722− }
723− defer $ SomeHoldInit h
724− return h
725−
726−{-# INLINE getHoldEventSubscription #-}
727−getHoldEventSubscription :: forall m p a 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, HasSpiderEnv x m, m ~ EventM x) => Hold x p a -> m (EventSubscription x (p a))
728−getHoldEventSubscription h = do
729− ep <- liftIO $ readIORef $ holdParent h
730− case ep of
731− Just subd -> return subd
732− Nothing -> do
733− let e = holdEvent h
734− subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
735− (subscription@(EventSubscription _ _), occ) <- subscribeAndRead e =<< liftIO (newSubscriberHold h)
736− liftIO $ writeIORef subscriptionRef $! subscription
737− case occ of
738− Nothing -> return ()
739− Just o -> do
740− old <- liftIO $ readIORef $ holdValue h
741− case R.apply o old of
742− Nothing -> return ()
743− Just new -> do
744− -- Need to evaluate these so that we don't retain the Hold itself
745− v <- liftIO $ evaluate $ holdValue h
746− i <- liftIO $ evaluate $ holdInvalidators h
747− defer $ SomeAssignment v i new
748− liftIO $ writeIORef (holdParent h) $ Just subscription
749− return subscription
750−
751−type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
752−
753−--type role BehaviorM representational
754−-- BehaviorM can sample behaviors
755−newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderT (BehaviorEnv x) IO a } deriving (Functor, Applicative, MonadIO, MonadFix)
756−
757−instance Monad (BehaviorM x) where
758− {-# INLINE (>>=) #-}
759− BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
760− {-# INLINE (>>) #-}
761− BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
762− {-# INLINE return #-}
763− return x = BehaviorM $ return x
764− {-# INLINE fail #-}
765− fail s = BehaviorM $ fail s
766−
767−data BehaviorSubscribed x a
768− = forall p. BehaviorSubscribedHold (Hold x p a)
769− | BehaviorSubscribedPull (PullSubscribed x a)
770−
771−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
772−
773−--type role PullSubscribed representational
774−data PullSubscribed x a
775− = PullSubscribed { pullSubscribedValue :: !a
776− , pullSubscribedInvalidators :: !(IORef [Weak (Invalidator x)])
777− , pullSubscribedOwnInvalidator :: !(Invalidator x)
778− , pullSubscribedParents :: ![SomeBehaviorSubscribed x] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
779− }
780−
781−--type role Pull representational
782−data Pull x a
783− = Pull { pullValue :: !(IORef (Maybe (PullSubscribed x a)))
784− , pullCompute :: !(BehaviorM x a)
785−#ifdef DEBUG_NODEIDS
786− , pullNodeId :: Int
787−#endif
788− }
789−
790−data Invalidator x
791− = forall a. InvalidatorPull (Pull x a)
792− | forall a. InvalidatorSwitch (SwitchSubscribed x a)
793−
794−data RootSubscribed x a = forall k. GCompare k => RootSubscribed
795− { rootSubscribedKey :: !(k a)
796− , rootSubscribedCachedSubscribed :: !(IORef (DMap k (RootSubscribed x))) -- From the original Root
797− , rootSubscribedSubscribers :: !(WeakBag (Subscriber x a))
798− , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
799− , rootSubscribedUninit :: IO ()
800− , 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?
801−#ifdef DEBUG_NODEIDS
802− , rootSubscribedNodeId :: Int
803−#endif
804− }
805−
806−data Root x (k :: * -> *)
807− = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
808− , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
809− , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
810− }
811−
812−data SomeHoldInit x = forall p a. R.Patch p => SomeHoldInit !(Hold x p a)
813−
814−data SomeMergeUpdate x = forall k. GCompare k => SomeMergeUpdate (R.PatchDMap (DMap k (Event x))) (MergeSubscribed x k)
815−
816−data SomeMergeInit x = forall k. GCompare k => SomeMergeInit !(MergeSubscribed x k) !(Event x (R.PatchDMap (DMap k (Event x))))
817−
818−data SomeEventSubscription x = forall a. SomeEventSubscription (EventSubscription x a)
819−
820−-- EventM can do everything BehaviorM can, plus create holds
821−newtype EventM x (a :: *) = EventM { unEventM :: ReaderT (EventEnv x) 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
822−
823−data PushSubscribed x a b
824− = PushSubscribed { pushSubscribedCachedSubscribed :: !(IORef (Maybe (PushSubscribed x a b)))
825− , pushSubscribedOccurrence :: !(IORef (Maybe b)) -- If the current height is less than our height, this should always be Nothing; during our height, this will get filled in at some point, always before our children are notified; after our height, this will be filled in with the correct value (Nothing if we are not firing, Just if we are)
826− , pushSubscribedHeight :: !(IORef Height)
827− , pushSubscribedSubscribers :: !(WeakBag (Subscriber x b))
828− , pushSubscribedSelf :: !(Subscriber x a) -- Hold this in memory to ensure our WeakReferences don't die --TODO: Probably unneeded now
829− , pushSubscribedWeakSelf :: !(IORef (Weak (PushSubscribed x a b)))
830− , pushSubscribedParent :: !(EventSubscription x a)
831−#ifdef DEBUG_NODEIDS
832− , pushSubscribedNodeId :: Int
833−#endif
834− }
835−
836−newtype ComputeM x a = ComputeM (ReaderT (IORef [SomeHoldInit x]) IO a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
837−
838−instance Defer (SomeHoldInit x) (ComputeM x) where
839− getDeferralQueue = ComputeM ask
840−
841−{-# SPECIALIZE runComputeM :: ComputeM x a -> EventM x a #-}
842−runComputeM :: Defer (SomeHoldInit x) m => ComputeM x a -> m a
843−runComputeM (ComputeM a) = liftIO . runReaderT a =<< getDeferralQueue
844−
845−data Push x a b
846− = Push { pushCompute :: !(a -> ComputeM x (Maybe b)) -- Compute the current firing value; assumes that its parent has been computed --TODO: This only uses Defer SomeHoldInit EventM; perhaps only the hold init queue should be passed in (also, perhaps those hold inits can be accelerated - can there be a loop we would need to worry about?)
847− , pushParent :: !(Event x a)
848− , pushSubscribed :: !(IORef (Maybe (PushSubscribed x a b))) --TODO: Can we replace this with an unsafePerformIO thunk?
849− }
850−
851−data MergeSubscribedParent (x :: *) k a = MergeSubscribedParent !(EventSubscription x a) !(Subscriber x a)
852−
853−mergeSubscribedParentSubscription :: MergeSubscribedParent x k a -> EventSubscription x a
854−mergeSubscribedParentSubscription (MergeSubscribedParent es _) = es
855−
856−data HeightBag = HeightBag
857− { _heightBag_size :: {-# UNPACK #-} !Int
858− , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
859− }
860− deriving (Show, Read, Eq, Ord)
861−
862−heightBagEmpty :: HeightBag
863−heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
864−
865−heightBagSize :: HeightBag -> Int
866−heightBagSize = _heightBag_size
867−
868−heightBagFromList :: [Height] -> HeightBag
869−heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
870−
871−heightBagAdd :: Height -> HeightBag -> HeightBag
872−heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
873−
874−heightBagRemove :: Height -> HeightBag -> HeightBag
875−heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
876− Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
877− Just old -> HeightBag (pred s) $ case old of
878− 0 -> IntMap.delete h c
879− _ -> IntMap.insert h (pred old) c
880−
881−heightBagMax :: HeightBag -> Height
882−heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
883− Just ((h, _), _) -> Height h
884− Nothing -> zeroHeight
885−
886−heightBagVerify :: HeightBag -> HeightBag
887−#ifdef DEBUG
888−heightBagVerify b@(HeightBag s c) = if
889− | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
890− -> error $ "heightBagVerify: size doesn't match: " <> show b
891− | unHeight invalidHeight `IntMap.member` c
892− -> error $ "heightBagVerify: contains invalid height: " <> show b
893− | otherwise -> b
894−#else
895−heightBagVerify = id
896−#endif
897−
898−data MergeSubscribed x k
899− = MergeSubscribed { mergeSubscribedCachedSubscribed :: !(IORef (Maybe (MergeSubscribed x k))) -- From the original merge
900− , mergeSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
901− , mergeSubscribedAccum :: !(IORef (DMap k Identity)) -- This will accumulate occurrences until our height is reached, at which point it will be transferred to mergeSubscribedOccurrence
902− , mergeSubscribedHeight :: !(IORef Height)
903− , mergeSubscribedHeightBag :: !(IORef HeightBag)
904− , mergeSubscribedSubscribers :: !(WeakBag (Subscriber x (DMap k Identity)))
905− , mergeSubscribedChange :: !(IORef (Subscriber x (R.PatchDMap (DMap k (Event x))), EventSubscribed x (R.PatchDMap (DMap k (Event x)))))
906− , mergeSubscribedParents :: !(IORef (DMap k (MergeSubscribedParent x k)))
907− , mergeSubscribedWeakSelf :: !(IORef (Weak (MergeSubscribed x k)))
908−#ifdef DEBUG_NODEIDS
909− , mergeSubscribedNodeId :: Int
910−#endif
911− }
912−
913−--TODO: DMap sucks; we should really write something better (with a functor for the value as well as the key)
914−data Merge x k
915− = Merge { mergeParents :: !(Dynamic x R.PatchDMap (DMap k (Event x)))
916− , mergeSubscribed :: !(IORef (Maybe (MergeSubscribed x k)))
917− }
918−
919−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
920− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
921− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
922− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
923− }
924−
925−data FanSubscribed (x :: *) k
926− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
927− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
928− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
929− , fanSubscribedParent :: !(EventSubscription x (DMap k Identity))
930−#ifdef DEBUG_NODEIDS
931− , fanSubscribedNodeId :: Int
932−#endif
933− }
934−
935−data Fan x k
936− = Fan { fanParent :: !(Event x (DMap k Identity))
937− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
938− }
939−
940−data SwitchSubscribed x a
941− = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
942− , switchSubscribedOccurrence :: !(IORef (Maybe a))
943− , switchSubscribedHeight :: !(IORef Height)
944− , switchSubscribedSubscribers :: !(WeakBag (Subscriber x a))
945− , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !(Invalidator x)
946− , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak (Invalidator x)))
947− , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed x])
948− , switchSubscribedParent :: !(Behavior x (Event x a))
949− , switchSubscribedCurrentParent :: !(IORef (EventSubscription x a))
950− , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed x a)))
951−#ifdef DEBUG_NODEIDS
952− , switchSubscribedNodeId :: Int
953−#endif
954− }
955−
956−data Switch x a
957− = Switch { switchParent :: !(Behavior x (Event x a))
958− , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
959− }
960−
961−{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
962−data CoincidenceSubscribed x a
963− = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
964− , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
965− , coincidenceSubscribedSubscribers :: !(WeakBag (Subscriber x a))
966− , coincidenceSubscribedHeight :: !(IORef Height)
967− , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber x (Event x a))
968− , coincidenceSubscribedOuterParent :: !(EventSubscription x (Event x a))
969− , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed x a)))
970− , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed x a)))
971−#ifdef DEBUG_NODEIDS
972− , coincidenceSubscribedNodeId :: Int
973−#endif
974− }
975−
976−data Coincidence x a
977− = Coincidence { coincidenceParent :: !(Event x (Event x a))
978− , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
979− }
980−
981−{-# NOINLINE newInvalidatorSwitch #-}
982−newInvalidatorSwitch :: SwitchSubscribed x a -> IO (Invalidator x)
983−newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
984−
985−{-# NOINLINE newInvalidatorPull #-}
986−newInvalidatorPull :: Pull x a -> IO (Invalidator x)
987−newInvalidatorPull p = return $! InvalidatorPull p
988−
989−data Dynamic x p a
990− = DynamicHold !(Hold x p a)
991− | p ~ Identity => DynamicHoldIdentity !(Hold x Identity a)
992− | DynamicConst !a
993− | DynamicDyn !(Dyn x p a)
994− | p ~ Identity => DynamicDynIdentity !(Dyn x Identity a)
995−
996−{-# INLINE current #-}
997−current :: R.Patch p => Dynamic x p a -> Behavior x a
998−current = \case
999− DynamicHold h -> BehaviorHold h
1000− DynamicHoldIdentity h -> BehaviorHoldIdentity h
1001− DynamicConst a -> BehaviorConst a
1002− DynamicDyn d -> BehaviorDyn d
1003− DynamicDynIdentity d -> BehaviorDynIdentity d
1004−
1005−--TODO: If you only need updated, not current, can we avoid actually constructing the Hold?
1006−{-# INLINE updated #-}
1007−updated :: R.Patch p => Dynamic x p a -> Event x (p a)
1008−updated = \case
1009− DynamicHold h -> eventHold h
1010− DynamicHoldIdentity h -> eventHoldIdentity h
1011− DynamicConst _ -> eventNever
1012− DynamicDyn d -> eventDyn d
1013− DynamicDynIdentity d -> eventDynIdentity d
1014−
1015−newMapDyn :: (a -> b) -> Dynamic x Identity a -> Dynamic x Identity b
1016−newMapDyn f d = DynamicDynIdentity $ unsafeDyn (fmap f $ readBehaviorTracked $ current d) (Identity . f . runIdentity <$> updated d)
1017−
1018−instance Functor (Dynamic x Identity) where
1019− fmap = newMapDyn
1020−
1021−instance Applicative (Dynamic x Identity) where
1022− pure = DynamicConst
1023− (<*>) = zipDynWith ($)
1024− _ *> b = b
1025− a <* _ = a
1026−
1027−instance R.FunctorMaybe (Event x) where
1028− fmapMaybe f = push $ return . f
1029−
1030−instance Align (Event x) where
1031− nil = eventNever
1032− align ea eb = R.fmapMaybe R.dmapToThese $ merge $ DynamicConst $ DMap.fromList [R.LeftTag :=> ea, R.RightTag :=> eb]
1033−
1034−--TODO: Avoid the duplication between this and R.zipDynWith
1035−zipDynWith :: (a -> b -> c) -> Dynamic x Identity a -> Dynamic x Identity b -> Dynamic x Identity c
1036−zipDynWith f da db =
1037− let eab = align (updated da) (updated db)
1038− ec = flip push eab $ \o -> do
1039− (a, b) <- case o of
1040− This (Identity a) -> do
1041− b <- readBehaviorUntracked $ current db
1042− return (a, b)
1043− That (Identity b) -> do
1044− a <- readBehaviorUntracked $ current da
1045− return (a, b)
1046− These (Identity a) (Identity b) -> return (a, b)
1047− return $ Just $ Identity $ f a b
1048− in DynamicDynIdentity $ unsafeDyn (f <$> readBehaviorUntracked (current da) <*> readBehaviorUntracked (current db)) ec
1049−
1050−instance Monad (Dynamic x Identity) where
1051− {-# INLINE return #-}
1052− return = pure
1053− {-# INLINE (>>=) #-}
1054− x >>= f = DynamicDynIdentity $ newJoinDyn $ newMapDyn f x --TODO: (>>), fail
1055− {-# INLINE (>>) #-}
1056− _ >> y = y
1057− {-# INLINE fail #-}
1058− fail _ = error "Dynamic does not support 'fail'"
1059−
1060−newtype Dyn x p a = Dyn { unDyn :: IORef (Either (BehaviorM x a, Event x (p a)) (Hold x p a)) }
1061−
1062−unsafeDyn :: BehaviorM x a -> Event x (p a) -> Dyn x p a
1063−unsafeDyn readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1064− where x = (readV0, v')
1065−
1066−newJoinDyn :: Dynamic x Identity (Dynamic x Identity a) -> Dyn x Identity a
1067−newJoinDyn d =
1068− let readV0 = readBehaviorTracked . current =<< readBehaviorTracked (current d)
1069− eOuter = push (fmap (Just . Identity) . readBehaviorUntracked . current . runIdentity) $ updated d
1070− eInner = switch $ updated <$> current d
1071− eBoth = coincidence $ updated . runIdentity <$> updated d
1072− v' = unSpiderEvent $ R.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
1073− in unsafeDyn readV0 v'
1074−
1075−--type role Behavior representational
1076−data Behavior x a
1077− = forall p. BehaviorHold !(Hold x p a)
1078− | BehaviorHoldIdentity !(Hold x Identity a)
1079− | BehaviorConst !a
1080− | BehaviorPull !(Pull x a)
1081− | BehaviorDynIdentity !(Dyn x Identity a)
1082− | forall p. R.Patch p => BehaviorDyn !(Dyn x p a)
1083−
1084−-- ResultM can read behaviors and events
1085−type ResultM = EventM
1086−
1087−{-# NOINLINE unsafeNewIORef #-}
1088−unsafeNewIORef :: a -> b -> IORef b
1089−unsafeNewIORef _ b = unsafePerformIO $ newIORef b
1090−
1091−instance Functor (Event x) where
1092− fmap f = push $ return . Just . f
1093−
1094−instance Functor (Behavior x) where
1095− fmap f = pull . fmap f . readBehaviorTracked
1096−
1097−{-# NOINLINE push #-} --TODO: If this is helpful, we can get rid of the unsafeNewIORef and use unsafePerformIO directly
1098−push :: (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
1099−push f e = eventPush $ Push
1100− { pushCompute = f
1101− , pushParent = e
1102− , pushSubscribed = unsafeNewIORef (f, e) Nothing --TODO: Does the use of the tuple here create unnecessary overhead?
1103− }
1104−-- DISABLED: {- RULES "push/push" forall f g e. push f (push g e) = push (maybe (return Nothing) f <=< g) e #-}
1105−
1106−{-# NOINLINE pull #-}
1107−pull :: BehaviorM x a -> Behavior x a
1108−pull a = BehaviorPull $ Pull
1109− { pullCompute = a
1110− , pullValue = unsafeNewIORef a Nothing
1111−#ifdef DEBUG_NODEIDS
1112− , pullNodeId = unsafeNodeId a
1113−#endif
1114− }
1115−
1116−{-# NOINLINE switch #-}
1117−switch :: Behavior x (Event x a) -> Event x a
1118−switch a = eventSwitch $ Switch
1119− { switchParent = a
1120− , switchSubscribed = unsafeNewIORef a Nothing
1121− }
1122−
1123−coincidence :: Event x (Event x a) -> Event x a
1124−coincidence a = eventCoincidence $ Coincidence
1125− { coincidenceParent = a
1126− , coincidenceSubscribed = unsafeNewIORef a Nothing
1127− }
1128−
1129−-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1130−run :: [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1131−run roots after = do
1132− tracePropagate $ "Running an event frame with " <> show (length roots) <> " events"
1133− spiderEnv <- SpiderHost ask
1134− result <- SpiderHost $ lift $ withMVar (_spiderEnv_lock spiderEnv) $ \_ -> flip runReaderT spiderEnv $ unSpiderHost $ runFrame $ do
1135− rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1136− occBefore <- liftIO $ do
1137− occBefore <- readIORef occRef
1138− writeIORef occRef $! DMap.insert k a occBefore
1139− return occBefore
1140− if DMap.null occBefore
1141− then do scheduleRootClear occRef
1142− return $ Just r
1143− else return Nothing
1144− forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
1145− propagate a subscribersRef
1146− delayedRef <- EventM $ asks eventEnvDelayedMerges
1147− let go = do
1148− delayed <- liftIO $ readIORef delayedRef
1149− case IntMap.minViewWithKey delayed of
1150− Nothing -> return ()
1151− Just ((currentHeight, cur), future) -> do
1152− tracePropagate $ "Running height " ++ show currentHeight
1153− putCurrentHeight $ Height currentHeight
1154− liftIO $ writeIORef delayedRef $! future
1155− forM_ cur $ \d -> case d of
1156− DelayedMerge subscribed -> do
1157− height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
1158− case height `compare` Height currentHeight of
1159− LT -> error "Somehow a merge's height has been decreased after it was scheduled"
1160− GT -> scheduleMerge height subscribed -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1161− EQ -> do
1162− m <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
1163− liftIO $ writeIORef (mergeSubscribedAccum subscribed) $! DMap.empty
1164− --TODO: Assert that m is not empty
1165− liftIO $ writeIORef (mergeSubscribedOccurrence subscribed) $ Just m
1166− scheduleClear $ mergeSubscribedOccurrence subscribed
1167− propagate m $ mergeSubscribedSubscribers subscribed
1168− go
1169− go
1170− putCurrentHeight maxBound
1171− after
1172− tracePropagate "Done running an event frame"
1173− return result
1174−
1175−data SomeClear = forall a. SomeClear (IORef (Maybe a))
1176−
1177−data SomeRootClear = forall k. SomeRootClear (IORef (DMap k Identity))
1178−
1179−data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1180−
1181−data DelayedMerge x = forall k. DelayedMerge (MergeSubscribed x k)
1182−
1183−debugFinalize :: Bool
1184−debugFinalize = False
1185−
1186−mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
1187−mkWeakPtrWithDebug x debugNote = do
1188− x' <- evaluate x
1189− mkWeakPtr x' $
1190− if debugFinalize
1191− then Just $ putStrLn $ "finalizing: " ++ debugNote
1192− else Nothing
1193−
1194−type WeakList a = [Weak a]
1195−
1196−{-# INLINE withIncreasedDepth #-}
1197−#ifdef DEBUG
1198−withIncreasedDepth :: CanTrace x m => m a -> m a
1199−withIncreasedDepth a = do
1200− spiderEnv <- askSpiderEnv
1201− liftIO $ modifyIORef' (_spiderEnv_depth spiderEnv) succ
1202− result <- a
1203− liftIO $ modifyIORef' (_spiderEnv_depth spiderEnv) pred
1204− return result
1205−#else
1206−withIncreasedDepth :: m a -> m a
1207−withIncreasedDepth = id
1208−#endif
1209−
1210−type CanTrace x m = (HasSpiderEnv x m, MonadIO m)
1211−
1212−{-# INLINE tracePropagate #-}
1213−tracePropagate :: (CanTrace x m) => String -> m ()
1214−tracePropagate = traceWhen debugPropagate
1215−
1216−{-# INLINE traceInvalidate #-}
1217−traceInvalidate :: String -> IO ()
1218−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1219−
1220−{-# INLINE traceWhen #-}
1221−traceWhen :: (CanTrace x m) => Bool -> String -> m ()
1222−traceWhen b message = traceMWhen b $ return message
1223−
1224−{-# INLINE traceMWhen #-}
1225−traceMWhen :: (CanTrace x m) => Bool -> m String -> m ()
1226−traceMWhen b getMessage = when b $ do
1227− message <- getMessage
1228−#ifdef DEBUG
1229− spiderEnv <- askSpiderEnv
1230− d <- liftIO $ readIORef $ _spiderEnv_depth spiderEnv
1231−#else
1232− let d = 0
1233−#endif
1234− liftIO $ putStrLn $ replicate d ' ' <> message
1235−
1236−whoCreatedIORef :: IORef a -> IO [String]
1237−whoCreatedIORef (IORef a) = whoCreated $! a
1238−
1239−#ifdef DEBUG_CYCLES
1240−groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1241−groupByHead = \case
1242− [] -> []
1243− (x :| xs) : t -> case groupByHead t of
1244− [] -> [(x, xs :| [])]
1245− l@((y, yss) : t')
1246− | x == y -> (x, xs `NonEmpty.cons` yss) : t'
1247− | otherwise -> (x, xs :| []) : l
1248−
1249−listsToForest :: Eq a => [[a]] -> Forest a
1250−listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
1251−#endif
1252−
1253−{-# INLINE propagateSubscriberHold #-}
1254−propagateSubscriberHold :: R.Patch p => Hold x p a -> p a -> EventM x ()
1255−propagateSubscriberHold h a = do
1256− {-# SCC "trace" #-} traceMWhen debugPropagate $ liftIO $ do
1257− invalidators <- liftIO $ readIORef $ holdInvalidators h
1258− return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1259− v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1260− case {-# SCC "apply" #-} R.apply a v of
1261− Nothing -> return ()
1262− Just v' -> do
1263− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1264− vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1265− iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1266− defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1267−
1268−data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x a) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1269−
1270−{-# SPECIALIZE readBehaviorUntracked :: Behavior x a -> BehaviorM x a #-}
1271−{-# SPECIALIZE readBehaviorUntracked :: Behavior x a -> EventM x a #-}
1272−readBehaviorUntracked :: Defer (SomeHoldInit x) m => Behavior x a -> m a
1273−readBehaviorUntracked b = do
1274− holdInits <- getDeferralQueue
1275− liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
1276−
1277−runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1278−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1279−
1280−askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1281−askInvalidator = do
1282− (!m, _) <- BehaviorM ask
1283− case m of
1284− Nothing -> return Nothing
1285− Just (!wi, _) -> return $ Just wi
1286−
1287−askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1288−askParentsRef = do
1289− (!m, _) <- BehaviorM ask
1290− case m of
1291− Nothing -> return Nothing
1292− Just (_, !p) -> return $ Just p
1293−
1294−askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1295−askBehaviorHoldInits = do
1296− (_, !his) <- BehaviorM ask
1297− return his
1298−
1299−readBehaviorTracked :: Behavior x a -> BehaviorM x a
1300−readBehaviorTracked b = case b of
1301− BehaviorHold h -> readHoldTracked h
1302− BehaviorHoldIdentity h -> readHoldTracked h
1303− BehaviorConst a -> return a
1304− BehaviorPull p -> do
1305− val <- liftIO $ readIORef $ pullValue p
1306− case val of
1307− Just subscribed -> do
1308− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
1309− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
1310− liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
1311− return $ pullSubscribedValue subscribed
1312− Nothing -> do
1313− i <- liftIO $ newInvalidatorPull p
1314− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
1315− parentsRef <- liftIO $ newIORef []
1316− holdInits <- askBehaviorHoldInits
1317− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
1318− invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
1319− parents <- liftIO $ readIORef parentsRef
1320− let subscribed = PullSubscribed
1321− { pullSubscribedValue = a
1322− , pullSubscribedInvalidators = invsRef
1323− , pullSubscribedOwnInvalidator = i
1324− , pullSubscribedParents = parents
1325− }
1326− liftIO $ writeIORef (pullValue p) $ Just subscribed
1327− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
1328− return a
1329− BehaviorDyn d -> readHoldTracked =<< getDynHold d
1330− BehaviorDynIdentity d -> readHoldTracked =<< getDynHold d
1331−
1332−{-# INLINE readHoldTracked #-}
1333−readHoldTracked :: Hold x p a -> BehaviorM x a
1334−readHoldTracked h = do
1335− result <- liftIO $ readIORef $ holdValue h
1336− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
1337− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
1338− return result
1339−
1340−{-# INLINE getDynHold #-}
1341−getDynHold :: (Defer (SomeHoldInit x) m, R.Patch p) => Dyn x p a -> m (Hold x p a)
1342−getDynHold d = do
1343− mh <- liftIO $ readIORef $ unDyn d
1344− case mh of
1345− Right h -> return h
1346− Left (readV0, v') -> do
1347− holdInits <- getDeferralQueue
1348− v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1349− h <- hold v0 v'
1350− liftIO $ writeIORef (unDyn d) $ Right h
1351− return h
1352−
1353−-- Always refers to 0
1354−{-# NOINLINE zeroRef #-}
1355−zeroRef :: IORef Height
1356−zeroRef = unsafePerformIO $ newIORef zeroHeight
1357−
1358−type CanSubscribe x m =
1359− ( HasSpiderEnv x m
1360− , HasCurrentHeight x m
1361− , Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m -- The things we need to lazily initialize state
1362− , Defer SomeClear m -- Wiping out event firings
1363− , Defer (SomeAssignment x) m -- Updating state
1364− , Defer (SomeResetCoincidence x) m
1365− , m ~ EventM x
1366− )
1367−
1368−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a), RootSubscribed x a, Maybe a)
1369−getRootSubscribed k r sub = do
1370− mSubscribed <- readIORef $ rootSubscribed r
1371− let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1372− case DMap.lookup k mSubscribed of
1373− Just subscribed -> {-# SCC "hitRoot" #-} do
1374− sln <- subscribeRootSubscribed subscribed sub
1375− occ <- getOcc
1376− return (sln, subscribed, occ)
1377− Nothing -> {-# SCC "missRoot" #-} do
1378− weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1379− let !cached = rootSubscribed r
1380− uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1381− (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1382− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1383− uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1384− writeIORef uninitRef $! uninit
1385− let subscribed = RootSubscribed
1386− { rootSubscribedKey = k
1387− , rootSubscribedCachedSubscribed = cached
1388− , rootSubscribedOccurrence = getOcc
1389− , rootSubscribedSubscribers = subs
1390− , rootSubscribedUninit = uninit
1391− , rootSubscribedWeakSelf = weakSelf
1392−#ifdef DEBUG_NODEIDS
1393− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1394−#endif
1395− }
1396− writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "RootSubscribed"
1397− 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
1398− occ <- getOcc
1399− return (sln, subscribed, occ)
1400−
1401−{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1402−cleanupRootSubscribed :: RootSubscribed x a -> IO ()
1403−cleanupRootSubscribed self@(RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached }) = do
1404− rootSubscribedUninit self
1405− modifyIORef' cached $ DMap.delete k
1406−
1407−{-# INLINE subscribeRootSubscribed #-}
1408−subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1409−subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1410−
1411−-- When getPushSubscribed returns, the PushSubscribed returned will have a fully filled-in
1412−{-# SPECIALIZE getPushSubscribed :: Push x a b -> Subscriber x b -> EventM x (WeakBagTicket (Subscriber x b), PushSubscribed x a b, Maybe b) #-}
1413−getPushSubscribed :: CanSubscribe x m => Push x a b -> Subscriber x b -> m (WeakBagTicket (Subscriber x b), PushSubscribed x a b, Maybe b)
1414−getPushSubscribed p sub = do
1415− mSubscribed <- liftIO $ readIORef $ pushSubscribed p
1416− case mSubscribed of
1417− Just subscribed -> {-# SCC "hitPush" #-} liftIO $ do
1418− sln <- subscribePushSubscribed subscribed sub
1419− occ <- readIORef $ pushSubscribedOccurrence subscribed
1420− return (sln, subscribed, occ)
1421− Nothing -> {-# SCC "missPush" #-} do -- Not yet subscribed
1422− subscribedRef <- liftIO $ newIORef $ error "getPushSubscribed: subscribed not yet intialized"
1423− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1424− s <- liftIO $ newSubscriberPush (pushCompute p) subscribedUnsafe
1425− (subscription@(EventSubscription _ subd), parentOcc) <- subscribeAndRead (pushParent p) s
1426− occ <- runComputeM $ join <$> mapM (pushCompute p) parentOcc
1427− occRef <- liftIO $ newIORef occ
1428− when (isJust occ) $ scheduleClear occRef
1429− weakSelf <- liftIO $ newIORef $ error "getPushSubscribed: weakSelf not initialized"
1430− let !cached = pushSubscribed p
1431− (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupPushSubscribed
1432− let subscribed = PushSubscribed
1433− { pushSubscribedCachedSubscribed = cached
1434− , pushSubscribedOccurrence = occRef
1435− , pushSubscribedHeight = eventSubscribedHeightRef subd -- Since pushes have the same height as their parents, share the ref
1436− , pushSubscribedSubscribers = subs
1437− , pushSubscribedSelf = s
1438− , pushSubscribedWeakSelf = weakSelf
1439− , pushSubscribedParent = subscription
1440−#ifdef DEBUG_NODEIDS
1441− , pushSubscribedNodeId = unsafeNodeId p
1442−#endif
1443− }
1444− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "PushSubscribed"
1445− liftIO $ writeIORef subscribedRef $! subscribed
1446− liftIO $ writeIORef (pushSubscribed p) $ Just subscribed
1447− return (sln, subscribed, occ)
1448−
1449−cleanupPushSubscribed :: PushSubscribed x a b -> IO ()
1450−cleanupPushSubscribed self = do
1451− unsubscribe $ pushSubscribedParent self
1452− writeIORef (pushSubscribedCachedSubscribed self) $ Nothing
1453−
1454−{-# INLINE subscribePushSubscribed #-}
1455−subscribePushSubscribed :: PushSubscribed x a b -> Subscriber x b -> IO (WeakBagTicket (Subscriber x b))
1456−subscribePushSubscribed subscribed sub = WeakBag.insert sub (pushSubscribedSubscribers subscribed) (pushSubscribedWeakSelf subscribed) cleanupPushSubscribed
1457−
1458−{-# SPECIALIZE getMergeSubscribed :: GCompare k => Merge x k -> Subscriber x (DMap k Identity) -> EventM x (WeakBagTicket (Subscriber x (DMap k Identity)), MergeSubscribed x k, Maybe (DMap k Identity)) #-}
1459−getMergeSubscribed :: forall x k m. (CanSubscribe x m, GCompare k) => Merge x k -> Subscriber x (DMap k Identity) -> m (WeakBagTicket (Subscriber x (DMap k Identity)), MergeSubscribed x k, Maybe (DMap k Identity))
1460−getMergeSubscribed m sub = do
1461− mSubscribed <- liftIO $ readIORef $ mergeSubscribed m
1462− case mSubscribed of
1463− Just subscribed -> {-# SCC "hitMerge" #-} liftIO $ do
1464− sln <- subscribeMergeSubscribed subscribed sub
1465− occ <- readIORef $ mergeSubscribedOccurrence subscribed
1466− return (sln, subscribed, occ)
1467− Nothing -> {-# SCC "missMerge" #-} do
1468− subscribedRef <- liftIO $ newIORef $ error "getMergeSubscribed: subscribedRef not yet initialized"
1469− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1470− initialParents <- readBehaviorUntracked $ current $ mergeParents m
1471− subscribers :: [(Maybe (DSum k Identity), Height, DSum k (MergeSubscribedParent x k))] <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1472− s <- liftIO $ newSubscriberMerge k subscribedUnsafe
1473− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1474− height <- liftIO $ getEventSubscribedHeight parentSubd
1475− return $ (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription s)
1476− let dm = DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1477− heights = fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1478− myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1479− myHeight = if invalidHeight `elem` heights
1480− then invalidHeight
1481− else succHeight $ heightBagMax myHeightBag
1482− currentHeight <- getCurrentHeight
1483− let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1484− then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1485− else (Nothing, dm)
1486− unless (DMap.null accum) $ do
1487− scheduleMerge myHeight subscribedUnsafe
1488− occRef <- liftIO $ newIORef occ
1489− when (isJust occ) $ scheduleClear occRef
1490− accumRef <- liftIO $ newIORef accum
1491− heightRef <- liftIO $ newIORef myHeight
1492− heightMapRef <- liftIO $ newIORef myHeightBag
1493− weakSelf <- liftIO $ newIORef $ error "getMergeSubscribed: weakSelf not yet initialized"
1494− (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupMergeSubscribed
1495− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1496− parentsRef <- liftIO $ newIORef $ DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1497− let !subscribed = MergeSubscribed
1498− { mergeSubscribedCachedSubscribed = mergeSubscribed m
1499− , mergeSubscribedOccurrence = occRef
1500− , mergeSubscribedAccum = accumRef
1501− , mergeSubscribedHeight = heightRef
1502− , mergeSubscribedHeightBag = heightMapRef
1503− , mergeSubscribedSubscribers = subs
1504− , mergeSubscribedChange = changeSubdRef
1505− , mergeSubscribedParents = parentsRef
1506− , mergeSubscribedWeakSelf = weakSelf
1507−#ifdef DEBUG_NODEIDS
1508− , mergeSubscribedNodeId = unsafeNodeId m
1509−#endif
1510− }
1511− defer $ SomeMergeInit subscribed $ updated $ mergeParents m
1512− liftIO $ writeIORef subscribedRef $! subscribed
1513− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "MergeSubscribed"
1514− liftIO $ writeIORef (mergeSubscribed m) $ Just subscribed
1515− return (sln, subscribed, occ)
1516−
1517−cleanupMergeSubscribed :: MergeSubscribed x k -> IO ()
1518−cleanupMergeSubscribed subscribed = do
1519− parents <- readIORef $ mergeSubscribedParents subscribed
1520− forM_ (DMap.toList parents) $ \(_ :=> msp) -> unsubscribe $ mergeSubscribedParentSubscription msp
1521− -- Not necessary, because this whole MergeSubscribed is dead: writeIORef (mergeSubscribedParents subscribed) DMap.empty
1522− writeIORef (mergeSubscribedCachedSubscribed subscribed) $ Nothing -- Get rid of the cached subscribed
1523−
1524−{-# INLINE subscribeMergeSubscribed #-}
1525−subscribeMergeSubscribed :: MergeSubscribed x k -> Subscriber x (DMap k Identity) -> IO (WeakBagTicket (Subscriber x (DMap k Identity)))
1526−subscribeMergeSubscribed subscribed sub = WeakBag.insert sub (mergeSubscribedSubscribers subscribed) (mergeSubscribedWeakSelf subscribed) cleanupMergeSubscribed
1527−
1528−{-# SPECIALIZE getFanSubscribed :: GCompare k => k a -> Fan x k -> Subscriber x a -> EventM x (WeakBagTicket (Subscriber x a), FanSubscribed x k, Maybe a) #-}
1529−getFanSubscribed :: (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, HasCurrentHeight x m, Defer (SomeResetCoincidence x) m, HasSpiderEnv x m, m ~ EventM x, GCompare k) => k a -> Fan x k -> Subscriber x a -> m (WeakBagTicket (Subscriber x a), FanSubscribed x k, Maybe a)
1530−getFanSubscribed k f sub = do
1531− mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1532− case mSubscribed of
1533− Just subscribed -> {-# SCC "hitFan" #-} liftIO $ do
1534− sln <- subscribeFanSubscribed k subscribed sub
1535− occ <- readIORef $ fanSubscribedOccurrence subscribed
1536− return (sln, subscribed, coerce $ DMap.lookup k =<< occ)
1537− Nothing -> {-# SCC "missFan" #-} do
1538− subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1539− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1540− s <- liftIO $ newSubscriberFan subscribedUnsafe
1541− (subscription, parentOcc) <- subscribeAndRead (fanParent f) s
1542− weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1543− (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1544− subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1545− occRef <- liftIO $ newIORef parentOcc
1546− when (isJust parentOcc) $ scheduleClear occRef
1547− let subscribed = FanSubscribed
1548− { fanSubscribedCachedSubscribed = fanSubscribed f
1549− , fanSubscribedOccurrence = occRef
1550− , fanSubscribedParent = subscription
1551− , fanSubscribedSubscribers = subscribersRef
1552−#ifdef DEBUG_NODEIDS
1553− , fanSubscribedNodeId = unsafeNodeId f
1554−#endif
1555− }
1556− let !self = (k, subscribed)
1557− liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1558− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1559− liftIO $ writeIORef subscribedRef $! subscribed
1560− liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1561− return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1562−
1563−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1564−cleanupFanSubscribed (k, subscribed) = do
1565− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1566− let reducedSubscribers = DMap.delete k subscribers
1567− if DMap.null reducedSubscribers
1568− then do
1569− unsubscribe $ fanSubscribedParent subscribed
1570− -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1571− writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1572− else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1573−
1574−{-# INLINE subscribeFanSubscribed #-}
1575−subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1576−subscribeFanSubscribed k subscribed sub = do
1577− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1578− case DMap.lookup k subscribers of
1579− Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1580− let !self = (k, subscribed)
1581− weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1582− (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1583− 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
1584− return sln
1585− Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1586−
1587−{-# SPECIALIZE getSwitchSubscribed :: Switch x a -> Subscriber x a -> EventM x (WeakBagTicket (Subscriber x a), SwitchSubscribed x a, Maybe a) #-}
1588−getSwitchSubscribed :: (Defer (SomeHoldInit x) m, Defer (SomeAssignment x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, Defer (SomeResetCoincidence x) m, HasCurrentHeight x m, HasSpiderEnv x m, m ~ EventM x) => Switch x a -> Subscriber x a -> m (WeakBagTicket (Subscriber x a), SwitchSubscribed x a, Maybe a)
1589−getSwitchSubscribed s sub = do
1590− mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1591− case mSubscribed of
1592− Just subscribed -> {-# SCC "hitSwitch" #-} liftIO $ do
1593− sln <- subscribeSwitchSubscribed subscribed sub
1594− occ <- readIORef $ switchSubscribedOccurrence subscribed
1595− return (sln, subscribed, occ)
1596− Nothing -> {-# SCC "missSwitch" #-} do
1597− subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1598− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1599− i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1600− mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1601− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1602− wiRef <- liftIO $ newIORef wi
1603− parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1604− holdInits <- getDeferralQueue
1605− e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1606− (subscription@(EventSubscription _ subd), parentOcc) <- subscribeAndRead e mySub
1607− heightRef <- liftIO $ newIORef =<< getEventSubscribedHeight subd
1608− subscriptionRef <- liftIO $ newIORef subscription
1609− occRef <- liftIO $ newIORef parentOcc
1610− when (isJust parentOcc) $ scheduleClear occRef
1611− weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1612− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1613− let !subscribed = SwitchSubscribed
1614− { switchSubscribedCachedSubscribed = switchSubscribed s
1615− , switchSubscribedOccurrence = occRef
1616− , switchSubscribedHeight = heightRef
1617− , switchSubscribedSubscribers = subs
1618− , switchSubscribedOwnInvalidator = i
1619− , switchSubscribedOwnWeakInvalidator = wiRef
1620− , switchSubscribedBehaviorParents = parentsRef
1621− , switchSubscribedParent = switchParent s
1622− , switchSubscribedCurrentParent = subscriptionRef
1623− , switchSubscribedWeakSelf = weakSelf
1624−#ifdef DEBUG_NODEIDS
1625− , switchSubscribedNodeId = unsafeNodeId s
1626−#endif
1627− }
1628− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1629− liftIO $ writeIORef subscribedRef $! subscribed
1630− liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1631− return (slnForSub, subscribed, parentOcc)
1632−
1633−cleanupSwitchSubscribed :: SwitchSubscribed x a -> IO ()
1634−cleanupSwitchSubscribed subscribed = do
1635− unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1636− finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1637− writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1638−
1639−{-# INLINE subscribeSwitchSubscribed #-}
1640−subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1641−subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1642−
1643−{-# SPECIALIZE getCoincidenceSubscribed :: Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket (Subscriber x a), CoincidenceSubscribed x a, Maybe a) #-}
1644−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, HasSpiderEnv x m, m ~ EventM x) => Coincidence x a -> Subscriber x a -> m (WeakBagTicket (Subscriber x a), CoincidenceSubscribed x a, Maybe a)
1645−getCoincidenceSubscribed c sub = do
1646− mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1647− case mSubscribed of
1648− Just subscribed -> {-# SCC "hitCoincidence" #-} liftIO $ do
1649− sln <- subscribeCoincidenceSubscribed subscribed sub
1650− occ <- readIORef $ coincidenceSubscribedOccurrence subscribed
1651− return (sln, subscribed, occ)
1652− Nothing -> {-# SCC "missCoincidence" #-} do
1653− subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1654− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1655− subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1656− (outerSubscription@(EventSubscription _ outerSubd), outerOcc) <- subscribeAndRead (coincidenceParent c) subOuter
1657− outerHeight <- liftIO $ getEventSubscribedHeight outerSubd
1658− (occ, height, mInnerSubd) <- case outerOcc of
1659− Nothing -> return (Nothing, outerHeight, Nothing)
1660− Just o -> do
1661− (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1662− return (occ, height, Just innerSubd)
1663− occRef <- liftIO $ newIORef occ
1664− when (isJust occ) $ scheduleClear occRef
1665− heightRef <- liftIO $ newIORef height
1666− innerSubdRef <- liftIO $ newIORef mInnerSubd
1667− scheduleClear innerSubdRef
1668− weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1669− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1670− let subscribed = CoincidenceSubscribed
1671− { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1672− , coincidenceSubscribedOccurrence = occRef
1673− , coincidenceSubscribedHeight = heightRef
1674− , coincidenceSubscribedSubscribers = subs
1675− , coincidenceSubscribedOuter = subOuter
1676− , coincidenceSubscribedOuterParent = outerSubscription
1677− , coincidenceSubscribedInnerParent = innerSubdRef
1678− , coincidenceSubscribedWeakSelf = weakSelf
1679−#ifdef DEBUG_NODEIDS
1680− , coincidenceSubscribedNodeId = unsafeNodeId c
1681−#endif
1682− }
1683− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1684− liftIO $ writeIORef subscribedRef $! subscribed
1685− liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1686− return (slnForSub, subscribed, occ)
1687−
1688−cleanupCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO ()
1689−cleanupCoincidenceSubscribed subscribed = do
1690− unsubscribe $ coincidenceSubscribedOuterParent subscribed
1691− writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1692−
1693−{-# INLINE subscribeCoincidenceSubscribed #-}
1694−subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1695−subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1696−
1697−{-# INLINE merge #-}
1698−merge :: GCompare k => Dynamic x R.PatchDMap (DMap k (Event x)) -> Event x (DMap k Identity)
1699−merge m = eventMerge $ Merge
1700− { mergeParents = m
1701− , mergeSubscribed = unsafeNewIORef m Nothing
1702− }
1703−
1704−newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
1705−
1706−fan :: GCompare k => Event x (DMap k Identity) -> EventSelector x k
1707−fan e =
1708− let f = Fan
1709− { fanParent = e
1710− , fanSubscribed = unsafeNewIORef e Nothing
1711− }
1712− in EventSelector $ \k -> eventFan k f
1713−
1714−runHoldInits :: IORef [SomeHoldInit x] -> IORef [SomeMergeInit x] -> EventM x ()
1715−runHoldInits holdInitRef mergeInitRef = do
1716− holdInits <- liftIO $ readIORef holdInitRef
1717− mergeInits <- liftIO $ readIORef mergeInitRef
1718− unless (null holdInits && null mergeInits) $ do
1719− liftIO $ writeIORef holdInitRef []
1720− liftIO $ writeIORef mergeInitRef []
1721− mapM_ initHold holdInits
1722− mapM_ initMerge mergeInits
1723− runHoldInits holdInitRef mergeInitRef
1724−
1725−initHold :: SomeHoldInit x -> EventM x ()
1726−initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
1727−
1728−initMerge :: SomeMergeInit x -> EventM x ()
1729−initMerge (SomeMergeInit subscribed changed) = do
1730− changeSub <- liftIO $ newSubscriberMergeChange subscribed
1731− (EventSubscription _ changeSubd, change) <- subscribeAndRead changed changeSub
1732− forM_ change $ \c -> defer $ SomeMergeUpdate c subscribed
1733− liftIO $ writeIORef (mergeSubscribedChange subscribed) (changeSub, changeSubd)
1734−
1735−-- | Run an event action outside of a frame
1736−runFrame :: forall x a. EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
1737−runFrame a = SpiderHost $ ask >>= \spiderEnv -> lift $ do
1738− -- Clear out pending unsubscriptions; these will need to happen eventually anyway, and might cause us a lot of extra work during the frame, so get rid of them now
1739− pendingCleanups <- atomicModifyIORef (_spiderEnv_cleanups spiderEnv) $ \x -> ([], x)
1740− {-# SCC "cleanups" #-} sequence_ pendingCleanups
1741− toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1742− holdInitRef <- newIORef []
1743− mergeUpdateRef <- newIORef []
1744− mergeInitRef <- newIORef []
1745− heightRef <- newIORef zeroHeight
1746− toClearRef <- newIORef []
1747− toClearRootRef <- newIORef []
1748− coincidenceInfosRef <- newIORef []
1749− delayedRef <- liftIO $ newIORef IntMap.empty
1750− let env = EventEnv spiderEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef
1751− let go = do
1752− result <- a
1753− runHoldInits holdInitRef mergeInitRef -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
1754− return result
1755− result <- runEventM go env
1756− toClear <- readIORef toClearRef
1757− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
1758− toClearRoot <- readIORef toClearRootRef
1759− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
1760− toAssign <- readIORef toAssignRef
1761− toReconnectRef <- newIORef []
1762− coincidenceInfos <- readIORef coincidenceInfosRef
1763− forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
1764− writeIORef vRef v
1765− when debugInvalidate $ putStrLn $ "Invalidating Hold"
1766− writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
1767− mergeUpdates <- readIORef mergeUpdateRef
1768− writeIORef mergeUpdateRef []
1769− let updateMerge :: SomeMergeUpdate x -> IO [SomeEventSubscription x]
1770− updateMerge (SomeMergeUpdate (R.PatchDMap p :: R.PatchDMap (DMap k (Event x))) m) = do
1771− oldParents <- readIORef $ mergeSubscribedParents m
1772− let f (subscriptionsToKill, ps) (k :=> Compose me) = do
1773− (mOldSubd, newPs) <- case me of
1774− Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1775− Just e -> do
1776− s <- liftIO $ newSubscriberMerge k m
1777− subscription@(EventSubscription _ subd) <- subscribe e s
1778− newParentHeight <- liftIO $ getEventSubscribedHeight subd
1779− let newParent = MergeSubscribedParent subscription s
1780− liftIO $ addMergeHeight newParentHeight m
1781− return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1782− forM_ mOldSubd $ \oldSubd -> do
1783− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription oldSubd
1784− liftIO $ removeMergeHeight oldHeight m
1785− return (maybeToList (SomeEventSubscription . mergeSubscribedParentSubscription <$> mOldSubd) ++ subscriptionsToKill, newPs)
1786− (subscriptionsToKill, newParents) <- flip runEventM env $ 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
1787− writeIORef (mergeSubscribedParents m) $! newParents
1788− return subscriptionsToKill
1789− when debugPropagate $ putStrLn "Updating merges"
1790− mergeSubscriptionsToKill <- concat <$> mapM updateMerge mergeUpdates
1791− when debugPropagate $ putStrLn "Updating merges done"
1792− toReconnect <- readIORef toReconnectRef
1793− switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1794− oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
1795− wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1796− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
1797− finalize wi
1798− i <- evaluate $ switchSubscribedOwnInvalidator subscribed
1799− wi' <- mkWeakPtrWithDebug i "wi'"
1800− writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
1801− writeIORef (switchSubscribedBehaviorParents subscribed) []
1802− writeIORef holdInitRef [] --TODO: Should we reuse this?
1803− e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) holdInitRef
1804− runEventM (runHoldInits holdInitRef mergeInitRef) 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
1805− --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1806− sub <- newSubscriberSwitch subscribed
1807− subscription <- runReaderT (unSpiderHost (runFrame ({-# SCC "subscribeSwitch" #-} subscribe e sub))) spiderEnv --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
1808− {-
1809− stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1810− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1811− EventRoot _ -> "EventRoot"
1812− EventNever -> "EventNever"
1813− _ -> "something else"
1814− -}
1815− writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
1816− return $ SomeEventSubscription oldSubscription
1817− forM_ mergeSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1818− forM_ switchSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1819− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1820− EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
1821− parentHeight <- getEventSubscribedHeight subd'
1822− myHeight <- readIORef $ switchSubscribedHeight subscribed
1823− when (parentHeight /= myHeight) $ do
1824− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1825− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
1826− forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> do
1827− invalidateMergeHeight m --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
1828− forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
1829− unsubscribe subscription
1830− mapM_ invalidateCoincidenceHeight mcs
1831− forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
1832− forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> revalidateMergeHeight m
1833− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1834− height <- calculateSwitchHeight subscribed
1835− updateSwitchHeight height subscribed
1836− return result
1837−
1838−newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
1839−
1840−{-# INLINE zeroHeight #-}
1841−zeroHeight :: Height
1842−zeroHeight = Height 0
1843−
1844−{-# INLINE invalidHeight #-}
1845−invalidHeight :: Height
1846−invalidHeight = Height (-1000)
1847−
1848−#ifdef DEBUG_CYCLES
1849−-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
1850−{-# INLINE invalidHeightBeingTraversed #-}
1851−invalidHeightBeingTraversed :: Height
1852−invalidHeightBeingTraversed = Height (-1001)
1853−#endif
1854−
1855−{-# INLINE succHeight #-}
1856−succHeight :: Height -> Height
1857−succHeight h@(Height a) =
1858− if h == invalidHeight
1859− then invalidHeight
1860− else Height $ succ a
1861−
1862−removeMergeHeight :: Height -> MergeSubscribed x k -> IO ()
1863−removeMergeHeight oldParentHeight subscribed = do
1864− when debugInvalidateHeight $ putStrLn $ "removeMergeHeight: " <> show oldParentHeight <> " Merge" <> showNodeId subscribed
1865− oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1866− let newHeights = heightBagRemove oldParentHeight oldHeights
1867− writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1868−
1869−invalidateMergeHeight :: MergeSubscribed x k -> IO ()
1870−invalidateMergeHeight subscribed = do
1871− oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1872− -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
1873− when (oldHeight /= invalidHeight) $ do
1874− writeIORef (mergeSubscribedHeight subscribed) $! invalidHeight
1875− WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1876−
1877−addMergeHeight :: Height -> MergeSubscribed x k -> IO ()
1878−addMergeHeight newParentHeight subscribed = do
1879− when debugInvalidateHeight $ putStrLn $ "addMergeHeight: " <> show newParentHeight <> " Merge" <> showNodeId subscribed
1880− oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1881− let newHeights = heightBagAdd newParentHeight oldHeights
1882− writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1883−
1884−revalidateMergeHeight :: MergeSubscribed x k -> IO ()
1885−revalidateMergeHeight subscribed = do
1886− currentHeight <- readIORef $ mergeSubscribedHeight subscribed
1887− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1888− heights <- readIORef $ mergeSubscribedHeightBag subscribed
1889− parents <- readIORef $ mergeSubscribedParents subscribed
1890− -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1891− case heightBagSize heights `compare` DMap.size parents of
1892− LT -> return ()
1893− EQ -> do
1894− let height = succHeight $ heightBagMax heights
1895− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1896− writeIORef (mergeSubscribedHeight subscribed) $! height
1897− WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1898− GT -> error $ "revalidateMergeHeight: more heights than parents for Merge" <> showNodeId subscribed
1899−
1900−invalidateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1901−invalidateCoincidenceHeight subscribed = do
1902− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1903− when (oldHeight /= invalidHeight) $ do
1904− writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
1905− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1906−
1907−updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
1908−updateSwitchHeight new subscribed = do
1909− oldHeight <- readIORef $ switchSubscribedHeight subscribed
1910− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1911− when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1912− writeIORef (switchSubscribedHeight subscribed) $! new
1913− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1914−
1915−recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1916−recalculateCoincidenceHeight subscribed = do
1917− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1918− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1919− height <- calculateCoincidenceHeight subscribed
1920− when (height /= invalidHeight) $ do
1921− writeIORef (coincidenceSubscribedHeight subscribed) $! height
1922− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1923−
1924−calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
1925−calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
1926−
1927−calculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO Height
1928−calculateCoincidenceHeight subscribed = do
1929− outerHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1930− innerHeight <- maybe (return zeroHeight) getEventSubscribedHeight =<< readIORef (coincidenceSubscribedInnerParent subscribed)
1931− return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
1932−
1933−data SomeSwitchSubscribed x = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed x a)
1934−
1935−invalidate :: IORef [SomeSwitchSubscribed x] -> WeakList (Invalidator x) -> IO (WeakList (Invalidator x))
1936−invalidate toReconnectRef wis = do
1937− forM_ wis $ \wi -> do
1938− mi <- deRefWeak wi
1939− case mi of
1940− Nothing -> do
1941− traceInvalidate "invalidate Dead"
1942− return () --TODO: Should we clean this up here?
1943− Just i -> do
1944− finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
1945− case i of
1946− InvalidatorPull p -> do
1947− traceInvalidate $ "invalidate: Pull" <> showNodeId p
1948− mVal <- readIORef $ pullValue p
1949− forM_ mVal $ \val -> do
1950− writeIORef (pullValue p) Nothing
1951− writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
1952− InvalidatorSwitch subscribed -> do
1953− traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
1954− modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
1955− 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
1956−
1957−--------------------------------------------------------------------------------
1958−-- Reflex integration
1959−--------------------------------------------------------------------------------
1960−
1961−-- | The default, global Spider environment
1962−type Spider = SpiderEnv Global
1963−
1964−-- | Designates the default, global Spider timeline
1965−data Global
1966−
1967−{-# NOINLINE globalSpiderEnv #-}
1968−globalSpiderEnv :: SpiderEnv Global
1969−globalSpiderEnv = unsafePerformIO unsafeNewSpiderEnv
1970−
1971−-- | Stores all global data relevant to a particular Spider timeline; only one
1972−-- value should exist for each type @x@
1973−data SpiderEnv x = SpiderEnv
1974− { _spiderEnv_toUnsubscribe :: !(IORef [SomeEventSubscription x])
1975− , _spiderEnv_lock :: !(MVar ())
1976− , _spiderEnv_cleanups :: !(IORef [IO ()])
1977−#ifdef DEBUG
1978− , _spiderEnv_depth :: !(IORef Int)
1979−#endif
1980− }
1981−type role SpiderEnv nominal
1982−
1983−instance GEq SpiderEnv where
1984− a `geq` b = if _spiderEnv_lock a == _spiderEnv_lock b
1985− then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderEnv can't have two different 'x' arguments
1986− else Nothing
1987−
1988−unsafeNewSpiderEnv :: forall x. IO (SpiderEnv x)
1989−unsafeNewSpiderEnv = do
1990− toUnsubscribe <- newIORef []
1991− lock <- newMVar ()
1992− cleanups <- newIORef []
1993−#ifdef DEBUG
1994− depthRef <- newIORef 0
1995−#endif
1996− return $ SpiderEnv
1997− { _spiderEnv_toUnsubscribe = toUnsubscribe
1998− , _spiderEnv_lock = lock
1999− , _spiderEnv_cleanups = cleanups
2000−#ifdef DEBUG
2001− , _spiderEnv_depth = depthRef
2002−#endif
2003− }
2004−
2005−-- | Create a new SpiderEnv
2006−newSpiderEnv :: IO (Some SpiderEnv)
2007−newSpiderEnv = Some.This <$> unsafeNewSpiderEnv
2008−
2009−newtype SpiderPullM x a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2010−
2011−newtype SpiderPushM x a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2012−
2013−instance R.Reflex (SpiderEnv x) where
2014− newtype Behavior (SpiderEnv x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2015− newtype Event (SpiderEnv x) a = SpiderEvent { unSpiderEvent :: Event x a }
2016− newtype Dynamic (SpiderEnv x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x Identity a } deriving (Functor, Applicative, Monad)
2017− newtype Incremental (SpiderEnv x) p a = SpiderIncremental { unSpiderIncremental :: Dynamic x p a }
2018− type PullM (SpiderEnv x) = SpiderPullM x
2019− type PushM (SpiderEnv x) = SpiderPushM x
2020− {-# INLINABLE never #-}
2021− never = SpiderEvent eventNever
2022− {-# INLINABLE constant #-}
2023− constant = SpiderBehavior . BehaviorConst
2024− {-# INLINABLE push #-}
2025− push f = SpiderEvent . push (coerce f) . unSpiderEvent
2026− {-# INLINABLE pull #-}
2027− pull = SpiderBehavior . pull . coerce
2028− {-# INLINABLE merge #-}
2029− merge = SpiderEvent . merge . DynamicConst . (coerce :: DMap k (R.Event (SpiderEnv x)) -> DMap k (Event x))
2030− {-# INLINABLE fan #-}
2031− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2032− {-# INLINABLE switch #-}
2033− switch = SpiderEvent . switch . (unsafeCoerce :: Behavior x (R.Event (SpiderEnv x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2034− {-# INLINABLE coincidence #-}
2035− coincidence = SpiderEvent . coincidence . (coerce :: Event x (R.Event (SpiderEnv x) a) -> Event x (Event x a)) . unSpiderEvent
2036− {-# INLINABLE current #-}
2037− current = SpiderBehavior . current . unSpiderDynamic
2038− {-# INLINABLE updated #-}
2039− updated = SpiderEvent . fmap runIdentity . updated . unSpiderDynamic
2040− {-# INLINABLE unsafeBuildDynamic #-}
2041− unsafeBuildDynamic readV0 v' = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (coerce readV0) $ coerce $ unSpiderEvent v'
2042− {-# INLINABLE unsafeBuildIncremental #-}
2043− unsafeBuildIncremental readV0 dv = SpiderIncremental $ DynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
2044− {-# INLINABLE mergeIncremental #-}
2045− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x R.PatchDMap (DMap k (R.Event (SpiderEnv x))) -> Dynamic x R.PatchDMap (DMap k (Event x))) . unSpiderIncremental
2046− {-# INLINABLE currentIncremental #-}
2047− currentIncremental = SpiderBehavior . current . unSpiderIncremental
2048− {-# INLINABLE updatedIncremental #-}
2049− updatedIncremental = SpiderEvent . updated . unSpiderIncremental
2050− {-# INLINABLE incrementalToDynamic #-}
2051− incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ current i) $ flip push (updated i) $ \p -> do
2052− c <- readBehaviorUntracked $ current i
2053− return $ Identity <$> R.apply p c --TODO: Avoid the redundant 'apply'
2054−
2055−instance R.MonadSample (SpiderEnv x) (EventM x) where
2056− {-# INLINABLE sample #-}
2057− sample (SpiderBehavior b) = readBehaviorUntracked b
2058−
2059−instance R.MonadHold (SpiderEnv x) (EventM x) where
2060− {-# INLINABLE hold #-}
2061− hold = holdSpiderEventM
2062− {-# INLINABLE holdDyn #-}
2063− holdDyn = holdDynSpiderEventM
2064− {-# INLINABLE holdIncremental #-}
2065− holdIncremental = holdIncrementalSpiderEventM
2066−
2067−holdSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Behavior (SpiderEnv x) a)
2068−holdSpiderEventM v0 e = fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
2069−
2070−holdDynSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Dynamic (SpiderEnv x) a)
2071−holdDynSpiderEventM v0 e = fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
2072−
2073−holdIncrementalSpiderEventM :: R.Patch p => a -> R.Event (SpiderEnv x) (p a) -> EventM x (R.Incremental (SpiderEnv x) p a)
2074−holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2075−
2076−instance R.MonadHold (SpiderEnv x) (SpiderHost x) where
2077− {-# INLINABLE hold #-}
2078− hold v0 e = R.runHostFrame $ R.hold v0 e
2079− {-# INLINABLE holdDyn #-}
2080− holdDyn v0 e = R.runHostFrame $ R.holdDyn v0 e
2081− {-# INLINABLE holdIncremental #-}
2082− holdIncremental v0 e = R.runHostFrame $ R.holdIncremental v0 e
2083−
2084−instance R.MonadSample (SpiderEnv x) (SpiderHost x) where
2085− {-# INLINABLE sample #-}
2086− sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2087−
2088−instance R.MonadSample (SpiderEnv x) (SpiderPullM x) where
2089− {-# INLINABLE sample #-}
2090− sample = coerce . readBehaviorTracked . unSpiderBehavior
2091−
2092−instance R.MonadSample (SpiderEnv x) (SpiderPushM x) where
2093− {-# INLINABLE sample #-}
2094− sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2095−
2096−instance R.MonadHold (SpiderEnv x) (SpiderPushM x) where
2097− {-# INLINABLE hold #-}
2098− hold v0 e = R.current <$> R.holdDyn v0 e
2099− {-# INLINABLE holdDyn #-}
2100− holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ coerce e
2101− {-# INLINABLE holdIncremental #-}
2102− holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . DynamicHold <$> hold v0 e
2103−
2104−data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2105−
2106−data SpiderEventHandle x a = SpiderEventHandle
2107− { spiderEventHandleSubscription :: EventSubscription x a
2108− , spiderEventHandleValue :: IORef (Maybe a)
2109− }
2110−
2111−instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHostFrame x) where
2112− {-# INLINABLE subscribeEvent #-}
2113− subscribeEvent e = SpiderHostFrame $ do
2114− --TODO: Unsubscribe eventually (manually and/or with weak ref)
2115− val <- liftIO $ newIORef Nothing
2116− subscription <- subscribe (unSpiderEvent e) $ Subscriber
2117− { subscriberPropagate = \a -> do
2118− liftIO $ writeIORef val $ Just a
2119− scheduleClear val
2120− , subscriberInvalidateHeight = \_ -> return ()
2121− , subscriberRecalculateHeight = \_ -> return ()
2122− }
2123− return $ SpiderEventHandle
2124− { spiderEventHandleSubscription = subscription
2125− , spiderEventHandleValue = val
2126− }
2127−
2128−instance R.ReflexHost (SpiderEnv x) where
2129− type EventTrigger (SpiderEnv x) = RootTrigger x
2130− type EventHandle (SpiderEnv x) = SpiderEventHandle x
2131− type HostFrame (SpiderEnv x) = SpiderHostFrame x
2132−
2133−instance R.MonadReadEvent (SpiderEnv x) (ReadPhase x) where
2134− {-# NOINLINE readEvent #-}
2135− readEvent h = ReadPhase $ fmap (fmap return) $ liftIO $ do
2136− result <- readIORef $ spiderEventHandleValue h
2137− touch h
2138− return result
2139−
2140−instance MonadRef (EventM x) where
2141− type Ref (EventM x) = Ref IO
2142− {-# INLINABLE newRef #-}
2143− {-# INLINABLE readRef #-}
2144− {-# INLINABLE writeRef #-}
2145− newRef = liftIO . newRef
2146− readRef = liftIO . readRef
2147− writeRef r a = liftIO $ writeRef r a
2148−
2149−instance MonadAtomicRef (EventM x) where
2150− {-# INLINABLE atomicModifyRef #-}
2151− atomicModifyRef r f = liftIO $ atomicModifyRef r f
2152−
2153−-- | The monad for actions that manipulate a Spider timeline identified by @x@
2154−newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2155−
2156−instance Monad (SpiderHost x) where
2157− {-# INLINABLE (>>=) #-}
2158− SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2159− {-# INLINABLE (>>) #-}
2160− SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2161− {-# INLINABLE return #-}
2162− return x = SpiderHost $ return x
2163− {-# INLINABLE fail #-}
2164− fail s = SpiderHost $ fail s
2165−
2166−-- | Run an action affecting the global Spider timeline; this will be guarded by
2167−-- a mutex for that timeline
2168−runSpiderHost :: SpiderHost Global a -> IO a
2169−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderEnv
2170−
2171−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2172−
2173−instance Monad (SpiderHostFrame x) where
2174− {-# INLINABLE (>>=) #-}
2175− SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2176− {-# INLINABLE (>>) #-}
2177− SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2178− {-# INLINABLE return #-}
2179− return x = SpiderHostFrame $ return x
2180− {-# INLINABLE fail #-}
2181− fail s = SpiderHostFrame $ fail s
2182−
2183−instance R.MonadSample (SpiderEnv x) (SpiderHostFrame x) where
2184− sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2185−
2186−instance R.MonadHold (SpiderEnv x) (SpiderHostFrame x) where
2187− {-# INLINABLE hold #-}
2188− hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
2189− {-# INLINABLE holdDyn #-}
2190− holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ coerce $ unSpiderEvent e
2191− {-# INLINABLE holdIncremental #-}
2192− holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2193−
2194−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2195−newEventWithTriggerIO f = do
2196− es <- newFanEventWithTriggerIO $ \Refl -> f
2197− return $ select es Refl
2198−
2199−newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2200−newFanEventWithTriggerIO f = do
2201− occRef <- newIORef DMap.empty
2202− subscribedRef <- newIORef DMap.empty
2203− let !r = Root
2204− { rootOccurrence = occRef
2205− , rootSubscribed = subscribedRef
2206− , rootInit = f
2207− }
2208− return $ EventSelector $ \k -> eventRoot k r
2209−
2210−instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHost x) where
2211− newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
2212− newFanEventWithTrigger f = SpiderHost $ lift $ do
2213− es <- newFanEventWithTriggerIO f
2214− return $ R.EventSelector $ SpiderEvent . select es
2215−
2216−instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHostFrame x) where
2217− newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2218− newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2219− es <- newFanEventWithTriggerIO f
2220− return $ R.EventSelector $ SpiderEvent . select es
2221−
2222−instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHost x) where
2223− {-# INLINABLE subscribeEvent #-}
2224− subscribeEvent = runFrame . runSpiderHostFrame . R.subscribeEvent
2225−
2226−newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2227−
2228−instance R.MonadSample (SpiderEnv x) (ReadPhase x) where
2229− {-# INLINABLE sample #-}
2230− sample = ReadPhase . R.sample
2231−
2232−instance R.MonadHold (SpiderEnv x) (ReadPhase x) where
2233− {-# INLINABLE hold #-}
2234− hold v0 e = ReadPhase $ R.hold v0 e
2235− {-# INLINABLE holdDyn #-}
2236− holdDyn v0 e = ReadPhase $ R.holdDyn v0 e
2237− {-# INLINABLE holdIncremental #-}
2238− holdIncremental v0 e = ReadPhase $ R.holdIncremental v0 e
2239−
2240−instance R.MonadReflexHost (SpiderEnv x) (SpiderHost x) where
2241− type ReadPhase (SpiderHost x) = ReadPhase x
2242− fireEventsAndRead es (ReadPhase a) = run es a
2243− runHostFrame = runFrame . runSpiderHostFrame
2244−
2245−instance MonadRef (SpiderHost x) where
2246− type Ref (SpiderHost x) = Ref IO
2247− newRef = SpiderHost . newRef
2248− readRef = SpiderHost . readRef
2249− writeRef r = SpiderHost . writeRef r
2250−
2251−instance MonadAtomicRef (SpiderHost x) where
2252− atomicModifyRef r = SpiderHost . atomicModifyRef r
2253−
2254−instance MonadRef (SpiderHostFrame x) where
2255− type Ref (SpiderHostFrame x) = Ref IO
2256− newRef = SpiderHostFrame . newRef
2257− readRef = SpiderHostFrame . readRef
2258− writeRef r = SpiderHostFrame . writeRef r
2259−
2260−instance MonadAtomicRef (SpiderHostFrame x) where
2261− atomicModifyRef r = SpiderHostFrame . atomicModifyRef r
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−279
@@ -1,279 +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−testCases :: [(String, TestCase)]
27−testCases =
28− [ testB "hold" $ hold "0" =<< events1
29−
30− , testB "count" $ do
31− b <- current <$> (count =<< events2)
32− return $ (+ (0::Int)) <$> b
33−
34− , testB "pull-1" $ do
35− b <- hold "0" =<< events1
36− return (pull $ sample $ pull $ sample b)
37−
38− , testB "pull-2" $ do
39− b1 <- behavior1
40− return (pull $ liftA2 (<>) (sample b1) (sample b1))
41−
42− , testB "pull-3" $ do
43− b1 <- behavior1
44− b2 <- behavior2
45− return (pull $ liftA2 (<>) (sample b1) (sample b2))
46−
47− , testB "pull-4" $ do
48− es <- planList ["a", "b", "c"]
49− e <- plan [(0, ())]
50− b <- hold (constant "") $
51− pushAlways (const $ hold "z" es) e
52− return (join b)
53−
54− , testE "id" $ do
55− events2
56−
57− , testE "fmap-id" $ do
58− e <- events2
59− return $ fmap id e
60−
61− , testE "tag-1" $ do
62− b1 <- behavior1
63− e <- events2
64− return (tag b1 e)
65−
66− , testE "tag-2" $ do
67− b1 <- behavior1
68− e <- events2
69− return (tag (map toUpper <$> b1) e)
70−
71− , testE "attach-1" $ do
72− b1 <- behavior1
73− e <- events2
74− return (attachWith (++) (map toUpper <$> b1) e)
75−
76− , testE "leftmost" $ liftA2 leftmost2 events1 events2
77−
78− , testE "appendEvents-1" $ liftA2 mappend events1 events2
79−
80− , testE "appendEvents-2" $ liftA2 mappend events3 events2
81−
82− , testE "merge-1" $ do
83− e <- events1
84− return $ leftmost ["x" <$ e, "y" <$ e]
85−
86− , testE "merge-2" $ do
87− e <- events1
88− let m = mergeMap $ Map.fromList [(1::Int, "y" <$ e), (2, "z" <$ e)]
89− let ee = flip pushAlways e $ const $ return m
90− return $ coincidence ee
91−
92− , testE "headE-1" $ do
93− e <- events1
94− headE $ leftmost [e, e]
95−
96− , testE "headE-2" $ do
97− e <- events1
98− b <- hold never (e <$ e)
99− headE $ switch b
100−
101− , testE "switch-1" $ do
102− e <- events1
103− b <- hold never (e <$ e)
104− return $ switch b
105−
106− , testE "switch-2" $ do
107− e <- events1
108− return $ coincidence $ flip pushAlways e $ const $ do
109− switch <$> hold (leftmost ["x" <$ e, "y" <$ e, "z" <$ e]) (e <$ e)
110−
111− , testE "switch-3" $ do
112− e <- events1
113− return $ coincidence $ flip pushAlways e $ const $ do
114− switch <$> hold (leftmost ["x" <$ e, "y" <$ e, "z" <$ e]) never
115−
116− , testE "switch-4" $ do
117− e <- events1
118− switch <$> hold (deep e) (e <$ e)
119−
120− , testE "switch-5" $ do
121− e <- events1
122− return $ coincidence $ flip pushAlways e $ const $
123− return $ leftmost ["x" <$ e, "y" <$ e, "z" <$ e]
124−
125− , testE "switch-6" $ do
126− e <- events1
127− return $ coincidence $ flip pushAlways e $ const $ do
128− switch <$> hold ("x" <$ e) (e <$ e)
129−
130− , testE "switchPromptly-1" $ do
131− e <- events1
132− let e' = e <$ e
133− switchPromptly never $ e <$ e'
134−
135− , testE "switchPromptly-2" $ do
136− e <- events1
137− switchPromptly never $ deep (e <$ e)
138−
139− , testE "switchPromptly-3" $ do
140− e <- events1
141− switchPromptly never $ (e <$ deep e)
142−
143− , testE "switchPromptly-4" $ do
144− e <- events1
145− switchPromptly never $ (deep e <$ e)
146−
147− , testE "switch-5" $ do
148− e <- events1
149− switch <$> hold never (deep e <$ e)
150−
151− , testE "switchPromptly-5" $ do
152− e <- events1
153− switchPromptly never $ flip push e $
154− const (Just <$> headE e)
155−
156− , testE "switchPromptly-6" $ do
157− e <- events1
158− switchPromptly never $ flip pushAlways e $
159− const (switchPromptly e never)
160−
161− , testE "coincidence-1" $ do
162− e <- events1
163− return $ coincidence $ flip pushAlways e $
164− const $ return e
165−
166− , testE "coincidence-2" $ do
167− e <- events1
168− return $ coincidence $ flip pushAlways e $
169− const $ return (deep e)
170−
171− , testE "coincidence-3" $ do
172− e <- events1
173− return $ coincidence $ flip pushAlways e $
174− const $ return (coincidence (e <$ e))
175−
176− , testE "coincidence-4" $ do
177− e <- events1
178− return $ coincidence $ flip pushAlways e $
179− const (headE e)
180−
181− , testE "coincidence-5" $ do
182− e <- events1
183− return $ coincidence $ flip pushAlways e $ const $ do
184− let e' = deep e
185− return (coincidence (e' <$ e'))
186−
187− , testE "coincidence-6" $ do
188− e <- events1
189− return $ coincidence $ flip pushAlways e $ const $ do
190− let e' = coincidence (e <$ e)
191− return $ deep e'
192−
193− , testE "coincidence-7" $ do
194− e <- events1
195− return $ coincidence (deep e <$ e)
196−
197− , testB "holdWhileFiring" $ do
198− e <- events1
199− eo <- headE e
200− bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
201− return $ pull $ sample =<< sample bb
202−
203− , testE "joinDyn" $ do
204− e <- events1
205− bb <- hold "b" e
206− bd <- hold never . fmap (const e) =<< headE e
207−
208− eOuter <- pushAlways sample . fmap (const bb) <$> headE e
209− let eInner = switch bd
210− return $ leftmost [eOuter, eInner]
211−
212− , testB "foldDyn" $ do
213− d <- foldDyn (++) "0" =<< events1
214− return (current d)
215−
216− , testB "mapDyn" $ do
217− d <- foldDyn (++) "0" =<< events1
218− return $ current $ fmap (map toUpper) d
219−
220− , testB "combineDyn" $ do
221− d1 <- foldDyn (++) "0" =<< events1
222− d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
223−
224− return $ current $ zipDynWith (<>) d1 d2
225− , testE "fan-1" $ do
226− e <- fmap toMap <$> events1
227− let es = select (fanMap e) . Const2 <$> values
228−
229− return (mergeList es)
230−
231− , testE "fan-2" $ do
232− e <- fmap toMap <$> events3
233− let es = select (fanMap e) . Const2 <$> values
234−
235− return (mergeList es)
236−
237− , testE "fan-3" $ do
238− f <- fanMap . fmap toMap <$> events3
239− return $ select f (Const2 'c')
240−
241− , testE "fan-4" $ do
242− e <- fmap toMap <$> events1
243− return $ toUpper <$> select (fanMap e) (Const2 'a')
244−
245− , testE "fan-5" $ do
246− e <- fmap toMap <$> events2
247− return $ toUpper <$> select (fanMap e) (Const2 'c')
248−
249− , testE "fan-6" $ do
250− f <- fanMap . fmap toMap <$> events1
251− return $ toList <$> mergeList [ select f (Const2 'b'), select f (Const2 'b'), select f (Const2 'e'), select f (Const2 'e') ]
252−
253− , testE "lazy-hold" $ do
254− let lazyHold :: forall t m. (Reflex t, MonadHold t m, MonadFix m) => m (Event t ())
255− lazyHold = do
256− rec !b <- hold never e
257− let e = never <$ switch b
258− return $ void e
259− lazyHold
260−
261− ] where
262−
263− events1, events2, events3 :: TestPlan t m => m (Event t String)
264− events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
265− events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
266−
267− events3 = liftA2 mappend events1 events2
268−
269− values = "abcde"
270− toMap str = Map.fromList $ map (\c -> (c, c)) str
271−
272− behavior1, behavior2 :: forall t m. TestPlan t m => m (Behavior t String)
273− behavior1 = hold "1" =<< events1
274− behavior2 = hold "2" =<< events2
275−
276− deep e = leftmost [e, e]
277− leftmost2 e1 e2 = leftmost [e1, e2]
278−
279−
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