git.iko.soy/patch
on 9c6fc50 help sign in
b6af869
swap
0 ahead, 1061 behind
39 files changed+2975−2708
since splitsnapshots
unifiedsplit
.ghci+2 .github/workflows/haskell.yml−47 .gitignore−7 .stylish-haskell.yaml−153 CONTRIBUTING.md−66 ChangeLog.md−61 README.md+9−46 bench-cbits/checkCapability.c−208 bench/Main.hs+110 cabal.project−1 default.nix+15 dep/reflex-platform/default.nix−8 dep/reflex-platform/github.json−8 patch.cabal−100 reflex.cabal+66 release.nix−49 src/Data/Functor/Misc.hs+47−203 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/Reflex.hs+10 src/Reflex/Class.hs+358 src/Reflex/Dynamic.hs+488 src/Reflex/Dynamic/TH.hs+38 src/Reflex/Host/Class.hs+159 src/Reflex/Spider.hs+5 src/Reflex/Spider/Internal.hs+1401 stylize−4 test/Reflex/Pure.hs+46 test/Reflex/Test/CrossImpl.hs+221 test/hlint.hs−39 test/tests.hs−43
.ghci+2
@@ -1,2 +1,4 @@
11:set -isrc
2+:set -hide-package MonadCatchIO-mtl
3+:set -hide-package monads-fd
24:seti -XOverloadedStrings
.github/workflows/haskell.ymldeleted−47
@@ -1,47 +0,0 @@
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−7
@@ -1,7 +1,4 @@
11dist
2−cabal.sandbox.config
3−.cabal-sandbox/
4−dist-*
52cabal-dev
63*.o
74*.hi
@@ -32,7 +29,3 @@ tags
3229hsenv.log
3330\#*#
3431.#*
35−/shell.nix
36−/ghci-tmp
37−*.dump-*
38−*.verbose-core2core
.stylish-haskell.yamldeleted−153
@@ -1,153 +0,0 @@
1−# stylish-haskell configuration file
2−# ==================================
3−
4−# The stylish-haskell tool is mainly configured by specifying steps. These steps
5−# are a list, so they have an order, and one specific step may appear more than
6−# once (if needed). Each file is processed by these steps in the given order.
7−steps:
8− # Convert some ASCII sequences to their Unicode equivalents. This is disabled
9− # by default.
10− # - unicode_syntax:
11− # # In order to make this work, we also need to insert the UnicodeSyntax
12− # # language pragma. If this flag is set to true, we insert it when it's
13− # # not already present. You may want to disable it if you configure
14− # # language extensions using some other method than pragmas. Default:
15− # # true.
16− # add_language_pragma: true
17−
18− # Import cleanup
19− - imports:
20− # There are different ways we can align names and lists.
21− #
22− # - global: Align the import names and import list throughout the entire
23− # file.
24− #
25− # - file: Like global, but don't add padding when there are no qualified
26− # imports in the file.
27− #
28− # - group: Only align the imports per group (a group is formed by adjacent
29− # import lines).
30− #
31− # - none: Do not perform any alignment.
32− #
33− # Default: global.
34− align: none
35−
36− # Folowing options affect only import list alignment.
37− #
38− # List align has following options:
39− #
40− # - after_alias: Import list is aligned with end of import including
41− # 'as' and 'hiding' keywords.
42− #
43− # > import qualified Data.List as List (concat, foldl, foldr, head,
44− # > init, last, length)
45− #
46− # - with_alias: Import list is aligned with start of alias or hiding.
47− #
48− # > import qualified Data.List as List (concat, foldl, foldr, head,
49− # > init, last, length)
50− #
51− # - new_line: Import list starts always on new line.
52− #
53− # > import qualified Data.List as List
54− # > (concat, foldl, foldr, head, init, last, length)
55− #
56− # Default: after alias
57− list_align: after_alias
58−
59− # Long list align style takes effect when import is too long. This is
60− # determined by 'columns' setting.
61− #
62− # - inline: This option will put as much specs on same line as possible.
63− #
64− # - new_line: Import list will start on new line.
65− #
66− # - new_line_multiline: Import list will start on new line when it's
67− # short enough to fit to single line. Otherwise it'll be multiline.
68− #
69− # - multiline: One line per import list entry.
70− # Type with contructor list acts like single import.
71− #
72− # > import qualified Data.Map as M
73− # > ( empty
74− # > , singleton
75− # > , ...
76− # > , delete
77− # > )
78− #
79− # Default: inline
80− long_list_align: inline
81−
82− # List padding determines indentation of import list on lines after import.
83− # This option affects 'list_align' and 'long_list_align'.
84− list_padding: 2
85−
86− # Separate lists option affects formating of import list for type
87− # or class. The only difference is single space between type and list
88− # of constructors, selectors and class functions.
89− #
90− # - true: There is single space between Foldable type and list of it's
91− # functions.
92− #
93− # > import Data.Foldable (Foldable (fold, foldl, foldMap))
94− #
95− # - false: There is no space between Foldable type and list of it's
96− # functions.
97− #
98− # > import Data.Foldable (Foldable(fold, foldl, foldMap))
99− #
100− # Default: true
101− separate_lists: true
102−
103− # Language pragmas
104− - language_pragmas:
105− # We can generate different styles of language pragma lists.
106− #
107− # - vertical: Vertical-spaced language pragmas, one per line.
108− #
109− # - compact: A more compact style.
110− #
111− # - compact_line: Similar to compact, but wrap each line with
112− # `{-#LANGUAGE #-}'.
113− #
114− # Default: vertical.
115− style: vertical
116−
117− # Align affects alignment of closing pragma brackets.
118− #
119− # - true: Brackets are aligned in same collumn.
120− #
121− # - false: Brackets are not aligned together. There is only one space
122− # between actual import and closing bracket.
123− #
124− # Default: true
125− align: false
126−
127− # stylish-haskell can detect redundancy of some language pragmas. If this
128− # is set to true, it will remove those redundant pragmas. Default: true.
129− remove_redundant: true
130−
131− # Align the types in record declarations
132− # - records: {}
133−
134− # Replace tabs by spaces. This is disabled by default.
135− # - tabs:
136− # # Number of spaces to use for each tab. Default: 8, as specified by the
137− # # Haskell report.
138− # spaces: 8
139−
140− # Remove trailing whitespace
141− - trailing_whitespace: {}
142−
143−# A common setting is the number of columns (parts of) code will be wrapped
144−# to. Different steps take this into account. Default: 80.
145−columns: 110
146−
147−# Sometimes, language extensions are specified in a cabal file or from the
148−# command line instead of using language pragmas in the file. stylish-haskell
149−# needs to be aware of these, so it can parse the file correctly.
150−#
151−# No language extensions are enabled by default.
152−language_extensions:
153− - TemplateHaskell
CONTRIBUTING.mddeleted−66
@@ -1,66 +0,0 @@
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.mddeleted−61
@@ -1,61 +0,0 @@
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.
README.md+9−46
@@ -1,52 +1,15 @@
1−# patch
1+## Reflex
2+### Practical Functional Reactive Programming
23
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)
4+Reflex is an fully-deterministic, higher-order Functional Reactive Programming (FRP) interface and an engine that efficiently implements that interface.
45
5−Data structures for describing changes to other data structures.
6+[Reflex-DOM](https://github.com/ryantrinkle/reflex-dom) is a framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
67
7−A `Patch` type represents a kind of change made to a data structure.
8+Comprehensive documentation is still a work in progress, but a tutorial for Reflex and Reflex-DOM is available at https://github.com/ryantrinkle/try-reflex 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).
89
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−```
10+### Additional resources
11+[try reflex](https://github.com/ryantrinkle/try-reflex)
1612
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).
13+[reddit/r/reflexfrp](http://www.reddit.com/r/reflexfrp)
1914
20−`PatchMap` is defined as:
21−
22−```haskell
23−newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
24−```
25−
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`!
15+irc.freenode.net #reflex-frp
bench-cbits/checkCapability.cdeleted−208
@@ -1,208 +0,0 @@
1−#include <Rts.h>
2−
3−// The InCall structure represents either a single in-call from C to
4−// Haskell, or a worker thread.
5−typedef struct InCall_ {
6− StgTSO * tso; // the bound TSO (or NULL for a worker)
7−
8− StgTSO * suspended_tso; // the TSO is stashed here when we
9− // make a foreign call (NULL otherwise);
10−
11− Capability *suspended_cap; // The capability that the
12− // suspended_tso is on, because
13− // we can't read this from the TSO
14− // without owning a Capability in the
15− // first place.
16−
17− SchedulerStatus rstat; // return status
18− StgClosure ** ret; // return value
19−
20− struct Task_ *task;
21−
22− // When a Haskell thread makes a foreign call that re-enters
23− // Haskell, we end up with another Task associated with the
24− // current thread. We have to remember the whole stack of InCalls
25− // associated with the current Task so that we can correctly
26− // save & restore the InCall on entry to and exit from Haskell.
27− struct InCall_ *prev_stack;
28−
29− // Links InCalls onto suspended_ccalls, spare_incalls
30− struct InCall_ *prev;
31− struct InCall_ *next;
32−} InCall;
33−
34−typedef struct Task_ {
35−#if defined(THREADED_RTS)
36− OSThreadId id; // The OS Thread ID of this task
37−
38− Condition cond; // used for sleeping & waking up this task
39− Mutex lock; // lock for the condition variable
40−
41− // this flag tells the task whether it should wait on task->cond
42− // or just continue immediately. It's a workaround for the fact
43− // that signalling a condition variable doesn't do anything if the
44− // thread is already running, but we want it to be sticky.
45− HsBool wakeup;
46−#endif
47−
48− // This points to the Capability that the Task "belongs" to. If
49− // the Task owns a Capability, then task->cap points to it. If
50− // the task does not own a Capability, then either (a) if the task
51− // is a worker, then task->cap points to the Capability it belongs
52− // to, or (b) it is returning from a foreign call, then task->cap
53− // points to the Capability with the returning_worker queue that this
54− // this Task is on.
55− //
56− // When a task goes to sleep, it may be migrated to a different
57− // Capability. Hence, we always check task->cap on wakeup. To
58− // syncrhonise between the migrater and the migratee, task->lock
59− // must be held when modifying task->cap.
60− struct Capability_ *cap;
61−
62− // The current top-of-stack InCall
63− struct InCall_ *incall;
64−
65− uint32_t n_spare_incalls;
66− struct InCall_ *spare_incalls;
67−
68− HsBool worker; // == rtsTrue if this is a worker Task
69− HsBool stopped; // this task has stopped or exited Haskell
70−
71− // So that we can detect when a finalizer illegally calls back into Haskell
72− HsBool running_finalizers;
73−
74− // Links tasks on the returning_tasks queue of a Capability, and
75− // on spare_workers.
76− struct Task_ *next;
77−
78− // Links tasks on the all_tasks list; need ACQUIRE_LOCK(&all_tasks_mutex)
79− struct Task_ *all_next;
80− struct Task_ *all_prev;
81−
82−} Task;
83−
84−struct Capability_ {
85− // State required by the STG virtual machine when running Haskell
86− // code. During STG execution, the BaseReg register always points
87− // to the StgRegTable of the current Capability (&cap->r).
88− StgFunTable f;
89− StgRegTable r;
90−
91− uint32_t no; // capability number.
92−
93− // The Task currently holding this Capability. This task has
94− // exclusive access to the contents of this Capability (apart from
95− // returning_tasks_hd/returning_tasks_tl).
96− // Locks required: cap->lock.
97− Task *running_task;
98−
99− // true if this Capability is running Haskell code, used for
100− // catching unsafe call-ins.
101− HsBool in_haskell;
102−
103− // Has there been any activity on this Capability since the last GC?
104− uint32_t idle;
105−
106− HsBool disabled;
107−
108− // The run queue. The Task owning this Capability has exclusive
109− // access to its run queue, so can wake up threads without
110− // taking a lock, and the common path through the scheduler is
111− // also lock-free.
112− StgTSO *run_queue_hd;
113− StgTSO *run_queue_tl;
114−
115− // Tasks currently making safe foreign calls. Doubly-linked.
116− // When returning, a task first acquires the Capability before
117− // removing itself from this list, so that the GC can find all
118− // the suspended TSOs easily. Hence, when migrating a Task from
119− // the returning_tasks list, we must also migrate its entry from
120− // this list.
121− InCall *suspended_ccalls;
122−
123− // One mutable list per generation, so we don't need to take any
124− // locks when updating an old-generation thunk. This also lets us
125− // keep track of which closures this CPU has been mutating, so we
126− // can traverse them using the right thread during GC and avoid
127− // unnecessarily moving the data from one cache to another.
128− bdescr **mut_lists;
129− bdescr **saved_mut_lists; // tmp use during GC
130−
131− // block for allocating pinned objects into
132− bdescr *pinned_object_block;
133− // full pinned object blocks allocated since the last GC
134− bdescr *pinned_object_blocks;
135−
136− // per-capability weak pointer list associated with nursery (older
137− // lists stored in generation object)
138− StgWeak *weak_ptr_list_hd;
139− StgWeak *weak_ptr_list_tl;
140−
141− // Context switch flag. When non-zero, this means: stop running
142− // Haskell code, and switch threads.
143− int context_switch;
144−
145− // Interrupt flag. Like the context_switch flag, this also
146− // indicates that we should stop running Haskell code, but we do
147− // *not* switch threads. This is used to stop a Capability in
148− // order to do GC, for example.
149− //
150− // The interrupt flag is always reset before we start running
151− // Haskell code, unlike the context_switch flag which is only
152− // reset after we have executed the context switch.
153− int interrupt;
154−
155− // Total words allocated by this cap since rts start
156− // See [Note allocation accounting] in Storage.c
157− W_ total_allocated;
158−
159−#if defined(THREADED_RTS)
160− // Worker Tasks waiting in the wings. Singly-linked.
161− Task *spare_workers;
162− uint32_t n_spare_workers; // count of above
163−
164− // This lock protects:
165− // running_task
166− // returning_tasks_{hd,tl}
167− // wakeup_queue
168− // inbox
169− Mutex lock;
170−
171− // Tasks waiting to return from a foreign call, or waiting to make
172− // a new call-in using this Capability (NULL if empty).
173− // NB. this field needs to be modified by tasks other than the
174− // running_task, so it requires cap->lock to modify. A task can
175− // check whether it is NULL without taking the lock, however.
176− Task *returning_tasks_hd; // Singly-linked, with head/tail
177− Task *returning_tasks_tl;
178−
179− // Messages, or END_TSO_QUEUE.
180− // Locks required: cap->lock
181− Message *inbox;
182−
183− SparkPool *sparks;
184−
185− // Stats on spark creation/conversion
186− SparkCounters spark_stats;
187−#if !defined(mingw32_HOST_OS)
188− // IO manager for this cap
189− int io_manager_control_wr_fd;
190−#endif
191−#endif
192−
193− // Per-capability STM-related data
194− StgTVarWatchQueue *free_tvar_watch_queues;
195− StgTRecChunk *free_trec_chunks;
196− StgTRecHeader *free_trec_headers;
197− uint32_t transaction_tokens;
198−} // typedef Capability is defined in RtsAPI.h
199− // We never want a Capability to overlap a cache line with anything
200− // else, so round it up to a cache line size:
201−#ifndef mingw32_HOST_OS
202− ATTRIBUTE_ALIGNED(64)
203−#endif
204− ;
205−
206−HsBool myCapabilityHasOtherRunnableThreads() {
207− return rts_unsafeGetMyCapability()->run_queue_hd == END_TSO_QUEUE ? HS_BOOL_FALSE : HS_BOOL_TRUE;
208−}
bench/Main.hsnew file+110
@@ -0,0 +1,110 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE TupleSections #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+{-# LANGUAGE TypeFamilies #-}
5+module Main where
6+
7+import Data.Functor.Misc
8+import Control.Monad.Primitive
9+import Control.Monad.IO.Class
10+import Data.Dependent.Sum
11+import Control.Concurrent.STM
12+import Control.Applicative
13+import System.IO.Unsafe
14+import Data.IORef
15+import Control.DeepSeq
16+import Control.Exception (evaluate)
17+import Control.Monad
18+import Reflex
19+import Reflex.Host.Class
20+import System.Mem
21+import System.IO
22+import Criterion.Main
23+
24+import qualified Data.Traversable as T
25+
26+import qualified Data.Dependent.Map as DM
27+
28+
29+main :: IO ()
30+main = defaultMain
31+ [ bgroup "micro" micros ]
32+
33+instance NFData (IORef a) where
34+ rnf x = seq x ()
35+
36+instance NFData (TVar a) where
37+ rnf x = seq x ()
38+
39+newtype WHNF a = WHNF a
40+instance NFData (WHNF a) where
41+ rnf (WHNF a) = seq a ()
42+
43+withSetup :: NFData b => String -> SpiderHost a -> (a -> SpiderHost b) -> Benchmark
44+withSetup name setup action = env (WHNF <$> runSpiderHost setup) $ \ ~(WHNF a) ->
45+ bench name . nfIO $ runSpiderHost (action a)
46+
47+withSetupWHNF :: String -> SpiderHost a -> (a -> SpiderHost b) -> Benchmark
48+withSetupWHNF name setup action = env (WHNF <$> runSpiderHost setup) $ \ ~(WHNF a) ->
49+ bench name . whnfIO $ runSpiderHost (action a)
50+
51+
52+micros :: [Benchmark]
53+micros =
54+ [ bench "newIORef" $ whnfIO $ void $ newIORef ()
55+ , env (newIORef (42 :: Int)) (bench "readIORef" . whnfIO . readIORef)
56+ , bench "newTVar" $ whnfIO $ void $ newTVarIO ()
57+ , env (newTVarIO (42 :: Int)) (bench "readTVar" . whnfIO . readTVarIO)
58+ , bench "newEventWithTrigger" $ whnfIO . void $ runSpiderHost $ newEventWithTrigger $
59+ \trigger -> return () <$ evaluate trigger
60+ , bench "newEventWithTriggerRef" $ whnfIO . void $ runSpiderHost newEventWithTriggerRef
61+ , withSetupWHNF "subscribeEvent" newEventWithTriggerRef $ subscribeEvent . fst
62+ , withSetupWHNF "subscribeSwitch"
63+ (join $ hold <$> fmap fst newEventWithTriggerRef <*> fmap fst newEventWithTriggerRef)
64+ (subscribeEvent . switch)
65+ , withSetupWHNF "subscribeMerge(1)" (setupMerge 1) $ \(ev,_) -> subscribeEvent ev
66+ , withSetupWHNF "subscribeMerge(100)" (setupMerge 100) (subscribeEvent . fst)
67+ , withSetupWHNF "subscribeMerge(10000)" (setupMerge 10000) (subscribeEvent . fst)
68+ , bench "runHostFrame" $ whnfIO $ runSpiderHost $ runHostFrame $ return ()
69+ , withSetupWHNF "fireEventsAndRead(single/single)"
70+ (newEventWithTriggerRef >>= subscribePair)
71+ (\(subd, trigger) -> fireAndRead trigger (42 :: Int) subd)
72+ , withSetupWHNF "fireEventsOnly"
73+ (newEventWithTriggerRef >>= subscribePair)
74+ (\(subd, trigger) -> do
75+ Just key <- liftIO $ readIORef trigger
76+ fireEvents [key :=> (42 :: Int)])
77+ , withSetupWHNF "fireEventsAndRead(head/merge1)"
78+ (setupMerge 1 >>= subscribePair)
79+ (\(subd, t:riggers) -> fireAndRead t (42 :: Int) subd)
80+ , withSetupWHNF "fireEventsAndRead(head/merge100)"
81+ (setupMerge 100 >>= subscribePair)
82+ (\(subd, t:riggers) -> fireAndRead t (42 :: Int) subd)
83+ , withSetupWHNF "fireEventsAndRead(head/merge10000)"
84+ (setupMerge 10000 >>= subscribePair)
85+ (\(subd, t:riggers) -> fireAndRead t (42 :: Int) subd)
86+ , withSetupWHNF "fireEventsOnly(head/merge100)"
87+ (setupMerge 100 >>= subscribePair)
88+ (\(subd, t:riggers) -> do
89+ Just key <- liftIO $ readIORef t
90+ fireEvents [key :=> (42 :: Int)])
91+ , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev,trigger) -> hold (42 :: Int) ev
92+ , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
93+ ]
94+
95+setupMerge :: Int
96+ -> SpiderHost (Event Spider (DM.DMap (Const2 Int a)),
97+ [IORef (Maybe (EventTrigger Spider a))])
98+setupMerge num = do
99+ (evs, triggers) <- unzip <$> replicateM 100 newEventWithTriggerRef
100+ let !m = DM.fromList [WrapArg (Const2 i) :=> v | (i,v) <- zip [0..] evs]
101+ pure (merge m, triggers)
102+
103+subscribePair :: (Event Spider a, b) -> SpiderHost (EventHandle Spider a, b)
104+subscribePair (ev, b) = (,b) <$> subscribeEvent ev
105+
106+fireAndRead :: IORef (Maybe (EventTrigger Spider a)) -> a -> EventHandle Spider b
107+ -> SpiderHost (Maybe b)
108+fireAndRead trigger val subd = do
109+ Just key <- liftIO $ readIORef trigger
110+ fireEventsAndRead [key :=> val] $ readEvent subd >>= T.sequence
cabal.projectdeleted−1
@@ -1 +0,0 @@
1−packages: .
default.nixnew file+15
@@ -0,0 +1,15 @@
1+{ mkDerivation, dependent-map, dependent-sum
2+, mtl, ref-tf, semigroups, these, MemoTrie, exception-transformers
3+}:
4+mkDerivation {
5+ pname = "reflex";
6+ version = "0.1";
7+ src = builtins.filterSource (path: type: baseNameOf path != ".git") ./.;
8+ buildDepends = [
9+ dependent-map dependent-sum mtl ref-tf semigroups these exception-transformers
10+ ];
11+ testDepends = [
12+ MemoTrie
13+ ];
14+ license = null;
15+}
dep/reflex-platform/default.nixdeleted−8
@@ -1,8 +0,0 @@
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.jsondeleted−8
@@ -1,8 +0,0 @@
1−{
2− "owner": "reflex-frp",
3− "repo": "reflex-platform",
4− "branch": "master",
5− "private": false,
6− "rev": "c9d11db1b98855fe8ab24a3ff6a5dbe0ad902ad9",
7− "sha256": "0sfzkqdvyah5mwvmli0wq1nl0b8cvk2cmfgfy4rz57wv42x3099y"
8−}
patch.cabaldeleted−100
@@ -1,100 +0,0 @@
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.cabalnew file+66
@@ -0,0 +1,66 @@
1+Name: reflex
2+Version: 0.3
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/ryantrinkle/reflex
14+bug-reports: https://github.com/ryantrinkle/reflex/issues
15+
16+library
17+ hs-source-dirs: src
18+ build-depends:
19+ base >= 4.7 && < 4.9,
20+ dependent-sum == 0.2.*,
21+ dependent-map == 0.1.*,
22+ semigroups == 0.16.*,
23+ mtl >= 2.1 && < 2.3,
24+ containers == 0.5.*,
25+ these == 0.4.*,
26+ primitive >= 0.5 && < 0.7,
27+ template-haskell >= 2.9 && < 2.11,
28+ ref-tf == 0.4.*,
29+ exception-transformers == 0.4.*,
30+ transformers >= 0.2,
31+ transformers-compat >= 0.3
32+
33+ exposed-modules:
34+ Reflex,
35+ Reflex.Spider,
36+ Reflex.Spider.Internal,
37+ Reflex.Class,
38+ Reflex.Dynamic,
39+ Reflex.Dynamic.TH,
40+ Reflex.Host.Class,
41+ Data.Functor.Misc
42+
43+ other-extensions: TemplateHaskell
44+ ghc-prof-options: -fprof-auto
45+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
46+
47+benchmark spider-bench
48+ type: exitcode-stdio-1.0
49+ hs-source-dirs: bench
50+ main-is: Main.hs
51+ ghc-options: -O2 -rtsopts
52+ build-depends:
53+ base,
54+ dependent-sum,
55+ dependent-map,
56+ transformers >= 0.3 && < 0.5,
57+ stm == 2.4.*,
58+ deepseq >= 1.3 && < 1.5,
59+ mtl,
60+ primitive,
61+ criterion == 1.1.*,
62+ reflex
63+
64+source-repository head
65+ type: git
66+ location: https://github.com/ryantrinkle/reflex
release.nixdeleted−49
@@ -1,49 +0,0 @@
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+47−203
@@ -1,78 +1,30 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE StandaloneDeriving #-}
13−-- | This module provides types and functions with no particular theme, but
14−-- which are relevant to the use of 'Functor'-based datastructures like
15−-- 'Data.Dependent.Map.DMap'.
16−module Data.Functor.Misc
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 ((<$>))
40−import Data.Dependent.Map (DMap)
41−import qualified Data.Dependent.Map as DMap
42−import Data.Dependent.Sum
43−import Data.Functor.Identity
1+{-# LANGUAGE KindSignatures, GADTs, DeriveDataTypeable, RankNTypes, ScopedTypeVariables, PolyKinds #-}
2+module Data.Functor.Misc where
3+
444import Data.GADT.Compare
45−import Data.GADT.Show
46−import Data.IntMap (IntMap)
47−import qualified Data.IntMap as IntMap
485import Data.Map (Map)
496import qualified Data.Map as Map
50−import Data.Some (Some, mkSome)
51−import Data.These
52−import Data.Type.Equality ((:~:)(Refl))
7+import Data.Dependent.Map (DMap, DSum (..))
8+import qualified Data.Dependent.Map as DMap
539import Data.Typeable hiding (Refl)
10+import Data.These
11+import Data.Maybe
5412
55−--------------------------------------------------------------------------------
56−-- Const2
57−--------------------------------------------------------------------------------
58−
59−-- | 'Const2' stores a value of a given type 'k' and ensures that a particular
60−-- type 'v' is always given for the last type parameter
61−data Const2 :: * -> x -> x -> * where
62− Const2 :: k -> Const2 k v v
63− deriving (Typeable)
13+data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
14+ WrapArg :: f a -> WrapArg g f (g a)
6415
65−-- | Extract the value from a Const2
66−unConst2 :: Const2 k v v' -> k
67−unConst2 (Const2 k) = k
16+instance GEq f => GEq (WrapArg g f) where
17+ geq (WrapArg a) (WrapArg b) = fmap (\Refl -> Refl) $ geq a b
6818
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)
19+instance GCompare f => GCompare (WrapArg g f) where
20+ gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
21+ GLT -> GLT
22+ GEQ -> GEQ
23+ GGT -> GGT
7324
74−instance Show k => GShow (Const2 k v) where
75− gshowsPrec n x@(Const2 _) = showsPrec n x
25+data Const2 :: * -> * -> * -> * where
26+ Const2 :: k -> Const2 k v v
27+ deriving (Typeable)
7628
7729instance Eq k => GEq (Const2 k v) where
7830 geq (Const2 a) (Const2 b) =
@@ -86,146 +38,38 @@ instance Ord k => GCompare (Const2 k v) where
8638 EQ -> GEQ
8739 GT -> GGT
8840
89−-- | Convert a 'DMap' to a regular 'Map'
90−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
91−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
92−
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−
102−-- | Convert a regular 'Map' to a 'DMap'
103−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
104−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
105−
106−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
107−-- to a 'DMap'
108−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
109−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
110−
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−
121−--------------------------------------------------------------------------------
122−-- WrapArg
123−--------------------------------------------------------------------------------
124−
125−-- | 'WrapArg' can be used to tag a value in one functor with a type
126−-- representing another functor. This was primarily used with dependent-map <
127−-- 0.2, in which the value type was not wrapped in a separate functor.
128−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
129− WrapArg :: f a -> WrapArg g f (g a)
41+{-# INLINE sequenceDmap #-}
42+sequenceDmap :: (Monad m, GCompare f) => DMap (WrapArg m f) -> m (DMap f)
43+sequenceDmap = DMap.foldrWithKey (\(WrapArg k) mv mx -> mx >>= \x -> mv >>= \v -> return $ DMap.insert k v x) (return DMap.empty)
13044
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))
45+{-# INLINE combineDMapsWithKey #-}
46+combineDMapsWithKey :: forall f g h i. GCompare f => (forall a. f a -> These (g a) (h a) -> i a) -> DMap (WrapArg g f) -> DMap (WrapArg h f) -> DMap (WrapArg i f)
47+combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
48+ where go :: [DSum (WrapArg g f)] -> [DSum (WrapArg h f)] -> [DSum (WrapArg i f)]
49+ go [] hs = map (\(WrapArg hk :=> hv) -> WrapArg hk :=> f hk (That hv)) hs
50+ go gs [] = map (\(WrapArg gk :=> gv) -> WrapArg gk :=> f gk (This gv)) gs
51+ go gs@((WrapArg gk :=> gv) : gs') hs@((WrapArg hk :=> hv) : hs') = case gk `gcompare` hk of
52+ GLT -> (WrapArg gk :=> f gk (This gv)) : go gs' hs
53+ GEQ -> (WrapArg gk :=> f gk (These gv hv)) : go gs' hs'
54+ GGT -> (WrapArg hk :=> f hk (That hv)) : go gs hs'
13555
136−instance GEq f => GEq (WrapArg g f) where
137− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
56+wrapDMap :: (forall a. a -> f a) -> DMap k -> DMap (WrapArg f k)
57+wrapDMap f = DMap.fromDistinctAscList . map (\(k :=> v) -> WrapArg k :=> f v) . DMap.toAscList
13858
139−instance GCompare f => GCompare (WrapArg g f) where
140− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
141− GLT -> GLT
142− GEQ -> GEQ
143− GGT -> GGT
59+rewrapDMap :: (forall a. f a -> g a) -> DMap (WrapArg f k) -> DMap (WrapArg g k)
60+rewrapDMap f = DMap.fromDistinctAscList . map (\(WrapArg k :=> v) -> WrapArg k :=> f v) . DMap.toAscList
14461
145−--------------------------------------------------------------------------------
146−-- Convenience functions for DMap
147−--------------------------------------------------------------------------------
62+unwrapDMap :: (forall a. f a -> a) -> DMap (WrapArg f k) -> DMap k
63+unwrapDMap f = DMap.fromDistinctAscList . map (\(WrapArg k :=> v) -> k :=> f v) . DMap.toAscList
14864
149−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
150−-- well as the value. The provided function MUST preserve the ordering of the
151−-- keys, or the resulting 'DMap' will be malformed.
152−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
153−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
65+unwrapDMapMaybe :: (forall a. f a -> Maybe a) -> DMap (WrapArg f k) -> DMap k
66+unwrapDMapMaybe f = DMap.fromDistinctAscList . catMaybes . map (\(WrapArg k :=> v) -> fmap (k :=>) $ f v) . DMap.toAscList
15467
155−{-# INLINE combineDMapsWithKey #-}
156−-- | Union two 'DMap's of different types, yielding another type. Each key that
157−-- is present in either input map will be present in the output.
158−combineDMapsWithKey :: forall f g h i.
159− GCompare f
160− => (forall a. f a -> These (g a) (h a) -> i a)
161− -> DMap f g
162− -> DMap f h
163− -> DMap f i
164−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
165− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
166− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
167− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
168− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
169− GLT -> (gk :=> f gk (This gv)) : go gs' hs
170− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
171− GGT -> (hk :=> f hk (That hv)) : go gs hs'
172−
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)
68+mapToDMap :: Map k v -> DMap (Const2 k v)
69+mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
70+
71+mapWithFunctorToDMap :: Map k (f v) -> DMap (WrapArg f (Const2 k v))
72+mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> WrapArg (Const2 k) :=> v) . Map.toAscList
18673
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−
221−--------------------------------------------------------------------------------
222−-- ComposeMaybe
223−--------------------------------------------------------------------------------
224−
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)
74+dmapToMap :: DMap (Const2 k v) -> Map k v
75+dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, v)) . DMap.toAscList
src/Data/Monoid/DecidablyEmpty.hsdeleted−115
@@ -1,115 +0,0 @@
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.hsdeleted−95
@@ -1,95 +0,0 @@
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.hsdeleted−45
@@ -1,45 +0,0 @@
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.hsdeleted−93
@@ -1,93 +0,0 @@
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.hsdeleted−371
@@ -1,371 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE Rank2Types #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−
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.hsdeleted−76
@@ -1,76 +0,0 @@
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.hsdeleted−72
@@ -1,72 +0,0 @@
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.hsdeleted−312
@@ -1,312 +0,0 @@
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.hsdeleted−432
@@ -1,432 +0,0 @@
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.hsdeleted−54
@@ -1,54 +0,0 @@
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/Reflex.hsnew file+10
@@ -0,0 +1,10 @@
1+module Reflex ( module Reflex.Class
2+ , module Reflex.Dynamic
3+ , module Reflex.Dynamic.TH
4+ , module Reflex.Spider
5+ ) where
6+
7+import Reflex.Class
8+import Reflex.Dynamic
9+import Reflex.Dynamic.TH
10+import Reflex.Spider
src/Reflex/Class.hsnew file+358
@@ -0,0 +1,358 @@
1+{-# LANGUAGE TypeFamilies, FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, RankNTypes, GADTs, ScopedTypeVariables, FunctionalDependencies, RecursiveDo, UndecidableInstances, GeneralizedNewtypeDeriving, StandaloneDeriving, EmptyDataDecls, NoMonomorphismRestriction, TypeOperators, DeriveDataTypeable, PackageImports, TemplateHaskell, LambdaCase #-}
2+module Reflex.Class where
3+
4+import Prelude hiding (mapM, mapM_, sequence, sequence_, foldl)
5+
6+import Control.Monad.Identity hiding (mapM, mapM_, forM, forM_, sequence, sequence_)
7+import Control.Monad.State.Strict hiding (mapM, mapM_, forM, forM_, sequence, sequence_)
8+import Control.Monad.Reader hiding (mapM, mapM_, forM, forM_, sequence, sequence_)
9+import Control.Monad.Trans.Writer (WriterT())
10+import Control.Monad.Trans.Except (ExceptT())
11+import Control.Monad.Trans.Cont (ContT())
12+import Control.Monad.Trans.RWS (RWST())
13+import Data.List.NonEmpty (NonEmpty (..))
14+import Data.These
15+import Data.Align
16+import Data.GADT.Compare (GEq (..), (:~:) (..))
17+import Data.GADT.Show (GShow (..))
18+import Data.Dependent.Sum (ShowTag (..))
19+import Data.Map (Map)
20+import Data.Dependent.Map (DMap, DSum (..), GCompare (..), GOrdering (..))
21+import qualified Data.Dependent.Map as DMap
22+import Data.Functor.Misc
23+import Data.Semigroup
24+import Data.Traversable
25+
26+import Debug.Trace (trace)
27+
28+class (MonadHold t (PushM t), MonadSample t (PullM t), Functor (Event t), Functor (Behavior t)) => Reflex t where
29+ -- | A container for a value that can change over time. Behaviors can be sampled at will, but it is not possible to be notified when they change
30+ data Behavior t :: * -> *
31+ -- | A stream of occurrences. During any given frame, an Event is either occurring or not occurring; if it is occurring, it will contain a value of the given type (its "occurrence type")
32+ data Event t :: * -> *
33+ -- | An Event with no occurrences
34+ never :: Event t a
35+ -- | Create a Behavior that always has the given value
36+ 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 Behaviors doesn't have a negative performance impact
37+ -- | Create an Event from another Event; the provided function can sample Behaviors and hold Events, and use the results to produce a occurring (Just) or non-occurring (Nothing) result
38+ push :: (a -> PushM t (Maybe b)) -> Event t a -> Event t b
39+ -- | A monad for doing complex push-based calculations efficiently
40+ type PushM t :: * -> *
41+ -- | Create a Behavior by reading from other Behaviors; the result will be recomputed whenever any of the read Behaviors changes
42+ pull :: PullM t a -> Behavior t a
43+ -- | A monad for doing complex pull-based calculations efficiently
44+ type PullM t :: * -> *
45+ -- | Merge a collection of events; the resulting Event will only occur if at least one input event is occuring, and will contain all of the input keys that are occurring simultaneously
46+ merge :: GCompare k => DMap (WrapArg (Event t) k) -> Event t (DMap k) --TODO: Generalize to get rid of DMap use --TODO: Provide a type-level guarantee that the result is not empty
47+ -- | Efficiently fan-out an event to many destinations. This function should be partially applied, and then the result applied repeatedly to create child events
48+ fan :: GCompare k => Event t (DMap k) -> EventSelector t k --TODO: Can we help enforce the partial application discipline here? The combinator is worthless without it
49+ -- | Create an Event that will occur whenever the currently-selected input Event occurs
50+ switch :: Behavior t (Event t a) -> Event t a
51+ -- | Create an Event that will occur whenever the input event is occurring and its occurrence value, another Event, is also occurring
52+ coincidence :: Event t (Event t a) -> Event t a
53+
54+class Monad m => MonadSample t m | m -> t where
55+ -- | Get the current value in the Behavior
56+ sample :: Behavior t a -> m a
57+
58+class MonadSample t m => MonadHold t m where
59+ -- | Create a new Behavior whose value will initially be equal to the given value and will be updated whenever the given Event occurs
60+ hold :: a -> Event t a -> m (Behavior t a)
61+
62+newtype EventSelector t k = EventSelector { select :: forall a. k a -> Event t a }
63+
64+--------------------------------------------------------------------------------
65+-- Instances
66+--------------------------------------------------------------------------------
67+
68+instance MonadSample t m => MonadSample t (ReaderT r m) where
69+ sample = lift . sample
70+
71+instance MonadHold t m => MonadHold t (ReaderT r m) where
72+ hold a0 = lift . hold a0
73+
74+instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
75+ sample = lift . sample
76+
77+instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
78+ hold a0 = lift . hold a0
79+
80+instance MonadSample t m => MonadSample t (StateT s m) where
81+ sample = lift . sample
82+
83+instance MonadHold t m => MonadHold t (StateT s m) where
84+ hold a0 = lift . hold a0
85+
86+instance MonadSample t m => MonadSample t (ExceptT e m) where
87+ sample = lift . sample
88+
89+instance MonadHold t m => MonadHold t (ExceptT e m) where
90+ hold a0 = lift . hold a0
91+
92+instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
93+ sample = lift . sample
94+
95+instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
96+ hold a0 = lift . hold a0
97+
98+instance MonadSample t m => MonadSample t (ContT r m) where
99+ sample = lift . sample
100+
101+instance MonadHold t m => MonadHold t (ContT r m) where
102+ hold a0 = lift . hold a0
103+
104+--------------------------------------------------------------------------------
105+-- Convenience functions
106+--------------------------------------------------------------------------------
107+
108+-- | Create an Event from another Event.
109+-- The provided function can sample 'Behavior's and hold 'Event's.
110+pushAlways :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
111+pushAlways f e = push (liftM Just . f) e
112+
113+-- | Flipped version of 'fmap'.
114+ffor :: Functor f => f a -> (a -> b) -> f b
115+ffor = flip fmap
116+
117+instance Reflex t => Functor (Behavior t) where
118+ fmap f = pull . liftM f . sample
119+
120+instance Reflex t => Applicative (Behavior t) where
121+ pure = constant
122+ f <*> x = pull $ sample f `ap` sample x
123+ _ *> b = b
124+ a <* _ = a
125+
126+instance Reflex t => Monad (Behavior t) where
127+ a >>= f = pull $ sample a >>= sample . f
128+ -- 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 Behaviors other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
129+ return = constant
130+ fail = error "Monad (Behavior t) does not support fail"
131+
132+instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
133+ a <> b = pull $ liftM2 (<>) (sample a) (sample b)
134+ sconcat = pull . liftM sconcat . mapM sample
135+ times1p n = fmap $ times1p n
136+
137+instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
138+ mempty = constant mempty
139+ mappend a b = pull $ liftM2 mappend (sample a) (sample b)
140+ mconcat = pull . liftM mconcat . mapM sample
141+
142+--TODO: See if there's a better class in the standard libraries already
143+-- | A class for values that combines filtering and mapping using 'Maybe'.
144+class FunctorMaybe f where
145+ -- | Combined mapping and filtering function.
146+ fmapMaybe :: (a -> Maybe b) -> f a -> f b
147+
148+-- | Flipped version of 'fmapMaybe'.
149+fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
150+fforMaybe = flip fmapMaybe
151+
152+-- | Filter 'f a' using the provided predicate.
153+-- Relies on 'fforMaybe'.
154+ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
155+ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
156+
157+instance Reflex t => FunctorMaybe (Event t) where
158+ fmapMaybe f = push $ return . f
159+
160+instance Reflex t => Functor (Event t) where
161+ fmap f = fmapMaybe $ Just . f
162+
163+-- | Create a new 'Event' by combining each occurence with the next value
164+-- of the list using the supplied function. If the list runs out of items,
165+-- all subsequent 'Event' occurrences will be ignored.
166+zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
167+zipListWithEvent f l e = do
168+ rec lb <- hold l eTail
169+ let eBoth = flip push e $ \o -> do
170+ l' <- sample lb
171+ return $ case l' of
172+ (h : t) -> Just (f h o, t)
173+ [] -> Nothing
174+ let eTail = fmap snd eBoth
175+ lb `seq` eBoth `seq` eTail `seq` return ()
176+ return $ fmap fst eBoth
177+
178+-- | Replace each occurrence value of the 'Event' with the value of the
179+-- 'Behavior' at the time of that occurrence.
180+tag :: Reflex t => Behavior t b -> Event t a -> Event t b
181+tag b = pushAlways $ \_ -> sample b
182+
183+-- | Create a new 'Event' that combines occurences of supplied 'Event'
184+-- with the current value of the 'Behavior'.
185+attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
186+attach = attachWith (,)
187+
188+-- | Create a new 'Event' that occurs when the supplied 'Event' occurs
189+-- by combining it with the current value of the 'Behavior'.
190+attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
191+attachWith f = attachWithMaybe $ \a b -> Just $ f a b
192+
193+-- | Create a new 'Event' by combining each occurence with the current
194+-- value of the 'Behavior'. The occurrence is discarded if the combining function
195+-- returns Nothing
196+attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
197+attachWithMaybe f b e = flip push e $ \o -> liftM (flip f o) $ sample b
198+
199+-- | Alias for 'headE'
200+onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
201+onceE = headE
202+
203+-- | Create a new 'Event' that only occurs on the first occurence of
204+-- the supplied 'Event'.
205+headE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
206+headE e = do
207+ rec be <- hold e $ fmap (const never) e'
208+ let e' = switch be
209+ e' `seq` return ()
210+ return e'
211+
212+-- | Create a new 'Event' that occurs on all but the first occurence
213+-- of the supplied 'Event'.
214+tailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
215+tailE e = liftM snd $ headTailE e
216+
217+-- | Create a tuple of two 'Event's with the first one occuring only
218+-- the first time the supplied 'Event' occurs and the second occuring
219+-- on all but the first occurence.
220+headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
221+headTailE e = do
222+ eHead <- headE e
223+ be <- hold never $ fmap (const e) eHead
224+ return (eHead, switch be)
225+
226+-- | Split the supplied 'Event' into two individual 'Event's occuring
227+-- at the same time with the respective values from the tuple.
228+splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
229+splitE e = (fmap fst e, fmap snd e)
230+
231+-- | Print the supplied 'String' and the value of the 'Event' on each
232+-- occurence. This should /only/ be used for debugging.
233+--
234+-- Note: As with Debug.Trace.trace, the message will only be printed if
235+-- the 'Event' is actually used.
236+traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
237+traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
238+
239+-- | Print the output of the supplied function on each occurence of
240+-- the 'Event'. This should /only/ be used for debugging.
241+--
242+-- Note: As with Debug.Trace.trace, the message will only be printed if
243+-- the 'Event' is actually used.
244+traceEventWith :: Reflex t => (a -> String) -> Event t a -> Event t a
245+traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
246+
247+-- | Tag type for 'Either' to use it as a 'DSum'.
248+data EitherTag l r a where
249+ LeftTag :: EitherTag l r l
250+ RightTag :: EitherTag l r r
251+
252+instance GEq (EitherTag l r) where
253+ geq a b = case (a, b) of
254+ (LeftTag, LeftTag) -> Just Refl
255+ (RightTag, RightTag) -> Just Refl
256+ _ -> Nothing
257+
258+instance GCompare (EitherTag l r) where
259+ gcompare a b = case (a, b) of
260+ (LeftTag, LeftTag) -> GEQ
261+ (LeftTag, RightTag) -> GLT
262+ (RightTag, LeftTag) -> GGT
263+ (RightTag, RightTag) -> GEQ
264+
265+instance GShow (EitherTag l r) where
266+ gshowsPrec _ a = case a of
267+ LeftTag -> showString "LeftTag"
268+ RightTag -> showString "RightTag"
269+
270+instance (Show l, Show r) => ShowTag (EitherTag l r) where
271+ showTaggedPrec t n a = case t of
272+ LeftTag -> showsPrec n a
273+ RightTag -> showsPrec n a
274+
275+-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
276+eitherToDSum :: Either a b -> DSum (EitherTag a b)
277+eitherToDSum = \case
278+ Left a -> LeftTag :=> a
279+ Right b -> RightTag :=> b
280+
281+-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
282+dsumToEither :: DSum (EitherTag a b) -> Either a b
283+dsumToEither = \case
284+ LeftTag :=> a -> Left a
285+ RightTag :=> b -> Right b
286+
287+-- | Extract the values of a 'DMap' of 'EitherTag's.
288+dmapToThese :: DMap (EitherTag a b) -> Maybe (These a b)
289+dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
290+ (Nothing, Nothing) -> Nothing
291+ (Just a, Nothing) -> Just $ This a
292+ (Nothing, Just b) -> Just $ That b
293+ (Just a, Just b) -> Just $ These a b
294+
295+-- | Create a new 'Event' that occurs if at least one of the supplied
296+-- 'Event's occurs. If both occur at the same time they are combined
297+-- using 'mappend'.
298+appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
299+appendEvents e1 e2 = fmap (mergeThese mappend) $ align e1 e2
300+
301+{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
302+sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
303+sequenceThese t = case t of
304+ This ma -> liftM This ma
305+ These ma mb -> liftM2 These ma mb
306+ That mb -> liftM That mb
307+
308+instance (Semigroup a, Reflex t) => Monoid (Event t a) where
309+ mempty = never
310+ mappend a b = mconcat [a, b]
311+ mconcat = fmap sconcat . mergeList
312+
313+-- | Create a new 'Event' that occurs if at least one of the 'Event's
314+-- in the list occurs. If multiple occur at the same time they are
315+-- folded from the left with the given function.
316+mergeWith :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
317+mergeWith f es = fmap (Prelude.foldl1 f . map (\(Const2 _ :=> v) -> v) . DMap.toList) $ merge $ DMap.fromList $ map (\(k, v) -> WrapArg (Const2 k) :=> v) $ zip [0 :: Int ..] es
318+
319+-- | Create a new 'Event' that occurs if at least one of the 'Event's
320+-- in the list occurs. If multiple occur at the same time the value is
321+-- the value of the leftmost event.
322+leftmost :: Reflex t => [Event t a] -> Event t a
323+leftmost = mergeWith const
324+
325+-- | Create a new 'Event' that occurs if at least one of the 'Event's
326+-- in the list occurs and has a list of the values of all 'Event's
327+-- occuring at that time.
328+mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
329+mergeList [] = never
330+mergeList es = mergeWith (<>) $ map (fmap (:|[])) es
331+
332+-- | Create a new 'Event' combining the map of 'Event's into an
333+-- 'Event' that occurs if at least one of them occurs and has a map of
334+-- values of all 'Event's occuring at that time.
335+mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
336+mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
337+
338+-- | Split the event into an 'EventSelector' that allows efficient
339+-- selection of the individual 'Event's.
340+fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
341+fanMap = fan . fmap mapToDMap
342+
343+-- | Switches to the new event whenever it receives one; the new event is used immediately, on the same frame that it is switched to
344+switchPromptly :: forall t m a. (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
345+switchPromptly ea0 eea = do
346+ bea <- hold ea0 eea
347+ let eLag = switch bea
348+ eCoincidences = coincidence eea
349+ return $ leftmost [eCoincidences, eLag]
350+
351+instance Reflex t => Align (Event t) where
352+ nil = never
353+ align ea eb = fmapMaybe dmapToThese $ merge $ DMap.fromList [WrapArg LeftTag :=> ea, WrapArg RightTag :=> eb]
354+
355+-- | Create a new 'Event' that only occurs if the supplied 'Event'
356+-- occurs and the 'Behavior' is true at the time of occurence.
357+gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
358+gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
src/Reflex/Dynamic.hsnew file+488
@@ -0,0 +1,488 @@
1+{-# LANGUAGE TypeFamilies, FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, RankNTypes, GADTs, ScopedTypeVariables, FunctionalDependencies, RecursiveDo, UndecidableInstances, GeneralizedNewtypeDeriving, StandaloneDeriving, EmptyDataDecls, NoMonomorphismRestriction, TypeOperators, DeriveDataTypeable, PackageImports, TemplateHaskell, LambdaCase, DataKinds, PolyKinds #-}
2+module Reflex.Dynamic ( Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
3+ , current
4+ , updated
5+ , constDyn
6+ , holdDyn
7+ , nubDyn
8+ , count
9+ , toggle
10+ , switchPromptlyDyn
11+ , tagDyn
12+ , attachDyn
13+ , attachDynWith
14+ , attachDynWithMaybe
15+ , mapDyn
16+ , forDyn
17+ , mapDynM
18+ , foldDyn
19+ , foldDynM
20+ , combineDyn
21+ , collectDyn
22+ , mconcatDyn
23+ , distributeDMapOverDyn
24+ , joinDyn
25+ , joinDynThroughMap
26+ , traceDyn
27+ , traceDynWith
28+ , splitDyn
29+ , Demux
30+ , demux
31+ , getDemuxed
32+ -- Things that probably aren't very useful:
33+ , HList (..)
34+ , FHList (..)
35+ , distributeFHListOverDyn
36+ -- Unsafe
37+ , unsafeDynamic
38+ ) where
39+
40+import Prelude hiding (mapM, mapM_)
41+
42+import Reflex.Class
43+import Data.Functor.Misc
44+
45+import Control.Monad hiding (mapM, mapM_, forM, forM_)
46+import Control.Monad.Fix
47+import Control.Monad.Identity hiding (mapM, mapM_, forM, forM_)
48+import Data.These
49+import Data.Traversable (mapM, forM)
50+import Data.Align
51+import Data.Map (Map)
52+import qualified Data.Map as Map
53+import Data.Dependent.Map (DMap)
54+import qualified Data.Dependent.Map as DMap
55+import Data.Dependent.Sum (DSum (..))
56+import Data.GADT.Compare (GCompare (..), GEq (..), (:~:) (..), GOrdering (..))
57+import Data.Monoid
58+--import Data.HList (HList (..), hBuild)
59+
60+data HList (l::[*]) where
61+ HNil :: HList '[]
62+ HCons :: e -> HList l -> HList (e ': l)
63+
64+infixr 2 `HCons`
65+
66+type family HRevApp (l1 :: [k]) (l2 :: [k]) :: [k]
67+type instance HRevApp '[] l = l
68+type instance HRevApp (e ': l) l' = HRevApp l (e ': l')
69+
70+hRevApp :: HList l1 -> HList l2 -> HList (HRevApp l1 l2)
71+hRevApp HNil l = l
72+hRevApp (HCons x l) l' = hRevApp l (HCons x l')
73+
74+hReverse :: HList l -> HList (HRevApp l '[])
75+hReverse l = hRevApp l HNil
76+
77+hBuild :: (HBuild' '[] r) => r
78+hBuild = hBuild' HNil
79+
80+class HBuild' l r where
81+ hBuild' :: HList l -> r
82+
83+instance (l' ~ HRevApp l '[])
84+ => HBuild' l (HList l') where
85+ hBuild' l = hReverse l
86+
87+instance HBuild' (a ': l) r
88+ => HBuild' l (a->r) where
89+ hBuild' l x = hBuild' (HCons x l)
90+
91+-- | A container for a value that can change over time and allows notifications on changes.
92+-- Basically a combination of a 'Behavior' and an 'Event', with a rule that the Behavior will
93+-- change if and only if the Event fires.
94+data Dynamic t a
95+ = Dynamic (Behavior t a) (Event t a)
96+
97+unsafeDynamic :: Behavior t a -> Event t a -> Dynamic t a
98+unsafeDynamic = Dynamic
99+
100+-- | Extract the 'Behavior' of a 'Dynamic'.
101+current :: Dynamic t a -> Behavior t a
102+current (Dynamic b _) = b
103+
104+-- | Extract the 'Event' of the 'Dynamic'.
105+updated :: Dynamic t a -> Event t a
106+updated (Dynamic _ e) = e
107+
108+-- | 'Dynamic' with the constant supplied value.
109+constDyn :: Reflex t => a -> Dynamic t a
110+constDyn x = Dynamic (constant x) never
111+
112+-- | Create a 'Dynamic' using the initial value that changes every
113+-- time the 'Event' occurs.
114+holdDyn :: MonadHold t m => a -> Event t a -> m (Dynamic t a)
115+holdDyn v0 e = do
116+ b <- hold v0 e
117+ return $ Dynamic b e
118+
119+-- | Create a new 'Dynamic' that only signals changes if the values
120+-- actually changed.
121+nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
122+nubDyn d =
123+ let e' = attachWithMaybe (\x x' -> if x' == x then Nothing else Just x') (current d) (updated d)
124+ in Dynamic (current d) e' --TODO: Avoid invalidating the outgoing Behavior
125+
126+{-
127+instance Reflex t => Functor (Dynamic t) where
128+ fmap f d =
129+ let e' = fmap f $ updated d
130+ eb' = push (\b' -> liftM Just $ constant b') e'
131+ b0 = fmap f $ current d
132+
133+-}
134+
135+-- | Map a function over a 'Dynamic'.
136+mapDyn :: (Reflex t, MonadHold t m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
137+mapDyn f = mapDynM $ return . f
138+
139+-- | Flipped version of 'mapDyn'.
140+forDyn :: (Reflex t, MonadHold t m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
141+forDyn = flip mapDyn
142+
143+-- | Map a monadic function over a 'Dynamic'. The only monadic action that the given function can
144+-- perform is 'sample'.
145+{-# INLINE mapDynM #-}
146+mapDynM :: forall t m a b. (Reflex t, MonadHold t m) => (forall m'. MonadSample t m' => a -> m' b) -> Dynamic t a -> m (Dynamic t b)
147+mapDynM f d = do
148+ let e' = push (liftM Just . f :: a -> PushM t (Maybe b)) $ updated d
149+ eb' = fmap constant e'
150+ v0 = pull $ f =<< sample (current d)
151+ bb' :: Behavior t (Behavior t b) <- hold v0 eb'
152+ let b' = pull $ sample =<< sample bb'
153+ return $ Dynamic b' e'
154+
155+-- | Create a 'Dynamic' using the initial value and change it each
156+-- time the 'Event' occurs using a folding function on the previous
157+-- value and the value of the 'Event'.
158+foldDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> b) -> b -> Event t a -> m (Dynamic t b)
159+foldDyn f = foldDynM (\o v -> return $ f o v)
160+
161+-- | Create a 'Dynamic' using the initial value and change it each
162+-- time the 'Event' occurs using a monadic folding function on the
163+-- previous value and the value of the 'Event'.
164+foldDynM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t b) -> b -> Event t a -> m (Dynamic t b)
165+foldDynM f z e = do
166+ rec let e' = flip push e $ \o -> do
167+ v <- sample b'
168+ liftM Just $ f o v
169+ b' <- hold z e'
170+ return $ Dynamic b' e'
171+
172+-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
173+count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
174+count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
175+
176+-- | Create a new 'Dynamic' using the initial value that flips its
177+-- value every time the 'Event' occurs.
178+toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
179+toggle = foldDyn (const not)
180+
181+-- | Switches to the new 'Event' whenever it receives one. Switching
182+-- occurs *before* the inner 'Event' fires - so if the 'Dynamic' changes and both the old and new
183+-- inner Events fire simultaneously, the output will fire with the value of the *new* 'Event'.
184+switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
185+switchPromptlyDyn de =
186+ let eLag = switch $ current de
187+ eCoincidences = coincidence $ updated de
188+ in leftmost [eCoincidences, eLag]
189+
190+{-
191+
192+mergeEventsWith :: Reflex t m => (a -> a -> a) -> Event t a -> Event t a -> m (Event t a)
193+mergeEventsWith f ea eb = mapE (mergeThese f) =<< alignEvents ea eb
194+
195+firstE :: (Reflex t m) => [Event t a] -> m (Event t a)
196+firstE [] = return never
197+firstE (h:t) = mergeEventsLeftBiased h =<< firstE t
198+
199+concatEventsWith :: (Reflex t m) => (a -> a -> a) -> [Event t a] -> m (Event t a)
200+concatEventsWith _ [] = return never
201+concatEventsWith _ [e] = return e
202+concatEventsWith f es = mapEM (liftM (foldl1 f . map (\(Const2 _ :=> v) -> v) . DMap.toList) . sequenceDmap) <=< mergeEventDMap $ DMap.fromList $ map (\(k, v) -> WrapArg (Const2 k) :=> v) $ zip [0 :: Int ..] es
203+--concatEventsWith f (h:t) = mergeEventsWith f h =<< concatEventsWith f t
204+
205+mconcatE :: (Reflex t m, Monoid a) => [Event t a] -> m (Event t a)
206+mconcatE = concatEventsWith mappend
207+-}
208+
209+-- | Split the 'Dynamic' into two 'Dynamic's, each taking the
210+-- respective value of the tuple.
211+splitDyn :: (Reflex t, MonadHold t m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
212+splitDyn d = liftM2 (,) (mapDyn fst d) (mapDyn snd d)
213+
214+-- | Merge the 'Dynamic' values using their 'Monoid' instance.
215+mconcatDyn :: forall t m a. (Reflex t, MonadHold t m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
216+mconcatDyn es = do
217+ ddm :: Dynamic t (DMap (Const2 Int a)) <- distributeDMapOverDyn $ DMap.fromList $ map (\(k, v) -> WrapArg (Const2 k) :=> v) $ zip [0 :: Int ..] es
218+ mapDyn (mconcat . map (\(Const2 _ :=> v) -> v) . DMap.toList) ddm
219+
220+-- | Create a 'Dynamic' with a 'DMap' of values out of a 'DMap' of
221+-- Dynamic values.
222+distributeDMapOverDyn :: forall t m k. (Reflex t, MonadHold t m, GCompare k) => DMap (WrapArg (Dynamic t) k) -> m (Dynamic t (DMap k))
223+distributeDMapOverDyn dm = case DMap.toList dm of
224+ [] -> return $ constDyn DMap.empty
225+ [WrapArg k :=> v] -> mapDyn (DMap.singleton k) v
226+ _ -> do
227+ let edmPre = merge $ rewrapDMap updated dm
228+ edm :: Event t (DMap k) = flip push edmPre $ \o -> return . Just =<< do
229+ let f _ = \case
230+ This origDyn -> sample $ current origDyn
231+ That _ -> error "distributeDMapOverDyn: should be impossible to have an event occurring that is not present in the original DMap"
232+ These _ (Identity newVal) -> return newVal
233+ sequenceDmap $ combineDMapsWithKey f dm (wrapDMap Identity o)
234+ dm0 :: Behavior t (DMap k) = pull $ do
235+ liftM DMap.fromList $ forM (DMap.toList dm) $ \(WrapArg k :=> dv) -> liftM (k :=>) $ sample $ current dv
236+ bbdm :: Behavior t (Behavior t (DMap k)) <- hold dm0 $ fmap constant edm
237+ let bdm = pull $ sample =<< sample bbdm
238+ return $ Dynamic bdm edm
239+
240+-- | Merge two 'Dynamic's into a new one using the provided
241+-- function. The new 'Dynamic' changes its value each time one of the
242+-- original 'Dynamic's changes its value.
243+combineDyn :: forall t m a b c. (Reflex t, MonadHold t m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
244+combineDyn f da db = do
245+ let eab = align (updated da) (updated db)
246+ ec = flip push eab $ \o -> do
247+ (a, b) <- case o of
248+ This a -> do
249+ b <- sample $ current db
250+ return (a, b)
251+ That b -> do
252+ a <- sample $ current da
253+ return (a, b)
254+ These a b -> return (a, b)
255+ return $ Just $ f a b
256+ c0 :: Behavior t c = pull $ liftM2 f (sample $ current da) (sample $ current db)
257+ bbc :: Behavior t (Behavior t c) <- hold c0 $ fmap constant ec
258+ let bc :: Behavior t c = pull $ sample =<< sample bbc
259+ return $ Dynamic bc ec
260+
261+{-
262+tagInnerDyn :: Reflex t => Event t (Dynamic t a) -> Event t a
263+tagInnerDyn e =
264+ let eSlow = push (liftM Just . sample . current) e
265+ eFast = coincidence $ fmap updated e
266+ in leftmost [eFast, eSlow]
267+-}
268+
269+-- | Join a nested 'Dynamic' into a new 'Dynamic' that has the value
270+-- of the inner 'Dynamic'.
271+joinDyn :: forall t a. (Reflex t) => Dynamic t (Dynamic t a) -> Dynamic t a
272+joinDyn dd =
273+ let b' = pull $ sample . current =<< sample (current dd)
274+ eOuter :: Event t a = pushAlways (sample . current) $ updated dd
275+ eInner :: Event t a = switch $ fmap updated (current dd)
276+ eBoth :: Event t a = coincidence $ fmap updated (updated dd)
277+ e' = leftmost [eBoth, eOuter, eInner]
278+ in Dynamic b' e'
279+
280+--TODO: Generalize this to functors other than Maps
281+-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
282+-- with the current values of the 'Dynamic's in a map.
283+joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
284+joinDynThroughMap dd =
285+ let b' = pull $ mapM (sample . current) =<< sample (current dd)
286+ eOuter :: Event t (Map k a) = pushAlways (mapM (sample . current)) $ updated dd
287+ eInner :: Event t (Map k a) = attachWith (flip Map.union) b' $ switch $ fmap (mergeMap . fmap updated) (current dd) --Note: the flip is important because Map.union is left-biased
288+ readNonFiring :: MonadSample t m => These (Dynamic t a) a -> m a
289+ readNonFiring = \case
290+ This d -> sample $ current d
291+ That a -> return a
292+ These _ a -> return a
293+ eBoth :: Event t (Map k a) = coincidence $ fmap (\m -> pushAlways (mapM readNonFiring . align m) $ mergeMap $ fmap updated m) (updated dd)
294+ e' = leftmost [eBoth, eOuter, eInner]
295+ in Dynamic b' e'
296+
297+-- | Print the value of the 'Dynamic' on each change and prefix it
298+-- with the provided string. This should /only/ be used for debugging.
299+--
300+-- Note: Just like Debug.Trace.trace, the value will only be shown if something
301+-- else in the system is depending on it.
302+traceDyn :: (Reflex t, Show a) => String -> Dynamic t a -> Dynamic t a
303+traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
304+
305+-- | Print the result of applying the provided function to the value
306+-- of the 'Dynamic' on each change. This should /only/ be used for
307+-- debugging.
308+--
309+-- Note: Just like Debug.Trace.trace, the value will only be shown if something
310+-- else in the system is depending on it.
311+traceDynWith :: Reflex t => (a -> String) -> Dynamic t a -> Dynamic t a
312+traceDynWith f d =
313+ let e' = traceEventWith f $ updated d
314+ in Dynamic (current d) e'
315+
316+-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
317+-- each time the 'Event' occurs.
318+--
319+-- Note: `tagDyn d e` differs from `tag (current d) e` in the case that `e` is firing
320+-- at the same time that `d` is changing. With `tagDyn d e`, the *new* value of `d`
321+-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
322+-- will be used, since the 'Behavior' won't be updated until the end of the frame.
323+-- Additionally, this means that the output 'Event' may not be used to directly change
324+-- the input 'Dynamic', because that would mean its value depends on itself. When creating
325+-- cyclic data flows, generally `tag (current d) e` is preferred.
326+tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
327+tagDyn = attachDynWith const
328+
329+-- | Attach the current value of the 'Dynamic' to the value of the
330+-- 'Event' each time it occurs.
331+--
332+-- Note: `attachDyn d` is not the same as `attach (current d)`. See 'tagDyn' for details.
333+attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
334+attachDyn = attachDynWith (,)
335+
336+-- | Combine the current value of the 'Dynamic' with the value of the
337+-- 'Event' each time it occurs.
338+--
339+-- Note: `attachDynWith f d` is not the same as `attachWith f (current d)`. See 'tagDyn' for details.
340+attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
341+attachDynWith f = attachDynWithMaybe $ \a b -> Just $ f a b
342+
343+-- | Create a new 'Event' by combining the value at each occurence
344+-- with the current value of the 'Dynamic' value and possibly
345+-- filtering if the combining function returns 'Nothing'.
346+--
347+-- Note: `attachDynWithMaybe f d` is not the same as `attachWithMaybe f (current d)`. See 'tagDyn' for details.
348+attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
349+attachDynWithMaybe f d e =
350+ let e' = attach (current d) e
351+ in fforMaybe (align e' $ updated d) $ \case
352+ This (a, b) -> f a b -- Only the tagging event is firing, so use that
353+ These (_, b) a -> f a b -- Both events are firing, so use the newer value
354+ That _ -> Nothing -- The tagging event isn't firing, so don't fire
355+
356+--------------------------------------------------------------------------------
357+-- Demux
358+--------------------------------------------------------------------------------
359+
360+-- | Represents a time changing value together with an 'EventSelector'
361+-- that can efficiently detect when the underlying Dynamic has a particular value.
362+-- This is useful for representing data like the current selection of a long list.
363+--
364+-- Semantically,
365+-- > getDemuxed (demux d) k === mapDyn (== k) d
366+-- However, the when getDemuxed is used multiple times, the complexity is only /O(log(n))/,
367+-- rather than /O(n)/ for mapDyn.
368+data Demux t k = Demux { demuxValue :: Behavior t k
369+ , demuxSelector :: EventSelector t (Const2 k Bool)
370+ }
371+
372+-- | Demultiplex an input value to a 'Demux' with many outputs. At any given time, whichever output is indicated by the given 'Dynamic' will be 'True'.
373+demux :: (Reflex t, Ord k) => Dynamic t k -> Demux t k
374+demux k = Demux (current k) (fan $ attachWith (\k0 k1 -> if k0 == k1 then DMap.empty else DMap.fromList [Const2 k0 :=> False, Const2 k1 :=> True]) (current k) (updated k))
375+
376+--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
377+-- | Select a particular output of the 'Demux'; this is equivalent to (but much faster than)
378+-- mapping over the original 'Dynamic' and checking whether it is equal to the given key.
379+getDemuxed :: (Reflex t, MonadHold t m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
380+getDemuxed d k = do
381+ let e = select (demuxSelector d) (Const2 k)
382+ bb <- hold (liftM (==k) $ sample $ demuxValue d) $ fmap return e
383+ let b = pull $ join $ sample bb
384+ return $ Dynamic b e
385+
386+--------------------------------------------------------------------------------
387+-- collectDyn
388+--------------------------------------------------------------------------------
389+
390+--TODO: This whole section is badly in need of cleanup
391+
392+data FHList f l where
393+ FHNil :: FHList f '[]
394+ FHCons :: f e -> FHList f l -> FHList f (e ': l)
395+
396+instance GEq (HListPtr l) where
397+ HHeadPtr `geq` HHeadPtr = Just Refl
398+ HHeadPtr `geq` HTailPtr _ = Nothing
399+ HTailPtr _ `geq` HHeadPtr = Nothing
400+ HTailPtr a `geq` HTailPtr b = a `geq` b
401+
402+instance GCompare (HListPtr l) where -- Warning: This ordering can't change, dmapTo*HList will break
403+ HHeadPtr `gcompare` HHeadPtr = GEQ
404+ HHeadPtr `gcompare` HTailPtr _ = GLT
405+ HTailPtr _ `gcompare` HHeadPtr = GGT
406+ HTailPtr a `gcompare` HTailPtr b = a `gcompare` b
407+
408+data HListPtr l a where
409+ HHeadPtr :: HListPtr (h ': t) h
410+ HTailPtr :: HListPtr t a -> HListPtr (h ': t) a
411+
412+fhlistToDMap :: forall f l. FHList f l -> DMap (WrapArg f (HListPtr l))
413+fhlistToDMap = DMap.fromList . go
414+ where go :: forall l'. FHList f l' -> [DSum (WrapArg f (HListPtr l'))]
415+ go = \case
416+ FHNil -> []
417+ FHCons h t -> (WrapArg HHeadPtr :=> h) : map (\(WrapArg p :=> v) -> WrapArg (HTailPtr p) :=> v) (go t)
418+
419+class RebuildSortedHList l where
420+ rebuildSortedFHList :: [DSum (WrapArg f (HListPtr l))] -> FHList f l
421+ rebuildSortedHList :: [DSum (HListPtr l)] -> HList l
422+
423+instance RebuildSortedHList '[] where
424+ rebuildSortedFHList [] = FHNil
425+ rebuildSortedHList [] = HNil
426+
427+instance RebuildSortedHList t => RebuildSortedHList (h ': t) where
428+ rebuildSortedFHList ((WrapArg HHeadPtr :=> h) : t) = FHCons h $ rebuildSortedFHList $ map (\(WrapArg (HTailPtr p) :=> v) -> WrapArg p :=> v) t
429+ rebuildSortedHList ((HHeadPtr :=> h) : t) = HCons h $ rebuildSortedHList $ map (\(HTailPtr p :=> v) -> p :=> v) t
430+
431+dmapToHList :: forall l. RebuildSortedHList l => DMap (HListPtr l) -> HList l
432+dmapToHList = rebuildSortedHList . DMap.toList
433+
434+distributeFHListOverDyn :: forall t m l. (Reflex t, MonadHold t m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
435+distributeFHListOverDyn l = mapDyn dmapToHList =<< distributeDMapOverDyn (fhlistToDMap l)
436+{-
437+distributeFHListOverDyn l = do
438+ let ec = undefined
439+ c0 = pull $ sequenceFHList $ natMap (sample . current) l
440+ bbc <- hold c0 $ fmap constant ec
441+ let bc = pull $ sample =<< sample bbc
442+ return $ Dynamic bc ec
443+-}
444+
445+class AllAreFunctors (f :: a -> *) (l :: [a]) where
446+ type FunctorList f l :: [*]
447+ toFHList :: HList (FunctorList f l) -> FHList f l
448+ fromFHList :: FHList f l -> HList (FunctorList f l)
449+
450+instance AllAreFunctors f '[] where
451+ type FunctorList f '[] = '[]
452+ toFHList HNil = FHNil
453+ fromFHList FHNil = HNil
454+
455+instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
456+ type FunctorList f (h ': t) = f h ': FunctorList f t
457+ toFHList (a `HCons` b) = a `FHCons` toFHList b
458+ fromFHList (a `FHCons` b) = a `HCons` fromFHList b
459+
460+collectDyn :: ( RebuildSortedHList (HListElems b)
461+ , IsHList a, IsHList b
462+ , AllAreFunctors (Dynamic t) (HListElems b)
463+ , Reflex t, MonadHold t m
464+ , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
465+ ) => a -> m (Dynamic t b)
466+collectDyn ds =
467+ mapDyn fromHList =<< distributeFHListOverDyn (toFHList $ toHList ds)
468+
469+-- Poor man's Generic
470+class IsHList a where
471+ type HListElems a :: [*]
472+ toHList :: a -> HList (HListElems a)
473+ fromHList :: HList (HListElems a) -> a
474+
475+instance IsHList (a, b) where
476+ type HListElems (a, b) = [a, b]
477+ toHList (a, b) = hBuild a b
478+ fromHList (a `HCons` b `HCons` HNil) = (a, b)
479+
480+instance IsHList (a, b, c, d) where
481+ type HListElems (a, b, c, d) = [a, b, c, d]
482+ toHList (a, b, c, d) = hBuild a b c d
483+ fromHList (a `HCons` b `HCons` c `HCons` d `HCons` HNil) = (a, b, c, d)
484+
485+instance IsHList (a, b, c, d, e, f) where
486+ type HListElems (a, b, c, d, e, f) = [a, b, c, d, e, f]
487+ toHList (a, b, c, d, e, f) = hBuild a b c d e f
488+ fromHList (a `HCons` b `HCons` c `HCons` d `HCons` e `HCons` f `HCons` HNil) = (a, b, c, d, e, f)
src/Reflex/Dynamic/TH.hsnew file+38
@@ -0,0 +1,38 @@
1+{-# LANGUAGE TemplateHaskell, ScopedTypeVariables, TypeOperators, GADTs, EmptyDataDecls, PatternGuards #-}
2+module Reflex.Dynamic.TH (qDyn, unqDyn) where
3+
4+import Reflex.Dynamic
5+
6+import Language.Haskell.TH
7+import Data.Data
8+import Control.Monad.State
9+
10+-- | Quote a Dynamic expression. Within the quoted expression, you can use '$(unqDyn [| x |])' to refer to any expression 'x' of type 'Dynamic t a'; the unquoted result will be of type 'a'
11+qDyn :: Q Exp -> Q Exp
12+qDyn qe = do
13+ e <- qe
14+ let f :: forall d. Data d => d -> StateT [(Name, Exp)] Q d
15+ f d = case eqT of
16+ Just (Refl :: d :~: Exp)
17+ | AppE (VarE m) eInner <- d
18+ , m == 'unqMarker
19+ -> do n <- lift $ newName "dyn"
20+ modify ((n, eInner):)
21+ return $ VarE n
22+ _ -> gmapM f d
23+ (e', exprsReversed) <- runStateT (gmapM f e) []
24+ let exprs = reverse exprsReversed
25+ arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
26+ param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
27+ [| mapDyn $(return $ LamE [param] e') =<< distributeFHListOverDyn $(return arg) |]
28+
29+unqDyn :: Q Exp -> Q Exp
30+unqDyn e = [| unqMarker $e |]
31+
32+-- | This type represents an occurrence of unqDyn before it has been processed by qDyn. If you see it in a type error, it probably means that unqDyn has been used outside of a qDyn context.
33+data UnqDyn
34+
35+-- unqMarker must not be exported; it is used only as a way of smuggling data from unqDyn to qDyn
36+--TODO: It would be much nicer if the TH AST was extensible to support this kind of thing without trickery
37+unqMarker :: a -> UnqDyn
38+unqMarker = error "An unqDyn expression was used outside of a qDyn expression"
src/Reflex/Host/Class.hsnew file+159
@@ -0,0 +1,159 @@
1+{-# LANGUAGE ExistentialQuantification, GADTs, ScopedTypeVariables, TypeFamilies, FlexibleInstances, MultiParamTypeClasses, GeneralizedNewtypeDeriving, RankNTypes, BangPatterns, UndecidableInstances, EmptyDataDecls, RecursiveDo, RoleAnnotations, FunctionalDependencies, FlexibleContexts #-}
2+module Reflex.Host.Class where
3+
4+import Prelude hiding (mapM, mapM_, sequence, sequence_, foldl)
5+
6+import Reflex.Class
7+
8+import Control.Monad.Fix
9+import Control.Monad.Trans
10+import Control.Monad.Trans.Reader (ReaderT())
11+import Control.Monad.Trans.Writer (WriterT())
12+import Control.Monad.Trans.Cont (ContT())
13+import Control.Monad.Trans.Except (ExceptT())
14+import Control.Monad.Trans.RWS (RWST())
15+import Control.Monad.Trans.State (StateT())
16+import Data.Dependent.Sum (DSum)
17+import Control.Monad.Ref
18+
19+-- | Framework implementation support class for the reflex implementation represented by @t@.
20+class (Reflex t, MonadReflexCreateTrigger t (HostFrame t), MonadSample t (HostFrame t), MonadHold t (HostFrame t), MonadFix (HostFrame t)) => ReflexHost t where
21+ type EventTrigger t :: * -> *
22+ type EventHandle t :: * -> *
23+ type HostFrame t :: * -> *
24+
25+-- | Monad that allows to read events' values.
26+class (ReflexHost t, Monad m) => MonadReadEvent t m | m -> t where
27+ -- | Read the value of an 'Event' from an 'EventHandle' (created by calling 'subscribeEvent').
28+ --
29+ -- After event propagation is done, all events can be in two states: either they are firing with some value or they are not firing.
30+ -- In the former case, this function returns @Just act@, where @act@ in an action to read the current value of
31+ -- the event. In the latter case, the function returns @Nothing@.
32+ --
33+ -- This function is normally used in the calllback for 'fireEventsAndRead'.
34+ readEvent :: EventHandle t a -> m (Maybe (m a))
35+
36+-- | A monad where new events feed from external sources can be created.
37+class Monad m => MonadReflexCreateTrigger t m | m -> t where
38+ -- | Creates a root 'Event' (one that is not based on any other event).
39+ --
40+ -- When a subscriber first subscribes to an event (building another event
41+ -- that depends on the subscription) the given callback function is run and
42+ -- passed a trigger. The callback function can then set up the event source in IO.
43+ -- After this is done, the callback function must return an accompanying teardown action.
44+ --
45+ -- Any time between setup and teardown the trigger can be used to fire
46+ -- the event, by passing it to 'fireEventsAndRead'.
47+ --
48+ -- Note: An event may be set up multiple times. So after the teardown action is executed, the event may still be set up again in the future.
49+ newEventWithTrigger :: (EventTrigger t a -> IO (IO ())) -> m (Event t a)
50+
51+class (Monad m, ReflexHost t, MonadReflexCreateTrigger t m) => MonadReflexHost t m | m -> t where
52+ -- | Propagate some events firings and read the values of events afterwards.
53+ --
54+ -- This function will create a new frame to fire the given events. It will then update all
55+ -- dependent events and behaviors. After that is done, the given callback is executed which
56+ -- allows to read the final values of events and check whether they have fired in this frame or
57+ -- not.
58+ --
59+ -- All events that are given are fired at the same time.
60+ --
61+ -- This function is typically used in the main loop of a reflex framework implementation.
62+ -- The main loop waits for external events to happen (such as keyboard input or a mouse click)
63+ -- and then fires the corresponding events using this function. The read callback can be used
64+ -- to read output events and perform a corresponding response action to the external event.
65+ fireEventsAndRead :: [DSum (EventTrigger t)] -> (forall m'. (MonadReadEvent t m') => m' a) -> m a
66+
67+ -- | Subscribe to an event and set it up if needed.
68+ --
69+ -- This function will create a new 'EventHandle' from an 'Event'. This handle may then be used via
70+ -- 'readEvent' in the read callback of 'fireEventsAndRead'.
71+ --
72+ -- If the event wasn't subscribed to before (either manually or through a dependent event or behavior)
73+ -- then this function will cause the event and all dependencies of this event to be set up.
74+ -- For example, if the event was created by 'newEventWithTrigger', then it's callback will be executed.
75+ --
76+ -- It's safe to call this function multiple times.
77+ subscribeEvent :: Event t a -> m (EventHandle t a)
78+
79+ -- | Run a frame without any events firing.
80+ --
81+ -- This function should be used when you want to use 'sample' and 'hold' when no events are currently firing.
82+ -- Using this function in that case can improve performance, since the implementation can assume that no events
83+ -- are firing when 'sample' or 'hold' are called.
84+ --
85+ -- This function is commonly used to set up the basic event network when the application starts up.
86+ runHostFrame :: HostFrame t a -> m a
87+
88+-- | Like 'fireEventsAndRead', but without reading any events.
89+fireEvents :: MonadReflexHost t m => [DSum (EventTrigger t)] -> m ()
90+fireEvents dm = fireEventsAndRead dm $ return ()
91+{-# INLINE fireEvents #-}
92+
93+-- | Create a new event and store its trigger in an 'IORef' while it's active.
94+--
95+-- An event is only active between the set up (when it's first subscribed to) and the teardown phases (when noboby is subscribing the event anymore).
96+-- This function returns an Event and an 'IORef'. As long as the event is active, the 'IORef' will contain 'Just' the event trigger to
97+-- trigger this event. When the event is not active, the 'IORef' will contain 'Nothing'. This allows event sources to be more efficient,
98+-- since they don't need to produce events when nobody is listening.
99+newEventWithTriggerRef :: (MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref IO) => m (Event t a, Ref m (Maybe (EventTrigger t a)))
100+newEventWithTriggerRef = do
101+ rt <- newRef Nothing
102+ e <- newEventWithTrigger $ \t -> do
103+ writeRef rt $ Just t
104+ return $ writeRef rt Nothing
105+ return (e, rt)
106+{-# INLINE newEventWithTriggerRef #-}
107+
108+--------------------------------------------------------------------------------
109+-- Instances
110+--------------------------------------------------------------------------------
111+
112+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ReaderT r m) where
113+ newEventWithTrigger initializer = do
114+ lift $ newEventWithTrigger initializer
115+
116+instance MonadReflexHost t m => MonadReflexHost t (ReaderT r m) where
117+ fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
118+ subscribeEvent = lift . subscribeEvent
119+ runHostFrame = lift . runHostFrame
120+
121+instance (MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (WriterT w m) where
122+ newEventWithTrigger = lift . newEventWithTrigger
123+
124+instance (MonadReflexHost t m, Monoid w) => MonadReflexHost t (WriterT w m) where
125+ fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
126+ subscribeEvent = lift . subscribeEvent
127+ runHostFrame = lift . runHostFrame
128+
129+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StateT s m) where
130+ newEventWithTrigger = lift . newEventWithTrigger
131+
132+instance MonadReflexHost t m => MonadReflexHost t (StateT s m) where
133+ fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
134+ subscribeEvent = lift . subscribeEvent
135+ runHostFrame = lift . runHostFrame
136+
137+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ContT r m) where
138+ newEventWithTrigger = lift . newEventWithTrigger
139+
140+instance MonadReflexHost t m => MonadReflexHost t (ContT r m) where
141+ fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
142+ subscribeEvent = lift . subscribeEvent
143+ runHostFrame = lift . runHostFrame
144+
145+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ExceptT e m) where
146+ newEventWithTrigger = lift . newEventWithTrigger
147+
148+instance MonadReflexHost t m => MonadReflexHost t (ExceptT e m) where
149+ fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
150+ subscribeEvent = lift . subscribeEvent
151+ runHostFrame = lift . runHostFrame
152+
153+instance (MonadReflexCreateTrigger t m, Monoid w) => MonadReflexCreateTrigger t (RWST r w s m) where
154+ newEventWithTrigger = lift . newEventWithTrigger
155+
156+instance (MonadReflexHost t m, Monoid w) => MonadReflexHost t (RWST r w s m) where
157+ fireEventsAndRead dm a = lift $ fireEventsAndRead dm a
158+ subscribeEvent = lift . subscribeEvent
159+ runHostFrame = lift . runHostFrame
src/Reflex/Spider.hsnew file+5
@@ -0,0 +1,5 @@
1+module Reflex.Spider ( Spider
2+ , SpiderHost (..) --Temporary, until Widget no longer uses unsafePerformIO
3+ ) where
4+
5+import Reflex.Spider.Internal
src/Reflex/Spider/Internal.hsnew file+1401
@@ -0,0 +1,1401 @@
1+{-# LANGUAGE CPP, ExistentialQuantification, GADTs, ScopedTypeVariables, TypeFamilies, FlexibleInstances, MultiParamTypeClasses, GeneralizedNewtypeDeriving, RankNTypes, BangPatterns, UndecidableInstances, EmptyDataDecls, RecursiveDo, RoleAnnotations, LambdaCase #-}
2+module Reflex.Spider.Internal where
3+
4+import Prelude hiding (mapM, mapM_, any, sequence, concat)
5+
6+import qualified Reflex.Class as R
7+import qualified Reflex.Host.Class as R
8+
9+import Data.IORef
10+import System.Mem.Weak
11+import Data.Foldable
12+import Data.Traversable
13+import Control.Monad hiding (mapM, mapM_, forM_, forM, sequence)
14+import Control.Monad.Reader hiding (mapM, mapM_, forM_, forM, sequence)
15+import GHC.Exts
16+import Control.Applicative -- Unconditionally import, because otherwise it breaks on GHC 7.10.1RC2
17+import Data.Dependent.Map (DMap, DSum (..))
18+import qualified Data.Dependent.Map as DMap
19+import Data.GADT.Compare
20+import Data.Functor.Misc
21+import Data.Maybe
22+import Data.IntMap (IntMap)
23+import qualified Data.IntMap as IntMap
24+import Control.Monad.Ref
25+import Control.Monad.Exception
26+import Data.Monoid ((<>))
27+
28+import System.IO.Unsafe
29+import Unsafe.Coerce
30+import Control.Monad.Primitive
31+
32+debugPropagate :: Bool
33+
34+debugInvalidateHeight :: Bool
35+
36+#ifdef DEBUG
37+
38+#define DEBUG_NODEIDS
39+
40+debugPropagate = True
41+
42+debugInvalidateHeight = True
43+
44+class HasNodeId a where
45+ getNodeId :: a -> Int
46+
47+instance HasNodeId (Hold a) where
48+ getNodeId = holdNodeId
49+
50+instance HasNodeId (PushSubscribed a b) where
51+ getNodeId = pushSubscribedNodeId
52+
53+instance HasNodeId (SwitchSubscribed a) where
54+ getNodeId = switchSubscribedNodeId
55+
56+instance HasNodeId (MergeSubscribed a) where
57+ getNodeId = mergeSubscribedNodeId
58+
59+instance HasNodeId (FanSubscribed a) where
60+ getNodeId = fanSubscribedNodeId
61+
62+instance HasNodeId (CoincidenceSubscribed a) where
63+ getNodeId = coincidenceSubscribedNodeId
64+
65+instance HasNodeId (RootSubscribed a) where
66+ getNodeId = rootSubscribedNodeId
67+
68+showNodeId :: HasNodeId a => a -> String
69+showNodeId = ("#"<>) . show . getNodeId
70+
71+#else
72+
73+debugPropagate = False
74+
75+debugInvalidateHeight = False
76+
77+showNodeId :: a -> String
78+showNodeId = const ""
79+
80+#endif
81+
82+#ifdef DEBUG_NODEIDS
83+{-# NOINLINE nextNodeIdRef #-}
84+nextNodeIdRef :: IORef Int
85+nextNodeIdRef = unsafePerformIO $ newIORef 1
86+
87+{-# NOINLINE unsafeNodeId #-}
88+unsafeNodeId :: a -> Int
89+unsafeNodeId a = unsafePerformIO $ do
90+ touch a
91+ atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
92+#endif
93+
94+--TODO: Figure out why certain things are not 'representational', then make them representational so we can use coerce
95+--type role Hold representational
96+data Hold a
97+ = Hold { holdValue :: !(IORef a)
98+ , holdInvalidators :: !(IORef [Weak Invalidator])
99+ -- We need to use 'Any' for the next two things, because otherwise Hold inherits a nominal role for its 'a' parameter, and we want to be able to use 'coerce'
100+ , holdSubscriber :: !(IORef Any) -- Keeps its subscription alive; for some reason, a regular (or strict) reference to the Subscriber itself wasn't working, so had to use an IORef
101+ , holdParent :: !(IORef Any) -- Keeps its parent alive (will be undefined until the hold is initialized --TODO: Probably shouldn't be an IORef
102+#ifdef DEBUG_NODEIDS
103+ , holdNodeId :: Int
104+#endif
105+ }
106+
107+data EventEnv
108+ = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment])
109+ , eventEnvHoldInits :: !(IORef [SomeHoldInit])
110+ , eventEnvClears :: !(IORef [SomeMaybeIORef])
111+ , eventEnvCurrentHeight :: !(IORef Int)
112+ , eventEnvCoincidenceInfos :: !(IORef [SomeCoincidenceInfo])
113+ , eventEnvDelayedMerges :: !(IORef (IntMap [DelayedMerge]))
114+ }
115+
116+runEventM :: EventM a -> EventEnv -> IO a
117+runEventM = runReaderT . unEventM
118+
119+askToAssignRef :: EventM (IORef [SomeAssignment])
120+askToAssignRef = EventM $ asks eventEnvAssignments
121+
122+askHoldInitRef :: EventM (IORef [SomeHoldInit])
123+askHoldInitRef = EventM $ asks eventEnvHoldInits
124+
125+getCurrentHeight :: EventM Int
126+getCurrentHeight = EventM $ do
127+ heightRef <- asks eventEnvCurrentHeight
128+ liftIO $ readIORef heightRef
129+
130+putCurrentHeight :: Int -> EventM ()
131+putCurrentHeight h = EventM $ do
132+ heightRef <- asks eventEnvCurrentHeight
133+ liftIO $ writeIORef heightRef h
134+
135+scheduleClear :: IORef (Maybe a) -> EventM ()
136+scheduleClear r = EventM $ do
137+ clears <- asks eventEnvClears
138+ liftIO $ modifyIORef' clears (SomeMaybeIORef r :)
139+
140+scheduleMerge :: Int -> MergeSubscribed a -> EventM ()
141+scheduleMerge height subscribed = EventM $ do
142+ delayedRef <- asks eventEnvDelayedMerges
143+ liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) height [DelayedMerge subscribed]
144+
145+emitCoincidenceInfo :: SomeCoincidenceInfo -> EventM ()
146+emitCoincidenceInfo sci = EventM $ do
147+ ciRef <- asks eventEnvCoincidenceInfos
148+ liftIO $ modifyIORef' ciRef (sci:)
149+
150+-- Note: hold cannot examine its event until after the phase is over
151+hold :: a -> Event a -> EventM (Behavior a)
152+hold v0 e = do
153+ holdInitRef <- askHoldInitRef
154+ liftIO $ do
155+ valRef <- newIORef v0
156+ invsRef <- newIORef []
157+ parentRef <- newIORef $ error "hold not yet initialized (parent)"
158+ subscriberRef <- newIORef $ error "hold not yet initialized (subscriber)"
159+ let h = Hold
160+ { holdValue = valRef
161+ , holdInvalidators = invsRef
162+ , holdSubscriber = subscriberRef
163+ , holdParent = parentRef
164+#ifdef DEBUG_NODEIDS
165+ , holdNodeId = unsafeNodeId (v0, e)
166+#endif
167+ }
168+ s <- newSubscriberHold h
169+ writeIORef subscriberRef $ unsafeCoerce s
170+ modifyIORef' holdInitRef (SomeHoldInit e h :)
171+ return $ BehaviorHold h
172+
173+subscribeHold :: Event a -> Hold a -> EventM ()
174+subscribeHold e h = do
175+ toAssignRef <- askToAssignRef
176+ !s <- liftIO $ liftM unsafeCoerce $ readIORef $ holdSubscriber h -- This must be performed strictly so that the weak pointer points at the actual item
177+ ws <- liftIO $ mkWeakPtrWithDebug s "holdSubscriber"
178+ subd <- subscribe e $ WeakSubscriberSimple ws
179+ liftIO $ writeIORef (holdParent h) $ unsafeCoerce subd
180+ occ <- liftIO $ getEventSubscribedOcc subd
181+ case occ of
182+ Nothing -> return ()
183+ Just o -> liftIO $ modifyIORef' toAssignRef (SomeAssignment h o :)
184+
185+--type role BehaviorM representational
186+-- BehaviorM can sample behaviors
187+newtype BehaviorM a = BehaviorM { unBehaviorM :: ReaderT (Maybe (Weak Invalidator, IORef [SomeBehaviorSubscribed])) IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
188+
189+data BehaviorSubscribed a
190+ = BehaviorSubscribedHold (Hold a)
191+ | BehaviorSubscribedPull (PullSubscribed a)
192+
193+data SomeBehaviorSubscribed = forall a. SomeBehaviorSubscribed (BehaviorSubscribed a)
194+
195+--type role PullSubscribed representational
196+data PullSubscribed a
197+ = PullSubscribed { pullSubscribedValue :: !a
198+ , pullSubscribedInvalidators :: !(IORef [Weak Invalidator])
199+ , pullSubscribedOwnInvalidator :: !Invalidator
200+ , pullSubscribedParents :: ![SomeBehaviorSubscribed] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
201+ }
202+
203+--type role Pull representational
204+data Pull a
205+ = Pull { pullValue :: !(IORef (Maybe (PullSubscribed a)))
206+ , pullCompute :: !(BehaviorM a)
207+ }
208+
209+data Invalidator
210+ = forall a. InvalidatorPull (Pull a)
211+ | forall a. InvalidatorSwitch (SwitchSubscribed a)
212+
213+data RootSubscribed a
214+ = RootSubscribed { rootSubscribedSubscribers :: !(IORef [WeakSubscriber a])
215+ , rootSubscribedOccurrence :: !(IORef (Maybe a)) -- Alias to rootOccurrence
216+ }
217+
218+data Root a
219+ = Root { rootOccurrence :: !(IORef (Maybe a)) -- The currently-firing occurrence of this event
220+ , rootSubscribed :: !(IORef (Maybe (RootSubscribed a)))
221+ , rootInit :: !(RootTrigger a -> IO (IO ()))
222+ }
223+
224+data SomeHoldInit = forall a. SomeHoldInit (Event a) (Hold a)
225+
226+-- EventM can do everything BehaviorM can, plus create holds
227+newtype EventM a = EventM { unEventM :: ReaderT EventEnv IO a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, 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
228+
229+data PushSubscribed a b
230+ = PushSubscribed { 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)
231+ , pushSubscribedHeight :: !(IORef Int)
232+ , pushSubscribedSubscribers :: !(IORef [WeakSubscriber b])
233+ , pushSubscribedSelf :: !(Subscriber a) -- Hold this in memory to ensure our WeakReferences don't die
234+ , pushSubscribedParent :: !(EventSubscribed a)
235+#ifdef DEBUG_NODEIDS
236+ , pushSubscribedNodeId :: Int
237+#endif
238+ }
239+
240+data Push a b
241+ = Push { pushCompute :: !(a -> EventM (Maybe b)) -- Compute the current firing value; assumes that its parent has been computed
242+ , pushParent :: !(Event a)
243+ , pushSubscribed :: !(IORef (Maybe (PushSubscribed a b))) --TODO: Can we replace this with an unsafePerformIO thunk?
244+ }
245+
246+data MergeSubscribed k
247+ = MergeSubscribed { mergeSubscribedOccurrence :: !(IORef (Maybe (DMap k)))
248+ , mergeSubscribedAccum :: !(IORef (DMap k)) -- This will accumulate occurrences until our height is reached, at which point it will be transferred to mergeSubscribedOccurrence
249+ , mergeSubscribedHeight :: !(IORef Int)
250+ , mergeSubscribedSubscribers :: !(IORef [WeakSubscriber (DMap k)])
251+ , mergeSubscribedSelf :: !Any -- Hold all our Subscribers in memory
252+ , mergeSubscribedParents :: !(DMap (WrapArg EventSubscribed k))
253+#ifdef DEBUG_NODEIDS
254+ , mergeSubscribedNodeId :: Int
255+#endif
256+ }
257+
258+--TODO: DMap sucks; we should really write something better (with a functor for the value as well as the key)
259+data Merge k
260+ = Merge { mergeParents :: !(DMap (WrapArg Event k))
261+ , mergeSubscribed :: !(IORef (Maybe (MergeSubscribed k))) --TODO: Can we replace this with an unsafePerformIO thunk?
262+ }
263+
264+data FanSubscriberKey k a where
265+ FanSubscriberKey :: k a -> FanSubscriberKey k [WeakSubscriber a]
266+
267+instance GEq k => GEq (FanSubscriberKey k) where
268+ geq (FanSubscriberKey a) (FanSubscriberKey b) = case geq a b of
269+ Nothing -> Nothing
270+ Just Refl -> Just Refl
271+
272+instance GCompare k => GCompare (FanSubscriberKey k) where
273+ gcompare (FanSubscriberKey a) (FanSubscriberKey b) = case gcompare a b of
274+ GLT -> GLT
275+ GEQ -> GEQ
276+ GGT -> GGT
277+
278+data FanSubscribed k
279+ = FanSubscribed { fanSubscribedSubscribers :: !(IORef (DMap (FanSubscriberKey k)))
280+ , fanSubscribedParent :: !(EventSubscribed (DMap k))
281+ , fanSubscribedSelf :: {-# NOUNPACK #-} (Subscriber (DMap k))
282+#ifdef DEBUG_NODEIDS
283+ , fanSubscribedNodeId :: Int
284+#endif
285+ }
286+
287+data Fan k
288+ = Fan { fanParent :: !(Event (DMap k))
289+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed k)))
290+ }
291+
292+data SwitchSubscribed a
293+ = SwitchSubscribed { switchSubscribedOccurrence :: !(IORef (Maybe a))
294+ , switchSubscribedHeight :: !(IORef Int)
295+ , switchSubscribedSubscribers :: !(IORef [WeakSubscriber a])
296+ , switchSubscribedSelf :: {-# NOUNPACK #-} (Subscriber a)
297+ , switchSubscribedSelfWeak :: !(IORef (Weak (Subscriber a)))
298+ , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} Invalidator
299+ , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak Invalidator))
300+ , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed])
301+ , switchSubscribedParent :: !(Behavior (Event a))
302+ , switchSubscribedCurrentParent :: !(IORef (EventSubscribed a))
303+#ifdef DEBUG_NODEIDS
304+ , switchSubscribedNodeId :: Int
305+#endif
306+ }
307+
308+data Switch a
309+ = Switch { switchParent :: !(Behavior (Event a))
310+ , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed a)))
311+ }
312+
313+data CoincidenceSubscribed a
314+ = CoincidenceSubscribed { coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
315+ , coincidenceSubscribedSubscribers :: !(IORef [WeakSubscriber a])
316+ , coincidenceSubscribedHeight :: !(IORef Int)
317+ , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber (Event a))
318+ , coincidenceSubscribedOuterParent :: !(EventSubscribed (Event a))
319+ , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed a)))
320+#ifdef DEBUG_NODEIDS
321+ , coincidenceSubscribedNodeId :: Int
322+#endif
323+ }
324+
325+data Coincidence a
326+ = Coincidence { coincidenceParent :: !(Event (Event a))
327+ , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed a)))
328+ }
329+
330+data Box a = Box { unBox :: a }
331+
332+--type WeakSubscriber a = Weak (Subscriber a)
333+data WeakSubscriber a
334+ = forall k. GCompare k => WeakSubscriberMerge !(k a) !(Weak (Box (MergeSubscribed k))) --TODO: Can we inline the GCompare?
335+ | WeakSubscriberSimple !(Weak (Subscriber a))
336+
337+showWeakSubscriberType :: WeakSubscriber a -> String
338+showWeakSubscriberType = \case
339+ WeakSubscriberMerge _ _ -> "WeakSubscriberMerge"
340+ WeakSubscriberSimple _ -> "WeakSubscriberSimple"
341+
342+deRefWeakSubscriber :: WeakSubscriber a -> IO (Maybe (Subscriber a))
343+deRefWeakSubscriber ws = case ws of
344+ WeakSubscriberSimple w -> deRefWeak w
345+ WeakSubscriberMerge k w -> liftM (fmap $ SubscriberMerge k . unBox) $ deRefWeak w
346+
347+data Subscriber a
348+ = forall b. SubscriberPush !(a -> EventM (Maybe b)) (PushSubscribed a b)
349+ | forall k. GCompare k => SubscriberMerge !(k a) (MergeSubscribed k) --TODO: Can we inline the GCompare?
350+ | forall k. (GCompare k, a ~ DMap k) => SubscriberFan (FanSubscribed k)
351+ | SubscriberHold !(Hold a)
352+ | SubscriberSwitch (SwitchSubscribed a)
353+ | forall b. a ~ Event b => SubscriberCoincidenceOuter (CoincidenceSubscribed b)
354+ | SubscriberCoincidenceInner (CoincidenceSubscribed a)
355+
356+showSubscriberType :: Subscriber a -> String
357+showSubscriberType = \case
358+ SubscriberPush _ _ -> "SubscriberPush"
359+ SubscriberMerge _ _ -> "SubscriberMerge"
360+ SubscriberFan _ -> "SubscriberFan"
361+ SubscriberHold _ -> "SubscriberHold"
362+ SubscriberSwitch _ -> "SubscriberSwitch"
363+ SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
364+ SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
365+
366+data Event a
367+ = EventRoot !(Root a)
368+ | EventNever
369+ | forall b. EventPush !(Push b a)
370+ | forall k. (GCompare k, a ~ DMap k) => EventMerge !(Merge k)
371+ | forall k. GCompare k => EventFan !(k a) !(Fan k)
372+ | EventSwitch !(Switch a)
373+ | EventCoincidence !(Coincidence a)
374+
375+showEventType :: Event a -> String
376+showEventType = \case
377+ EventRoot _ -> "EventRoot"
378+ EventNever -> "EventNever"
379+ EventPush _ -> "EventPush"
380+ EventMerge _ -> "EventMerge"
381+ EventFan _ _ -> "EventFan"
382+ EventSwitch _ -> "EventSwitch"
383+ EventCoincidence _ -> "EventCoincidence"
384+
385+data EventSubscribed a
386+ = EventSubscribedRoot {-# NOUNPACK #-} (RootSubscribed a)
387+ | EventSubscribedNever
388+ | forall b. EventSubscribedPush !(PushSubscribed b a)
389+ | forall k. (GCompare k, a ~ DMap k) => EventSubscribedMerge !(MergeSubscribed k)
390+ | forall k. GCompare k => EventSubscribedFan !(k a) !(FanSubscribed k)
391+ | EventSubscribedSwitch !(SwitchSubscribed a)
392+ | EventSubscribedCoincidence !(CoincidenceSubscribed a)
393+
394+-- These function are constructor functions that are marked NOINLINE so they are
395+-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
396+-- so any weak references that are attached to the constructors will have their
397+-- finalizer run. Using the opaque constructor, does not see the
398+-- constructor application, so it behaves like an IORef and cannot be fused away.
399+--
400+-- The result is also evaluated to WHNF, since forcing a thunk invalidates
401+-- the weak pointer to it in some cases.
402+
403+{-# NOINLINE newRootSubscribed #-}
404+newRootSubscribed :: IORef (Maybe a) -> IORef [WeakSubscriber a] -> IO (RootSubscribed a)
405+newRootSubscribed occ subs =
406+ return $! RootSubscribed
407+ { rootSubscribedOccurrence = occ
408+ , rootSubscribedSubscribers = subs
409+ }
410+
411+{-# NOINLINE newSubscriberPush #-}
412+newSubscriberPush :: (a -> EventM (Maybe b)) -> PushSubscribed a b -> IO (Subscriber a)
413+newSubscriberPush compute subd = return $! SubscriberPush compute subd
414+
415+{-# NOINLINE newSubscriberHold #-}
416+newSubscriberHold :: Hold a -> IO (Subscriber a)
417+newSubscriberHold h = return $! SubscriberHold h
418+
419+{-# NOINLINE newSubscriberFan #-}
420+newSubscriberFan :: GCompare k => FanSubscribed k -> IO (Subscriber (DMap k))
421+newSubscriberFan subd = return $! SubscriberFan subd
422+
423+{-# NOINLINE newSubscriberSwitch #-}
424+newSubscriberSwitch :: SwitchSubscribed a -> IO (Subscriber a)
425+newSubscriberSwitch subd = return $! SubscriberSwitch subd
426+
427+{-# NOINLINE newSubscriberCoincidenceOuter #-}
428+newSubscriberCoincidenceOuter :: CoincidenceSubscribed b -> IO (Subscriber (Event b))
429+newSubscriberCoincidenceOuter subd = return $! SubscriberCoincidenceOuter subd
430+
431+{-# NOINLINE newSubscriberCoincidenceInner #-}
432+newSubscriberCoincidenceInner :: CoincidenceSubscribed a -> IO (Subscriber a)
433+newSubscriberCoincidenceInner subd = return $! SubscriberCoincidenceInner subd
434+
435+{-# NOINLINE newInvalidatorSwitch #-}
436+newInvalidatorSwitch :: SwitchSubscribed a -> IO Invalidator
437+newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
438+
439+{-# NOINLINE newInvalidatorPull #-}
440+newInvalidatorPull :: Pull a -> IO Invalidator
441+newInvalidatorPull p = return $! InvalidatorPull p
442+
443+{-# NOINLINE newBox #-}
444+newBox :: a -> IO (Box a)
445+newBox a = return $! Box a
446+
447+--type role Behavior representational
448+data Behavior a
449+ = BehaviorHold !(Hold a)
450+ | BehaviorConst !a
451+ | BehaviorPull !(Pull a)
452+
453+-- ResultM can read behaviors and events
454+type ResultM = EventM
455+
456+{-# NOINLINE unsafeNewIORef #-}
457+unsafeNewIORef :: a -> b -> IORef b
458+unsafeNewIORef _ b = unsafePerformIO $ newIORef b
459+
460+instance Functor Event where
461+ fmap f = push $ return . Just . f
462+
463+instance Functor Behavior where
464+ fmap f = pull . liftM f . readBehaviorTracked
465+
466+{-# NOINLINE push #-} --TODO: If this is helpful, we can get rid of the unsafeNewIORef and use unsafePerformIO directly
467+push :: (a -> EventM (Maybe b)) -> Event a -> Event b
468+push f e = EventPush $ Push
469+ { pushCompute = f
470+ , pushParent = e
471+ , pushSubscribed = unsafeNewIORef (f, e) Nothing --TODO: Does the use of the tuple here create unnecessary overhead?
472+ }
473+{-# RULES "push/push" forall f g e. push f (push g e) = push (maybe (return Nothing) f <=< g) e #-}
474+
475+{-# NOINLINE pull #-}
476+pull :: BehaviorM a -> Behavior a
477+pull a = BehaviorPull $ Pull
478+ { pullCompute = a
479+ , pullValue = unsafeNewIORef a Nothing
480+ }
481+{-# RULES "pull/pull" forall a. pull (readBehaviorTracked (pull a)) = pull a #-}
482+
483+{-# NOINLINE switch #-}
484+switch :: Behavior (Event a) -> Event a
485+switch a = EventSwitch $ Switch
486+ { switchParent = a
487+ , switchSubscribed = unsafeNewIORef a Nothing
488+ }
489+{-# RULES "switch/constB" forall e. switch (BehaviorConst e) = e #-}
490+
491+coincidence :: Event (Event a) -> Event a
492+coincidence a = EventCoincidence $ Coincidence
493+ { coincidenceParent = a
494+ , coincidenceSubscribed = unsafeNewIORef a Nothing
495+ }
496+
497+newRoot :: IO (Root a)
498+newRoot = do
499+ occRef <- newIORef Nothing
500+ subscribedRef <- newIORef Nothing
501+ return $ Root
502+ { rootOccurrence = occRef
503+ , rootSubscribed = subscribedRef
504+ , rootInit = const $ return $ return ()
505+ }
506+
507+propagateAndUpdateSubscribersRef :: IORef [WeakSubscriber a] -> a -> EventM ()
508+propagateAndUpdateSubscribersRef subscribersRef a = do
509+ subscribers <- liftIO $ readIORef subscribersRef
510+ liftIO $ writeIORef subscribersRef []
511+ stillAlive <- propagate a subscribers
512+ liftIO $ modifyIORef' subscribersRef (++stillAlive)
513+
514+-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
515+run :: [DSum RootTrigger] -> ResultM b -> IO b
516+run roots after = do
517+ when debugPropagate $ putStrLn "Running an event frame"
518+ result <- runFrame $ do
519+ forM_ roots $ \(RootTrigger (_, occRef) :=> a) -> do
520+ liftIO $ writeIORef occRef $ Just a
521+ scheduleClear occRef
522+ forM_ roots $ \(RootTrigger (subscribersRef, _) :=> a) -> do
523+ propagateAndUpdateSubscribersRef subscribersRef a
524+ delayedRef <- EventM $ asks eventEnvDelayedMerges
525+ let go = do
526+ delayed <- liftIO $ readIORef delayedRef
527+ case IntMap.minViewWithKey delayed of
528+ Nothing -> return ()
529+ Just ((currentHeight, current), future) -> do
530+ when debugPropagate $ liftIO $ putStrLn $ "Running height " ++ show currentHeight
531+ putCurrentHeight currentHeight
532+ liftIO $ writeIORef delayedRef future
533+ forM_ current $ \d -> case d of
534+ DelayedMerge subscribed -> do
535+ height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
536+ case height `compare` currentHeight of
537+ LT -> error "Somehow a merge's height has been decreased after it was scheduled"
538+ GT -> scheduleMerge height subscribed -- The height has been increased (by a coincidence event; TODO: is this the only way?)
539+ EQ -> do
540+ m <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
541+ liftIO $ writeIORef (mergeSubscribedAccum subscribed) DMap.empty
542+ --TODO: Assert that m is not empty
543+ liftIO $ writeIORef (mergeSubscribedOccurrence subscribed) $ Just m
544+ scheduleClear $ mergeSubscribedOccurrence subscribed
545+ propagateAndUpdateSubscribersRef (mergeSubscribedSubscribers subscribed) m
546+ go
547+ go
548+ putCurrentHeight maxBound
549+ after
550+ when debugPropagate $ putStrLn "Done running an event frame"
551+ return result
552+
553+data SomeMaybeIORef = forall a. SomeMaybeIORef (IORef (Maybe a))
554+
555+data SomeAssignment = forall a. SomeAssignment (Hold a) a
556+
557+data DelayedMerge = forall k. DelayedMerge (MergeSubscribed k)
558+
559+debugFinalize :: Bool
560+debugFinalize = False
561+
562+mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
563+mkWeakPtrWithDebug x debugNote = mkWeakPtr x $
564+ if debugFinalize
565+ then Just $ putStrLn $ "finalizing: " ++ debugNote
566+ else Nothing
567+
568+type WeakList a = [Weak a]
569+
570+--TODO: Is it faster to clean up every time, or to occasionally go through and clean up as needed?
571+traverseAndCleanWeakList_ :: Monad m => (wa -> m (Maybe a)) -> [wa] -> (a -> m ()) -> m [wa]
572+traverseAndCleanWeakList_ deRef ws f = go ws
573+ where go [] = return []
574+ go (h:t) = do
575+ ma <- deRef h
576+ case ma of
577+ Just a -> do
578+ f a
579+ t' <- go t
580+ return $ h : t'
581+ Nothing -> go t
582+
583+-- | Propagate everything at the current height
584+propagate :: a -> [WeakSubscriber a] -> EventM [WeakSubscriber a]
585+propagate a subscribers = do
586+ traverseAndCleanWeakList_ (liftIO . deRefWeakSubscriber) subscribers $ \s -> case s of
587+ SubscriberPush compute subscribed -> do
588+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberPush" <> showNodeId subscribed
589+ occ <- compute a
590+ case occ of
591+ Nothing -> return () -- No need to write a Nothing back into the Ref
592+ Just o -> do
593+ liftIO $ writeIORef (pushSubscribedOccurrence subscribed) occ
594+ scheduleClear $ pushSubscribedOccurrence subscribed
595+ liftIO . writeIORef (pushSubscribedSubscribers subscribed) =<< propagate o =<< liftIO (readIORef (pushSubscribedSubscribers subscribed))
596+ SubscriberMerge k subscribed -> do
597+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberMerge" <> showNodeId subscribed
598+ oldM <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
599+ liftIO $ writeIORef (mergeSubscribedAccum subscribed) $ DMap.insertWith (error "Same key fired multiple times for") k a oldM
600+ when (DMap.null oldM) $ do -- Only schedule the firing once
601+ height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
602+ --TODO: assertions about height
603+ currentHeight <- getCurrentHeight
604+ when (height <= currentHeight) $ error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")"
605+ scheduleMerge height subscribed
606+ SubscriberFan subscribed -> do
607+ subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
608+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
609+ --TODO: We need a better DMap intersection; here, we are assuming that the number of firing keys is small and the number of subscribers is large
610+ forM_ (DMap.toList a) $ \(k :=> v) -> case DMap.lookup (FanSubscriberKey k) subs of
611+ Nothing -> do
612+ when debugPropagate $ liftIO $ putStrLn "No subscriber for key"
613+ return ()
614+ Just subsubs -> do
615+ _ <- propagate v subsubs --TODO: use the value of this
616+ return ()
617+ --TODO: The following is way too slow to do all the time
618+ subs' <- liftIO $ forM (DMap.toList subs) $ ((\(FanSubscriberKey k :=> subsubs) -> do
619+ subsubs' <- traverseAndCleanWeakList_ (liftIO . deRefWeakSubscriber) subsubs (const $ return ())
620+ return $ if null subsubs' then Nothing else Just $ FanSubscriberKey k :=> subsubs') :: DSum (FanSubscriberKey k) -> IO (Maybe (DSum (FanSubscriberKey k))))
621+ liftIO $ writeIORef (fanSubscribedSubscribers subscribed) $ DMap.fromDistinctAscList $ catMaybes subs'
622+ SubscriberHold h -> do
623+ invalidators <- liftIO $ readIORef $ holdInvalidators h
624+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
625+ toAssignRef <- askToAssignRef
626+ liftIO $ modifyIORef' toAssignRef (SomeAssignment h a :)
627+ SubscriberSwitch subscribed -> do
628+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberSwitch" <> showNodeId subscribed
629+ liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
630+ scheduleClear $ switchSubscribedOccurrence subscribed
631+ subs <- liftIO $ readIORef $ switchSubscribedSubscribers subscribed
632+ liftIO . writeIORef (switchSubscribedSubscribers subscribed) =<< propagate a subs
633+ SubscriberCoincidenceOuter subscribed -> do
634+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
635+ outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
636+ when debugPropagate $ liftIO $ putStrLn $ " outerHeight = " <> show outerHeight
637+ (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
638+ when debugPropagate $ liftIO $ putStrLn $ " isJust occ = " <> show (isJust occ)
639+ when debugPropagate $ liftIO $ putStrLn $ " innerHeight = " <> show innerHeight
640+ liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
641+ scheduleClear $ coincidenceSubscribedInnerParent subscribed
642+ case occ of
643+ Nothing -> do
644+ when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
645+ writeIORef (coincidenceSubscribedHeight subscribed) innerHeight
646+ mapM_ invalidateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed)
647+ mapM_ recalculateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed)
648+ Just o -> do -- Since it's already firing, no need to adjust height
649+ liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
650+ scheduleClear $ coincidenceSubscribedOccurrence subscribed
651+ liftIO . writeIORef (coincidenceSubscribedSubscribers subscribed) =<< propagate o =<< liftIO (readIORef (coincidenceSubscribedSubscribers subscribed))
652+ SubscriberCoincidenceInner subscribed -> do
653+ when debugPropagate $ liftIO $ putStrLn $ "SubscriberCoincidenceInner" <> showNodeId subscribed
654+ liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
655+ scheduleClear $ coincidenceSubscribedOccurrence subscribed
656+ liftIO . writeIORef (coincidenceSubscribedSubscribers subscribed) =<< propagate a =<< liftIO (readIORef (coincidenceSubscribedSubscribers subscribed))
657+
658+data SomeCoincidenceInfo = forall a. SomeCoincidenceInfo (Weak (Subscriber a)) (Subscriber a) (Maybe (CoincidenceSubscribed a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
659+
660+subscribeCoincidenceInner :: Event a -> Int -> CoincidenceSubscribed a -> EventM (Maybe a, Int, EventSubscribed a)
661+subscribeCoincidenceInner o outerHeight subscribedUnsafe = do
662+ subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
663+ wsubInner <- liftIO $ mkWeakPtrWithDebug subInner "SubscriberCoincidenceInner"
664+ innerSubd <- {-# SCC "innerSubd" #-} (subscribe o $ WeakSubscriberSimple wsubInner)
665+ innerOcc <- liftIO $ getEventSubscribedOcc innerSubd
666+ innerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef innerSubd
667+ let height = max innerHeight outerHeight
668+ emitCoincidenceInfo $ SomeCoincidenceInfo wsubInner subInner $ if height > outerHeight then Just subscribedUnsafe else Nothing
669+ return (innerOcc, height, innerSubd)
670+
671+readBehavior :: Behavior a -> IO a
672+readBehavior b = runBehaviorM (readBehaviorTracked b) Nothing --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
673+
674+runBehaviorM :: BehaviorM a -> Maybe (Weak Invalidator, IORef [SomeBehaviorSubscribed]) -> IO a
675+runBehaviorM a mwi = runReaderT (unBehaviorM a) mwi
676+
677+askInvalidator :: BehaviorM (Maybe (Weak Invalidator))
678+askInvalidator = liftM (fmap fst) $ BehaviorM ask
679+
680+askParentsRef :: BehaviorM (Maybe (IORef [SomeBehaviorSubscribed]))
681+askParentsRef = liftM (fmap snd) $ BehaviorM ask
682+
683+readBehaviorTracked :: Behavior a -> BehaviorM a
684+readBehaviorTracked b = case b of
685+ BehaviorHold h -> do
686+ result <- liftIO $ readIORef $ holdValue h
687+ askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
688+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
689+ liftIO $ touch $ holdSubscriber h
690+ return result
691+ BehaviorConst a -> return a
692+ BehaviorPull p -> do
693+ val <- liftIO $ readIORef $ pullValue p
694+ case val of
695+ Just subscribed -> do
696+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
697+ askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
698+ liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
699+ return $ pullSubscribedValue subscribed
700+ Nothing -> do
701+ i <- liftIO $ newInvalidatorPull p
702+ wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
703+ parentsRef <- liftIO $ newIORef []
704+ a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) $ Just (wi, parentsRef)
705+ invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
706+ parents <- liftIO $ readIORef parentsRef
707+ let subscribed = PullSubscribed
708+ { pullSubscribedValue = a
709+ , pullSubscribedInvalidators = invsRef
710+ , pullSubscribedOwnInvalidator = i
711+ , pullSubscribedParents = parents
712+ }
713+ liftIO $ writeIORef (pullValue p) $ Just subscribed
714+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
715+ return a
716+
717+readEvent :: Event a -> ResultM (Maybe a)
718+readEvent e = case e of
719+ EventRoot r -> liftIO $ readIORef $ rootOccurrence r
720+ EventNever -> return Nothing
721+ EventPush p -> do
722+ subscribed <- getPushSubscribed p
723+ liftIO $ do
724+ result <- readIORef $ pushSubscribedOccurrence subscribed -- Since ResultM is always called after the final height is reached, this will always be valid
725+ touch $ pushSubscribedSelf subscribed
726+ return result
727+ EventMerge m -> do
728+ subscribed <- getMergeSubscribed m
729+ liftIO $ do
730+ result <- readIORef $ mergeSubscribedOccurrence subscribed
731+ touch $ mergeSubscribedSelf subscribed
732+ return result
733+ EventFan k f -> do
734+ parentOcc <- readEvent $ fanParent f
735+ return $ DMap.lookup k =<< parentOcc
736+ EventSwitch s -> do
737+ subscribed <- getSwitchSubscribed s
738+ liftIO $ do
739+ result <- readIORef $ switchSubscribedOccurrence subscribed
740+ touch $ switchSubscribedSelf subscribed
741+ touch $ switchSubscribedOwnInvalidator subscribed
742+ return result
743+ EventCoincidence c -> do
744+ subscribed <- getCoincidenceSubscribed c
745+ liftIO $ do
746+ result <- readIORef $ coincidenceSubscribedOccurrence subscribed
747+ touch $ coincidenceSubscribedOuter subscribed
748+ --TODO: do we need to touch the inner subscriber?
749+ return result
750+
751+-- Always refers to 0
752+{-# NOINLINE zeroRef #-}
753+zeroRef :: IORef Int
754+zeroRef = unsafePerformIO $ newIORef 0
755+
756+getEventSubscribed :: Event a -> EventM (EventSubscribed a)
757+getEventSubscribed e = case e of
758+ EventRoot r -> liftM EventSubscribedRoot $ getRootSubscribed r
759+ EventNever -> return EventSubscribedNever
760+ EventPush p -> liftM EventSubscribedPush $ getPushSubscribed p
761+ EventFan k f -> liftM (EventSubscribedFan k) $ getFanSubscribed f
762+ EventMerge m -> liftM EventSubscribedMerge $ getMergeSubscribed m
763+ EventSwitch s -> liftM EventSubscribedSwitch $ getSwitchSubscribed s
764+ EventCoincidence c -> liftM EventSubscribedCoincidence $ getCoincidenceSubscribed c
765+
766+debugSubscribe :: Bool
767+debugSubscribe = False
768+
769+subscribeEventSubscribed :: EventSubscribed a -> WeakSubscriber a -> IO ()
770+subscribeEventSubscribed es ws = case es of
771+ EventSubscribedRoot r -> do
772+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Root"
773+ modifyIORef' (rootSubscribedSubscribers r) (ws:)
774+ EventSubscribedNever -> do
775+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Never"
776+ return ()
777+ EventSubscribedPush subscribed -> do
778+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Push"
779+ modifyIORef' (pushSubscribedSubscribers subscribed) (ws:)
780+ EventSubscribedFan k subscribed -> do
781+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Fan"
782+ modifyIORef' (fanSubscribedSubscribers subscribed) $ DMap.insertWith (++) (FanSubscriberKey k) [ws]
783+ EventSubscribedMerge subscribed -> do
784+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Merge"
785+ modifyIORef' (mergeSubscribedSubscribers subscribed) (ws:)
786+ EventSubscribedSwitch subscribed -> do
787+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Switch"
788+ modifyIORef' (switchSubscribedSubscribers subscribed) (ws:)
789+ EventSubscribedCoincidence subscribed -> do
790+ when debugSubscribe $ liftIO $ putStrLn $ "subscribeEventSubscribed Coincidence"
791+ modifyIORef' (coincidenceSubscribedSubscribers subscribed) (ws:)
792+
793+getEventSubscribedOcc :: EventSubscribed a -> IO (Maybe a)
794+getEventSubscribedOcc es = case es of
795+ EventSubscribedRoot r -> readIORef $ rootSubscribedOccurrence r
796+ EventSubscribedNever -> return Nothing
797+ EventSubscribedPush subscribed -> readIORef $ pushSubscribedOccurrence subscribed
798+ EventSubscribedFan k subscribed -> do
799+ parentOcc <- getEventSubscribedOcc $ fanSubscribedParent subscribed
800+ let occ = DMap.lookup k =<< parentOcc
801+ return occ
802+ EventSubscribedMerge subscribed -> readIORef $ mergeSubscribedOccurrence subscribed
803+ EventSubscribedSwitch subscribed -> readIORef $ switchSubscribedOccurrence subscribed
804+ EventSubscribedCoincidence subscribed -> readIORef $ coincidenceSubscribedOccurrence subscribed
805+
806+eventSubscribedHeightRef :: EventSubscribed a -> IORef Int
807+eventSubscribedHeightRef es = case es of
808+ EventSubscribedRoot _ -> zeroRef
809+ EventSubscribedNever -> zeroRef
810+ EventSubscribedPush subscribed -> pushSubscribedHeight subscribed
811+ EventSubscribedFan _ subscribed -> eventSubscribedHeightRef $ fanSubscribedParent subscribed
812+ EventSubscribedMerge subscribed -> mergeSubscribedHeight subscribed
813+ EventSubscribedSwitch subscribed -> switchSubscribedHeight subscribed
814+ EventSubscribedCoincidence subscribed -> coincidenceSubscribedHeight subscribed
815+
816+subscribe :: Event a -> WeakSubscriber a -> EventM (EventSubscribed a)
817+subscribe e ws = do
818+ subd <- getEventSubscribed e
819+ liftIO $ subscribeEventSubscribed subd ws
820+ return subd
821+
822+noinlineFalse :: Bool
823+noinlineFalse = False
824+{-# NOINLINE noinlineFalse #-}
825+
826+getRootSubscribed :: Root a -> EventM (RootSubscribed a)
827+getRootSubscribed r = do
828+ mSubscribed <- liftIO $ readIORef $ rootSubscribed r
829+ case mSubscribed of
830+ Just subscribed -> return subscribed
831+ Nothing -> liftIO $ do
832+ subscribersRef <- newIORef []
833+ subscribed <- newRootSubscribed (rootOccurrence r) subscribersRef
834+ -- Strangely, init needs the same stuff as a RootSubscribed has, but it must not be the same as the one that everyone's subscribing to, or it'll leak memory
835+ uninit <- rootInit r $ RootTrigger (subscribersRef, rootOccurrence r)
836+ addFinalizer subscribed $ do
837+ when noinlineFalse $ putStr "" -- For some reason, without this line, the finalizer will run earlier than it should
838+-- putStrLn "Uninit root"
839+ uninit
840+ liftIO $ writeIORef (rootSubscribed r) $ Just subscribed
841+ return subscribed
842+
843+-- When getPushSubscribed returns, the PushSubscribed returned will have a fully filled-in
844+getPushSubscribed :: Push a b -> EventM (PushSubscribed a b)
845+getPushSubscribed p = do
846+ mSubscribed <- liftIO $ readIORef $ pushSubscribed p
847+ case mSubscribed of
848+ Just subscribed -> return subscribed
849+ Nothing -> do -- Not yet subscribed
850+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ liftM fromJust $ readIORef $ pushSubscribed p
851+ s <- liftIO $ newSubscriberPush (pushCompute p) subscribedUnsafe
852+ ws <- liftIO $ mkWeakPtrWithDebug s "SubscriberPush"
853+ subd <- subscribe (pushParent p) $ WeakSubscriberSimple ws
854+ parentOcc <- liftIO $ getEventSubscribedOcc subd
855+ occ <- liftM join $ mapM (pushCompute p) parentOcc
856+ occRef <- liftIO $ newIORef occ
857+ when (isJust occ) $ scheduleClear occRef
858+ subscribersRef <- liftIO $ newIORef []
859+ let subscribed = PushSubscribed
860+ { pushSubscribedOccurrence = occRef
861+ , pushSubscribedHeight = eventSubscribedHeightRef subd -- Since pushes have the same height as their parents, share the ref
862+ , pushSubscribedSubscribers = subscribersRef
863+ , pushSubscribedSelf = unsafeCoerce s
864+ , pushSubscribedParent = subd
865+#ifdef DEBUG_NODEIDS
866+ , pushSubscribedNodeId = unsafeNodeId p
867+#endif
868+ }
869+ liftIO $ writeIORef (pushSubscribed p) $ Just subscribed
870+ return subscribed
871+
872+getMergeSubscribed :: forall k. GCompare k => Merge k -> EventM (MergeSubscribed k)
873+getMergeSubscribed m = {-# SCC "getMergeSubscribed.entire" #-} do
874+ mSubscribed <- liftIO $ readIORef $ mergeSubscribed m
875+ case mSubscribed of
876+ Just subscribed -> return subscribed
877+ Nothing -> if DMap.null $ mergeParents m then emptyMergeSubscribed else do
878+ subscribedRef <- liftIO $ newIORef $ error "getMergeSubscribed: subscribedRef not yet initialized"
879+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
880+ s <- liftIO $ newBox subscribedUnsafe
881+ ws <- liftIO $ mkWeakPtrWithDebug s "SubscriberMerge"
882+ subscribers :: [(Any, Maybe (DSum k), Int, DSum (WrapArg EventSubscribed k))] <- forM (DMap.toList $ mergeParents m) $ {-# SCC "getMergeSubscribed.a" #-} \(WrapArg k :=> e) -> {-# SCC "getMergeSubscribed.a1" #-} do
883+ parentSubd <- {-# SCC "getMergeSubscribed.a.parentSubd" #-} subscribe e $ WeakSubscriberMerge k ws
884+ parentOcc <- {-# SCC "getMergeSubscribed.a.parentOcc" #-} liftIO $ getEventSubscribedOcc parentSubd
885+ height <- {-# SCC "getMergeSubscribed.a.height" #-} liftIO $ readIORef $ eventSubscribedHeightRef parentSubd
886+ return $ {-# SCC "getMergeSubscribed.a.returnVal" #-} (unsafeCoerce s :: Any, fmap (k :=>) parentOcc, height, WrapArg k :=> parentSubd)
887+ let dm = DMap.fromDistinctAscList $ catMaybes $ map (\(_, x, _, _) -> x) subscribers
888+ subscriberHeights = map (\(_, _, x, _) -> x) subscribers
889+ myHeight =
890+ if any (==invalidHeight) subscriberHeights --TODO: Replace 'any' with invalidHeight-preserving 'maximum'
891+ then invalidHeight
892+ else succ $ Prelude.maximum subscriberHeights -- This is safe because the DMap will never be empty here
893+ currentHeight <- getCurrentHeight
894+ let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
895+ then (if DMap.null dm then Nothing else Just dm, DMap.empty)
896+ else (Nothing, dm)
897+ when (not $ DMap.null accum) $ do
898+ scheduleMerge myHeight subscribedUnsafe
899+ occRef <- liftIO $ newIORef occ
900+ when (isJust occ) $ scheduleClear occRef
901+ accumRef <- liftIO $ newIORef accum
902+ heightRef <- liftIO $ newIORef myHeight
903+ subsRef <- liftIO $ newIORef []
904+ let subscribed = MergeSubscribed
905+ { mergeSubscribedOccurrence = occRef
906+ , mergeSubscribedAccum = accumRef
907+ , mergeSubscribedHeight = heightRef
908+ , mergeSubscribedSubscribers = subsRef
909+ , mergeSubscribedSelf = unsafeCoerce $ map (\(x, _, _, _) -> x) subscribers --TODO: Does lack of strictness make this leak?
910+ , mergeSubscribedParents = DMap.fromDistinctAscList $ map (\(_, _, _, x) -> x) subscribers
911+#ifdef DEBUG_NODEIDS
912+ , mergeSubscribedNodeId = unsafeNodeId m
913+#endif
914+ }
915+ liftIO $ writeIORef subscribedRef subscribed
916+ return subscribed
917+ where emptyMergeSubscribed = do --TODO: This should never happen
918+ occRef <- liftIO $ newIORef Nothing
919+ accumRef <- liftIO $ newIORef DMap.empty
920+ subsRef <- liftIO $ newIORef []
921+ return $ MergeSubscribed
922+ { mergeSubscribedOccurrence = occRef
923+ , mergeSubscribedAccum = accumRef
924+ , mergeSubscribedHeight = zeroRef
925+ , mergeSubscribedSubscribers = subsRef --TODO: This will definitely leak
926+ , mergeSubscribedSelf = unsafeCoerce ()
927+ , mergeSubscribedParents = DMap.empty
928+#ifdef DEBUG_NODEIDS
929+ , mergeSubscribedNodeId = -1
930+#endif
931+ }
932+
933+getFanSubscribed :: GCompare k => Fan k -> EventM (FanSubscribed k)
934+getFanSubscribed f = do
935+ mSubscribed <- liftIO $ readIORef $ fanSubscribed f
936+ case mSubscribed of
937+ Just subscribed -> return subscribed
938+ Nothing -> do
939+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ liftM fromJust $ readIORef $ fanSubscribed f
940+ sub <- liftIO $ newSubscriberFan subscribedUnsafe
941+ wsub <- liftIO $ mkWeakPtrWithDebug sub "SubscriberFan"
942+ subd <- subscribe (fanParent f) $ WeakSubscriberSimple wsub
943+ subscribersRef <- liftIO $ newIORef DMap.empty
944+ let subscribed = FanSubscribed
945+ { fanSubscribedParent = subd
946+ , fanSubscribedSubscribers = subscribersRef
947+ , fanSubscribedSelf = sub
948+#ifdef DEBUG_NODEIDS
949+ , fanSubscribedNodeId = unsafeNodeId f
950+#endif
951+ }
952+ liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
953+ return subscribed
954+
955+getSwitchSubscribed :: Switch a -> EventM (SwitchSubscribed a)
956+getSwitchSubscribed s = do
957+ mSubscribed <- liftIO $ readIORef $ switchSubscribed s
958+ case mSubscribed of
959+ Just subscribed -> return subscribed
960+ Nothing -> do
961+ subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
962+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
963+ i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
964+ sub <- liftIO $ newSubscriberSwitch subscribedUnsafe
965+ wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
966+ wiRef <- liftIO $ newIORef wi
967+ wsub <- liftIO $ mkWeakPtrWithDebug sub "SubscriberSwitch"
968+ selfWeakRef <- liftIO $ newIORef wsub
969+ parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
970+ e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) $ Just (wi, parentsRef)
971+ subd <- subscribe e $ WeakSubscriberSimple wsub
972+ subdRef <- liftIO $ newIORef subd
973+ parentOcc <- liftIO $ getEventSubscribedOcc subd
974+ occRef <- liftIO $ newIORef parentOcc
975+ when (isJust parentOcc) $ scheduleClear occRef
976+ heightRef <- liftIO $ newIORef =<< readIORef (eventSubscribedHeightRef subd)
977+ subscribersRef <- liftIO $ newIORef []
978+ let subscribed = SwitchSubscribed
979+ { switchSubscribedOccurrence = occRef
980+ , switchSubscribedHeight = heightRef
981+ , switchSubscribedSubscribers = subscribersRef
982+ , switchSubscribedSelf = sub
983+ , switchSubscribedSelfWeak = selfWeakRef
984+ , switchSubscribedOwnInvalidator = i
985+ , switchSubscribedOwnWeakInvalidator = wiRef
986+ , switchSubscribedBehaviorParents = parentsRef
987+ , switchSubscribedParent = switchParent s
988+ , switchSubscribedCurrentParent = subdRef
989+#ifdef DEBUG_NODEIDS
990+ , switchSubscribedNodeId = unsafeNodeId s
991+#endif
992+ }
993+ liftIO $ writeIORef subscribedRef subscribed
994+ liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
995+ return subscribed
996+
997+getCoincidenceSubscribed :: forall a. Coincidence a -> EventM (CoincidenceSubscribed a)
998+getCoincidenceSubscribed c = do
999+ mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1000+ case mSubscribed of
1001+ Just subscribed -> return subscribed
1002+ Nothing -> do
1003+ subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1004+ subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1005+ subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1006+ wsubOuter <- liftIO $ mkWeakPtrWithDebug subOuter "subOuter"
1007+ outerSubd <- subscribe (coincidenceParent c) $ WeakSubscriberSimple wsubOuter
1008+ outerOcc <- liftIO $ getEventSubscribedOcc outerSubd
1009+ outerHeight <- liftIO $ readIORef $ eventSubscribedHeightRef outerSubd
1010+ (occ, height, mInnerSubd) <- case outerOcc of
1011+ Nothing -> return (Nothing, outerHeight, Nothing)
1012+ Just o -> do
1013+ (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1014+ return (occ, height, Just innerSubd)
1015+ occRef <- liftIO $ newIORef occ
1016+ when (isJust occ) $ scheduleClear occRef
1017+ heightRef <- liftIO $ newIORef height
1018+ innerSubdRef <- liftIO $ newIORef mInnerSubd
1019+ scheduleClear innerSubdRef
1020+ subscribersRef <- liftIO $ newIORef []
1021+ let subscribed = CoincidenceSubscribed
1022+ { coincidenceSubscribedOccurrence = occRef
1023+ , coincidenceSubscribedHeight = heightRef
1024+ , coincidenceSubscribedSubscribers = subscribersRef
1025+ , coincidenceSubscribedOuter = subOuter
1026+ , coincidenceSubscribedOuterParent = outerSubd
1027+ , coincidenceSubscribedInnerParent = innerSubdRef
1028+#ifdef DEBUG_NODEIDS
1029+ , coincidenceSubscribedNodeId = unsafeNodeId c
1030+#endif
1031+ }
1032+ liftIO $ writeIORef subscribedRef subscribed
1033+ liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1034+ return subscribed
1035+
1036+merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
1037+merge m = EventMerge $ Merge
1038+ { mergeParents = m
1039+ , mergeSubscribed = unsafeNewIORef m Nothing
1040+ }
1041+
1042+newtype EventSelector k = EventSelector { select :: forall a. k a -> Event a }
1043+
1044+fan :: GCompare k => Event (DMap k) -> EventSelector k
1045+fan e =
1046+ let f = Fan
1047+ { fanParent = e
1048+ , fanSubscribed = unsafeNewIORef e Nothing
1049+ }
1050+ in EventSelector $ \k -> EventFan k f
1051+
1052+-- | Run an event action outside of a frame
1053+runFrame :: EventM a -> IO a
1054+runFrame a = do
1055+ toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1056+ holdInitRef <- newIORef []
1057+ heightRef <- newIORef 0
1058+ toClearRef <- newIORef []
1059+ coincidenceInfosRef <- newIORef []
1060+ delayedRef <- liftIO $ newIORef IntMap.empty
1061+ result <- flip runEventM (EventEnv toAssignRef holdInitRef toClearRef heightRef coincidenceInfosRef delayedRef) $ do
1062+ result <- a
1063+ let runHoldInits = do
1064+ holdInits <- liftIO $ readIORef holdInitRef
1065+ if null holdInits then return () else do
1066+ liftIO $ writeIORef holdInitRef []
1067+ forM_ holdInits $ \(SomeHoldInit e h) -> subscribeHold e h
1068+ runHoldInits
1069+ runHoldInits -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
1070+ return result
1071+ toClear <- readIORef toClearRef
1072+ forM_ toClear $ \(SomeMaybeIORef ref) -> writeIORef ref Nothing
1073+ toAssign <- readIORef toAssignRef
1074+ toReconnectRef <- newIORef []
1075+ forM_ toAssign $ \(SomeAssignment h v) -> do
1076+ writeIORef (holdValue h) v
1077+ writeIORef (holdInvalidators h) =<< invalidate toReconnectRef =<< readIORef (holdInvalidators h)
1078+ coincidenceInfos <- readIORef coincidenceInfosRef
1079+ forM_ coincidenceInfos $ \(SomeCoincidenceInfo wsubInner subInner mcs) -> do
1080+ touch subInner
1081+ finalize wsubInner
1082+ mapM_ invalidateCoincidenceHeight mcs
1083+ toReconnect <- readIORef toReconnectRef
1084+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1085+ wsub <- readIORef $ switchSubscribedSelfWeak subscribed
1086+ finalize wsub
1087+ wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1088+ finalize wi
1089+ let !i = switchSubscribedOwnInvalidator subscribed
1090+ wi' <- mkWeakPtrWithDebug i "wi'"
1091+ writeIORef (switchSubscribedBehaviorParents subscribed) []
1092+ e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed))
1093+ --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1094+ let !sub = switchSubscribedSelf subscribed -- Must be done strictly, or the weak pointer will refer to a useless thunk
1095+ wsub' <- mkWeakPtrWithDebug sub "wsub'"
1096+ writeIORef (switchSubscribedSelfWeak subscribed) wsub'
1097+ subd' <- runFrame $ subscribe e $ WeakSubscriberSimple wsub' --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
1098+ {-
1099+ stackTrace <- liftIO $ liftM renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1100+ liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1101+ EventRoot _ -> "EventRoot"
1102+ EventNever -> "EventNever"
1103+ _ -> "something else"
1104+ -}
1105+ writeIORef (switchSubscribedCurrentParent subscribed) subd'
1106+ parentHeight <- readIORef $ eventSubscribedHeightRef subd'
1107+ myHeight <- readIORef $ switchSubscribedHeight subscribed
1108+ if parentHeight == myHeight then return () else do
1109+ writeIORef (switchSubscribedHeight subscribed) parentHeight
1110+ mapM_ invalidateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1111+ forM_ coincidenceInfos $ \(SomeCoincidenceInfo _ _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
1112+ forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1113+ mapM_ recalculateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1114+ return result
1115+
1116+invalidHeight :: Int
1117+invalidHeight = -1000
1118+
1119+invalidateSubscriberHeight :: WeakSubscriber a -> IO ()
1120+invalidateSubscriberHeight ws = do
1121+ ms <- deRefWeakSubscriber ws
1122+ case ms of
1123+ Nothing -> return () --TODO: cleanup?
1124+ Just s -> case s of
1125+ SubscriberPush _ subscribed -> do
1126+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1127+ mapM_ invalidateSubscriberHeight =<< readIORef (pushSubscribedSubscribers subscribed)
1128+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1129+ SubscriberMerge _ subscribed -> do
1130+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1131+ oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1132+ when (oldHeight /= invalidHeight) $ do
1133+ writeIORef (mergeSubscribedHeight subscribed) $ invalidHeight
1134+ mapM_ invalidateSubscriberHeight =<< readIORef (mergeSubscribedSubscribers subscribed)
1135+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1136+ SubscriberFan subscribed -> do
1137+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1138+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1139+ forM_ (DMap.toList subscribers) $ ((\(FanSubscriberKey _ :=> v) -> mapM_ invalidateSubscriberHeight v) :: DSum (FanSubscriberKey k) -> IO ())
1140+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1141+ SubscriberHold _ -> return ()
1142+ SubscriberSwitch subscribed -> do
1143+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1144+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1145+ when (oldHeight /= invalidHeight) $ do
1146+ writeIORef (switchSubscribedHeight subscribed) $ invalidHeight
1147+ mapM_ invalidateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1148+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1149+ SubscriberCoincidenceOuter subscribed -> do
1150+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1151+ invalidateCoincidenceHeight subscribed
1152+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1153+ SubscriberCoincidenceInner subscribed -> do
1154+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1155+ invalidateCoincidenceHeight subscribed
1156+ when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1157+
1158+invalidateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
1159+invalidateCoincidenceHeight subscribed = do
1160+ oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1161+ when (oldHeight /= invalidHeight) $ do
1162+ writeIORef (coincidenceSubscribedHeight subscribed) $ invalidHeight
1163+ mapM_ invalidateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed)
1164+
1165+--TODO: The recalculation algorithm seems a bit funky; make sure it doesn't miss stuff or hit stuff twice; also, it should probably be lazy
1166+
1167+recalculateSubscriberHeight :: WeakSubscriber a -> IO ()
1168+recalculateSubscriberHeight ws = do
1169+ ms <- deRefWeakSubscriber ws
1170+ case ms of
1171+ Nothing -> return () --TODO: cleanup?
1172+ Just s -> case s of
1173+ SubscriberPush _ subscribed -> do
1174+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
1175+ mapM_ recalculateSubscriberHeight =<< readIORef (pushSubscribedSubscribers subscribed)
1176+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
1177+ SubscriberMerge _ subscribed -> do
1178+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
1179+ oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1180+ when (oldHeight == invalidHeight) $ do
1181+ height <- calculateMergeHeight subscribed
1182+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1183+ when (height /= invalidHeight) $ do -- If height == invalidHeight, that means some of the prereqs have not yet been recomputed; when they do recompute, they'll catch this node again --TODO: this is O(n*m), where n is the number of children of this noe and m is the number that have been invalidated
1184+ writeIORef (mergeSubscribedHeight subscribed) height
1185+ mapM_ recalculateSubscriberHeight =<< readIORef (mergeSubscribedSubscribers subscribed)
1186+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
1187+ SubscriberFan subscribed -> do
1188+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
1189+ subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1190+ forM_ (DMap.toList subscribers) $ ((\(FanSubscriberKey _ :=> v) -> mapM_ recalculateSubscriberHeight v) :: DSum (FanSubscriberKey k) -> IO ())
1191+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
1192+ SubscriberHold _ -> return ()
1193+ SubscriberSwitch subscribed -> do
1194+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
1195+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1196+ when (oldHeight == invalidHeight) $ do
1197+ height <- calculateSwitchHeight subscribed
1198+ when (height /= invalidHeight) $ do
1199+ writeIORef (switchSubscribedHeight subscribed) height
1200+ mapM_ recalculateSubscriberHeight =<< readIORef (switchSubscribedSubscribers subscribed)
1201+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
1202+ SubscriberCoincidenceOuter subscribed -> do
1203+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
1204+ void $ recalculateCoincidenceHeight subscribed
1205+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
1206+ SubscriberCoincidenceInner subscribed -> do
1207+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
1208+ void $ recalculateCoincidenceHeight subscribed
1209+ when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
1210+
1211+recalculateCoincidenceHeight :: CoincidenceSubscribed a -> IO ()
1212+recalculateCoincidenceHeight subscribed = do
1213+ oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1214+ when (oldHeight == invalidHeight) $ do
1215+ height <- calculateCoincidenceHeight subscribed
1216+ when (height /= invalidHeight) $ do
1217+ writeIORef (coincidenceSubscribedHeight subscribed) height
1218+ mapM_ recalculateSubscriberHeight =<< readIORef (coincidenceSubscribedSubscribers subscribed) --TODO: This should probably be mandatory, just like with the merge and switch ones
1219+
1220+calculateMergeHeight :: MergeSubscribed k -> IO Int
1221+calculateMergeHeight subscribed = if DMap.null (mergeSubscribedParents subscribed) then return 0 else do
1222+ heights <- forM (DMap.toList $ mergeSubscribedParents subscribed) $ \(WrapArg _ :=> es) -> do
1223+ readIORef $ eventSubscribedHeightRef es
1224+ return $ if any (== invalidHeight) heights then invalidHeight else succ $ Prelude.maximum heights --TODO: Replace 'any' with invalidHeight-preserving 'maximum'
1225+
1226+calculateSwitchHeight :: SwitchSubscribed a -> IO Int
1227+calculateSwitchHeight subscribed = readIORef . eventSubscribedHeightRef =<< readIORef (switchSubscribedCurrentParent subscribed)
1228+
1229+calculateCoincidenceHeight :: CoincidenceSubscribed a -> IO Int
1230+calculateCoincidenceHeight subscribed = do
1231+ outerHeight <- readIORef $ eventSubscribedHeightRef $ coincidenceSubscribedOuterParent subscribed
1232+ innerHeight <- maybe (return 0) (readIORef . eventSubscribedHeightRef) =<< readIORef (coincidenceSubscribedInnerParent subscribed)
1233+ return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
1234+
1235+{-
1236+recalculateEventSubscribedHeight :: EventSubscribed a -> IO Int
1237+recalculateEventSubscribedHeight es = case es of
1238+ EventSubscribedRoot _ -> return 0
1239+ EventSubscribedNever -> return 0
1240+ EventSubscribedPush subscribed -> recalculateEventSubscribedHeight $ pushSubscribedParent subscribed
1241+ EventSubscribedMerge subscribed -> do
1242+ oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1243+ if oldHeight /= invalidHeight then return oldHeight else do
1244+ height <- calculateMergeHeight subscribed
1245+ writeIORef (mergeSubscribedHeight subscribed) height
1246+ return height
1247+ EventSubscribedFan _ subscribed -> recalculateEventSubscribedHeight $ fanSubscribedParent subscribed
1248+ EventSubscribedSwitch subscribed -> do
1249+ oldHeight <- readIORef $ switchSubscribedHeight subscribed
1250+ if oldHeight /= invalidHeight then return oldHeight else do
1251+ height <- calculateSwitchHeight subscribed
1252+ writeIORef (switchSubscribedHeight subscribed) height
1253+ return height
1254+ EventSubscribedCoincidence subscribed -> recalculateCoincidenceHeight subscribed
1255+-}
1256+
1257+data SomeSwitchSubscribed = forall a. SomeSwitchSubscribed (SwitchSubscribed a)
1258+
1259+debugInvalidate :: Bool
1260+debugInvalidate = False
1261+
1262+invalidate :: IORef [SomeSwitchSubscribed] -> WeakList Invalidator -> IO (WeakList Invalidator)
1263+invalidate toReconnectRef wis = do
1264+ forM_ wis $ \wi -> do
1265+ mi <- deRefWeak wi
1266+ case mi of
1267+ Nothing -> do
1268+ when debugInvalidate $ liftIO $ putStrLn "invalidate Dead"
1269+ return () --TODO: Should we clean this up here?
1270+ Just i -> do
1271+ finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
1272+ case i of
1273+ InvalidatorPull p -> do
1274+ when debugInvalidate $ liftIO $ putStrLn "invalidate Pull"
1275+ mVal <- readIORef $ pullValue p
1276+ forM_ mVal $ \val -> do
1277+ writeIORef (pullValue p) Nothing
1278+ writeIORef (pullSubscribedInvalidators val) =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
1279+ InvalidatorSwitch subscribed -> do
1280+ when debugInvalidate $ liftIO $ putStrLn "invalidate Switch"
1281+ modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
1282+ 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
1283+
1284+--------------------------------------------------------------------------------
1285+-- Reflex integration
1286+--------------------------------------------------------------------------------
1287+
1288+data Spider
1289+
1290+instance R.Reflex Spider where
1291+ newtype Behavior Spider a = SpiderBehavior { unSpiderBehavior :: Behavior a }
1292+ newtype Event Spider a = SpiderEvent { unSpiderEvent :: Event a }
1293+ type PullM Spider = BehaviorM
1294+ type PushM Spider = EventM
1295+ {-# INLINE never #-}
1296+ {-# INLINE constant #-}
1297+ never = SpiderEvent EventNever
1298+ constant = SpiderBehavior . BehaviorConst
1299+ push f = SpiderEvent. push f . unSpiderEvent
1300+ pull = SpiderBehavior . pull
1301+ merge = SpiderEvent . merge . (unsafeCoerce :: DMap (WrapArg (R.Event Spider) k) -> DMap (WrapArg Event k))
1302+ fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
1303+ switch = SpiderEvent . switch . (unsafeCoerce :: Behavior (R.Event Spider a) -> Behavior (Event a)) . unSpiderBehavior
1304+ coincidence = SpiderEvent . coincidence . (unsafeCoerce :: Event (R.Event Spider a) -> Event (Event a)) . unSpiderEvent
1305+
1306+instance R.MonadSample Spider SpiderHost where
1307+ {-# INLINE sample #-}
1308+ sample = SpiderHost . readBehavior . unSpiderBehavior
1309+
1310+instance R.MonadHold Spider SpiderHost where
1311+ hold v0 = SpiderHost . liftM SpiderBehavior . runFrame . hold v0 . unSpiderEvent
1312+
1313+instance R.MonadSample Spider BehaviorM where
1314+ {-# INLINE sample #-}
1315+ sample = readBehaviorTracked . unSpiderBehavior
1316+
1317+instance R.MonadSample Spider EventM where
1318+ {-# INLINE sample #-}
1319+ sample = liftIO . readBehavior . unSpiderBehavior
1320+
1321+instance R.MonadHold Spider EventM where
1322+ {-# INLINE hold #-}
1323+ hold v0 e = SpiderBehavior <$> hold v0 (unSpiderEvent e)
1324+
1325+newtype RootTrigger a = RootTrigger (IORef [WeakSubscriber a], IORef (Maybe a))
1326+newtype SpiderEventHandle a = SpiderEventHandle { unEventHandle :: Event a }
1327+
1328+instance R.ReflexHost Spider where
1329+ type EventTrigger Spider = RootTrigger
1330+ type EventHandle Spider = SpiderEventHandle
1331+ type HostFrame Spider = SpiderHostFrame
1332+
1333+instance R.MonadReadEvent Spider ResultM where
1334+ {-# INLINE readEvent #-}
1335+ readEvent = liftM (fmap return) . readEvent . unEventHandle
1336+
1337+instance MonadRef EventM where
1338+ type Ref EventM = Ref IO
1339+ {-# INLINE newRef #-}
1340+ {-# INLINE readRef #-}
1341+ {-# INLINE writeRef #-}
1342+ newRef = liftIO . newRef
1343+ readRef = liftIO . readRef
1344+ writeRef r a = liftIO $ writeRef r a
1345+
1346+instance MonadAtomicRef EventM where
1347+ {-# INLINE atomicModifyRef #-}
1348+ atomicModifyRef r f = liftIO $ atomicModifyRef r f
1349+
1350+newtype SpiderHost a = SpiderHost { runSpiderHost :: IO a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
1351+
1352+newtype SpiderHostFrame a = SpiderHostFrame { runSpiderHostFrame :: EventM a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
1353+
1354+instance R.MonadSample Spider SpiderHostFrame where
1355+ sample = SpiderHostFrame . R.sample --TODO: This can cause problems with laziness, so we should get rid of it if we can
1356+
1357+instance R.MonadHold Spider SpiderHostFrame where
1358+ {-# INLINE hold #-}
1359+ hold v0 e = SpiderHostFrame $ R.hold v0 e
1360+
1361+newEventWithTriggerIO :: (RootTrigger a -> IO (IO ())) -> IO (R.Event Spider a)
1362+newEventWithTriggerIO f = do
1363+ occRef <- newIORef Nothing
1364+ subscribedRef <- newIORef Nothing
1365+ let !r = Root
1366+ { rootOccurrence = occRef
1367+ , rootSubscribed = subscribedRef
1368+ , rootInit = f
1369+ }
1370+ return $ SpiderEvent $ EventRoot r
1371+
1372+instance R.MonadReflexCreateTrigger Spider SpiderHost where
1373+ newEventWithTrigger = SpiderHost . newEventWithTriggerIO
1374+
1375+instance R.MonadReflexCreateTrigger Spider SpiderHostFrame where
1376+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . newEventWithTriggerIO
1377+
1378+instance R.MonadReflexHost Spider SpiderHost where
1379+ fireEventsAndRead es a = SpiderHost $ run es a
1380+ subscribeEvent e = SpiderHost $ do
1381+ _ <- runFrame $ getEventSubscribed $ unSpiderEvent e --TODO: The result of this should actually be used
1382+ return $ SpiderEventHandle (unSpiderEvent e)
1383+ runHostFrame = SpiderHost . runFrame . runSpiderHostFrame
1384+
1385+instance MonadRef SpiderHost where
1386+ type Ref SpiderHost = Ref IO
1387+ newRef = SpiderHost . newRef
1388+ readRef = SpiderHost . readRef
1389+ writeRef r = SpiderHost . writeRef r
1390+
1391+instance MonadAtomicRef SpiderHost where
1392+ atomicModifyRef r = SpiderHost . atomicModifyRef r
1393+
1394+instance MonadRef SpiderHostFrame where
1395+ type Ref SpiderHostFrame = Ref IO
1396+ newRef = SpiderHostFrame . newRef
1397+ readRef = SpiderHostFrame . readRef
1398+ writeRef r = SpiderHostFrame . writeRef r
1399+
1400+instance MonadAtomicRef SpiderHostFrame where
1401+ atomicModifyRef r = SpiderHostFrame . atomicModifyRef r
stylizedeleted−4
@@ -1,4 +0,0 @@
1−#!/usr/bin/env bash
2−set -euo pipefail
3−
4−for x in **/*.hs ; do stylish-haskell -i "$x" ; done
test/Reflex/Pure.hsnew file+46
@@ -0,0 +1,46 @@
1+{- | This module provides a pure implementation of Reflex, which is intended to serve as a reference for the semantics of the Reflex class. All implementations of Reflex should produce the same results as this implementation, although performance and laziness/strictness may differ.
2+-}
3+{-# LANGUAGE TypeFamilies, MultiParamTypeClasses #-}
4+module Reflex.Pure where
5+
6+import Reflex.Class
7+import Data.Functor.Misc
8+
9+import Control.Monad
10+import Data.MemoTrie
11+import qualified Data.Dependent.Map as DMap
12+
13+data Pure t
14+
15+-- | The Enum instance of t must be dense: for all x :: t, there must not exist any y :: t such that pred x < y < x
16+-- The HasTrie instance will be used exclusively to memoize functions of t, not for any of its other capabilities
17+instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
18+ newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
19+ newtype Event (Pure t) a = Event { unEvent :: t -> Maybe a }
20+ type PushM (Pure t) = (->) t
21+ type PullM (Pure t) = (->) t
22+ never = Event $ \_ -> Nothing
23+ constant x = Behavior $ \_ -> x
24+ push f e = Event $ memo $ \t -> unEvent e t >>= \o -> f o t
25+ pull = Behavior . memo
26+ merge events = Event $ memo $ \t ->
27+ let currentOccurrences = unwrapDMapMaybe (($ t) . unEvent) events
28+ in if DMap.null currentOccurrences
29+ then Nothing
30+ else Just currentOccurrences
31+ fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= DMap.lookup k
32+ switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
33+ coincidence e = Event $ memo $ \t -> unEvent e t >>= \o -> unEvent o t
34+
35+instance Ord t => MonadSample (Pure t) ((->) t) where
36+ sample = unBehavior
37+
38+instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
39+ hold initialValue e initialTime = Behavior f
40+ where f = memo $ \sampleTime ->
41+ if sampleTime <= initialTime -- Really, the sampleTime should never be prior to the initialTime, because that would mean the Behavior is being sampled before being created
42+ then initialValue
43+ else let lastTime = pred sampleTime
44+ in case unEvent e lastTime of
45+ Nothing -> f lastTime
46+ Just x -> x
test/Reflex/Test/CrossImpl.hsnew file+221
@@ -0,0 +1,221 @@
1+{-# LANGUAGE TypeFamilies, FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, RankNTypes, GADTs, ScopedTypeVariables, FunctionalDependencies, RecursiveDo, UndecidableInstances, GeneralizedNewtypeDeriving, StandaloneDeriving, EmptyDataDecls, NoMonomorphismRestriction, TypeOperators, DeriveDataTypeable, PackageImports, TemplateHaskell, LambdaCase, BangPatterns, ConstraintKinds #-}
2+module Reflex.Test.CrossImpl (test) where
3+
4+import Prelude hiding (mapM, mapM_, sequence, sequence_, foldl)
5+
6+import Reflex.Class
7+import Reflex.Host.Class
8+import Reflex.Dynamic
9+import qualified Reflex.Spider.Internal as S
10+import qualified Reflex.Pure as P
11+import Control.Monad.Ref
12+
13+import Control.Monad.Identity hiding (mapM, mapM_, forM, forM_, sequence, sequence_)
14+import qualified Data.Set as Set
15+import Data.Map.Strict (Map)
16+import qualified Data.Map.Strict as Map
17+import Control.Arrow (second, (&&&))
18+import Data.Traversable
19+import Data.Foldable
20+import Control.Monad.State.Strict hiding (mapM, mapM_, forM, forM_, sequence, sequence_)
21+import Control.Monad.Writer hiding (mapM, mapM_, forM, forM_, sequence, sequence_)
22+import Data.Dependent.Map (DSum (..))
23+import System.Mem
24+
25+import System.IO.Unsafe
26+
27+mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
28+mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
29+ Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
30+ Just (_, v) -> v
31+
32+mapToPureEvent :: Map Int a -> Event PureReflexDomain a
33+mapToPureEvent m = P.Event $ flip Map.lookup m
34+
35+relevantTestingTimes :: (Map Int a, Map Int b) -> [Int]
36+relevantTestingTimes (b, e) = case Set.minView &&& Set.maxView $ Map.keysSet b `Set.union` Map.keysSet e of
37+ (Just (t0, _), Just (t1, _)) -> [t0..t1+1] -- We need to go to b+1 to see the result of the final event
38+ _ -> [] -- Doesn't actually make much sense
39+
40+type PureReflexDomain = P.Pure Int
41+type TimeM = (->) Int
42+
43+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)
44+testPure builder (b, e) =
45+ let (P.Behavior b', P.Event e') = ($ 0) $ builder (mapToPureBehavior b, mapToPureEvent e)
46+ relevantTimes = relevantTestingTimes (b, e)
47+ e'' = Map.mapMaybe id $ Map.fromList $ map (id &&& e') relevantTimes
48+ b'' = Map.fromList $ map (id &&& b') relevantTimes
49+ in (b'', e'')
50+
51+class MapMSignals a a' t t' | a -> t, a' -> t', a t' -> a', a' t -> a where
52+ mapMSignals :: Monad m => (forall b. Behavior t b -> m (Behavior t' b)) -> (forall b. Event t b -> m (Event t' b)) -> a -> m a'
53+
54+instance MapMSignals (Behavior t a) (Behavior t' a) t t' where
55+ mapMSignals fb _ = fb
56+
57+instance MapMSignals (Event t a) (Event t' a) t t' where
58+ mapMSignals _ fe = fe
59+
60+instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
61+ mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
62+
63+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)
64+testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
65+ (re, reTrigger) <- newEventWithTriggerRef
66+ (rb, rbTrigger) <- newEventWithTriggerRef
67+ b <- runHostFrame $ hold (error "testSpider: No value for input behavior yet") rb
68+ (b', e') <- runHostFrame $ builder (b, re)
69+ e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
70+ let times = relevantTestingTimes (bMap, eMap)
71+ liftIO performGC
72+ outputs <- forM times $ \t -> do
73+ forM_ (Map.lookup t bMap) $ \val -> mapM_ (\ rbt -> fireEvents [rbt :=> val]) =<< readRef rbTrigger
74+ bOutput <- sample b'
75+ eOutput <- liftM join $ forM (Map.lookup t eMap) $ \val -> do
76+ mret <- readRef reTrigger
77+ let firing = case mret of
78+ Just ret -> [ret :=> val]
79+ Nothing -> []
80+ fireEventsAndRead firing $ sequence =<< readEvent e'Handle
81+ liftIO performGC
82+ return (t, (bOutput, eOutput))
83+ return (Map.fromList $ map (second fst) outputs, Map.mapMaybe id $ Map.fromList $ map (second snd) outputs)
84+
85+tracePerf :: Show a => a -> b -> b
86+tracePerf = flip const
87+
88+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 ()
89+testAgreement builder inputs = do
90+ let identityResult = testPure builder inputs
91+ tracePerf "---------" $ return ()
92+ let spiderResult = testSpider builder inputs
93+ tracePerf "---------" $ return ()
94+ if identityResult == spiderResult then putStrLn "Success:" >> print identityResult else do
95+ putStrLn "Failure:"
96+ putStrLn $ "Pure result: " <> show identityResult
97+ putStrLn $ "Spider result: " <> show spiderResult
98+
99+type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
100+
101+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))
102+
103+testCases :: [(String, TestCase)]
104+testCases =
105+ [ (,) "hold" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(_, e) -> do
106+ b' <- hold "123" e
107+ return (b', e)
108+ , (,) "count" $ TestCase (Map.singleton 0 (), Map.fromList [(1, ()), (2, ()), (3, ())]) $ \(_, e) -> do
109+ e' <- liftM updated $ count e
110+ b' <- hold (0 :: Int) e'
111+ return (b', e')
112+ , (,) "onceE-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
113+ e' <- onceE $ leftmost [e, e]
114+ return (b, e')
115+ , (,) "switch-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
116+ let e' = fmap (const e) e
117+ b' <- hold never e'
118+ let e'' = switch b'
119+ return (b, e'')
120+ , (,) "switch-2" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
121+ let e' = flip pushAlways e $ const $ do
122+ let ea = fmap (const "a") e
123+ let eb = fmap (const "b") e
124+ let eab = leftmost [ea, eb]
125+ liftM switch $ hold eab never
126+ e'' = coincidence e'
127+ return (b, e'')
128+ , (,) "switch-3" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
129+ let e' = flip pushAlways e $ const $ do
130+ let ea = fmap (const "a") e
131+ let eb = fmap (const "b") e
132+ let eab = leftmost [ea, eb]
133+ liftM switch $ hold eab (fmap (const e) e)
134+ e'' = coincidence e'
135+ return (b, e'')
136+ , (,) "switch-4" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
137+ let e' = leftmost [e, e]
138+ e'' <- liftM switch $ hold e' (fmap (const e) e)
139+ return (b, e'')
140+ , (,) "switchPromptly-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
141+ let e' = fmap (const e) e
142+ e'' <- switchPromptly never e'
143+ return (b, e'')
144+ , (,) "switchPromptly-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
145+ let e' = fmap (const e) e
146+ e'' <- switchPromptly never $ leftmost [e', e']
147+ return (b, e'')
148+ , (,) "switchPromptly-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
149+ let e' = leftmost [e, e]
150+ e'' <- switchPromptly never (fmap (const e) e')
151+ return (b, e'')
152+ , (,) "switchPromptly-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
153+ let e' = leftmost [e, e]
154+ e'' <- switchPromptly never (fmap (const e') e)
155+ return (b, e'')
156+ , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
157+ let e' = leftmost [e, e]
158+ e'' <- liftM switch $ hold never (fmap (const e') e)
159+ return (b, e'')
160+ , (,) "switchPromptly-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
161+ let e' = flip push e $ \_ -> do
162+ return . Just =<< onceE e
163+ e'' <- switchPromptly never e'
164+ return (b, e'')
165+ , (,) "switchPromptly-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
166+ let e' = flip pushAlways e $ \_ -> do
167+ switchPromptly e never
168+ e'' <- switchPromptly never e'
169+ return (b, e'')
170+ , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
171+ let e' = flip pushAlways e $ \_ -> return $ fmap id e
172+ e'' = coincidence e'
173+ return (b, e'')
174+ , (,) "coincidence-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175+ let e' = flip pushAlways e $ \_ -> return $ leftmost [e, e]
176+ e'' = coincidence e'
177+ return (b, e'')
178+ , (,) "coincidence-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
179+ let e' = flip pushAlways e $ \_ -> return $ coincidence $ fmap (const e) e
180+ e'' = coincidence e'
181+ return (b, e'')
182+ , (,) "coincidence-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
183+ let e' = flip pushAlways e $ \_ -> onceE e
184+ e'' = coincidence e'
185+ return (b, e'')
186+ , (,) "coincidence-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer")]) $ \(b, e) -> do
187+ let eChild = flip pushAlways e $ const $ do
188+ let eNewValues = leftmost [e, e]
189+ return $ coincidence $ fmap (const eNewValues) eNewValues
190+ e' = coincidence eChild
191+ return (b, e')
192+ , (,) "coincidence-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer")]) $ \(b, e) -> do
193+ let eChild = flip pushAlways e $ const $ do
194+ let e' = coincidence $ fmap (const e) e
195+ return $ leftmost [e', e']
196+ e'' = coincidence eChild
197+ return (b, e'')
198+ , (,) "coincidence-7" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
199+ let e' = leftmost [e, e]
200+ eCoincidences = coincidence $ fmap (const e') e
201+ return (b, eCoincidences)
202+ , (,) "holdWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
203+ eo <- onceE e
204+ bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
205+ let b' = pull $ sample =<< sample bb
206+ return (b', e)
207+ , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
208+ bb <- hold "b" e
209+ bd <- hold never . fmap (const e) =<< onceE e
210+ eOuter <- liftM (pushAlways sample . fmap (const bb)) $ onceE e
211+ let eInner = switch bd
212+ e' = leftmost [eOuter, eInner]
213+ return (b, e')
214+ ]
215+
216+test :: IO ()
217+test = do
218+ forM_ testCases $ \(name, TestCase inputs builder) -> do
219+ putStrLn $ "Test: " <> name
220+ testAgreement builder inputs
221+ return ()
test/hlint.hsdeleted−39
@@ -1,39 +0,0 @@
1−module Main where
2−
3−import Control.Monad
4−import Language.Haskell.HLint (hlint)
5−import System.Directory
6−import System.Exit (exitFailure, exitSuccess)
7−import System.FilePath
8−import System.FilePath.Find
9−
10−main :: IO ()
11−main = do
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
39− if null ideas then exitSuccess else exitFailure
test/tests.hsdeleted−43
@@ -1,43 +0,0 @@
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