@@ -1,223 +1,108 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
32{-# LANGUAGE FlexibleContexts #-}
43{-# LANGUAGE FlexibleInstances #-}
54{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE InstanceSigs #-}
75{-# LANGUAGE LambdaCase #-}
86{-# LANGUAGE MultiParamTypeClasses #-}
97{-# LANGUAGE PatternGuards #-}
108{-# LANGUAGE PolyKinds #-}
119{-# LANGUAGE Rank2Types #-}
1210{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE StandaloneDeriving #-}
14−{-# LANGUAGE TypeApplications #-}
1511{-# LANGUAGE TypeFamilies #-}
1612{-# LANGUAGE UndecidableInstances #-}
17−{-# LANGUAGE UndecidableSuperClasses #-}
1813
1914-- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
2015-- move values between keys.
2116module Data.Patch.DMapWithMove where
2217
23−import qualified Control.Category as Cat
24−--import qualified Control.Category.DecidablyEmpty as Cat
25−import Data.Constraint.Extras (Has')
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
2623import Data.Dependent.Map (DMap)
2724import Data.Dependent.Sum (DSum (..))
2825import qualified Data.Dependent.Map as DMap
29−import Data.Functor.Constant (Constant (..))
26+import Data.Functor.Constant
3027import Data.Functor.Misc
31− ( Const2 (..), Proxy3 (..)
32− , weakenDMapWith
33− , dmapToMapWith
34− )
35−import Data.Functor.Product (Product (..))
28+import Data.Functor.Product
3629import Data.GADT.Compare (GEq (..), GCompare (..))
37−import Data.GADT.Show (GRead, GShow, gshow)
30+import Data.GADT.Show (GShow, gshow)
3831import qualified Data.Map as Map
3932import Data.Maybe
40−import Data.Semigroup (Semigroup (..), (<>))
41−import Data.Semigroupoid as Cat
42−import Data.Some (Some(Some))
43−import Data.Proxy (Proxy (..))
44−import Data.These (These (..))
45−
46−import Data.Patch.Class
47− ( Patch (..), PatchHet (..)
48− , PatchHet2 (..), PatchSource1, PatchTarget1
49− , applyAlwaysHet2
50− )
51−import Data.Patch.MapWithMove (PatchMapWithMove (..))
52−import qualified Data.Patch.MapWithMove as MapWithMove
53−
54−-- | Like 'PatchMapWithMove', but for 'DMap'. Each key carries a 'NodeInfo'
55−-- which describes how it will be changed by the patch and connects move sources
56−-- and destinations.
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.
5742--
5843-- Invariants:
5944--
60−-- * A key should not move to itself.
61−--
62−-- * A move should always be represented with both the destination key (as a
63−-- 'From_Move') and the source key (as a @'ComposeMaybe' ('Just'
64−-- destination)@)
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)@)
6547newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
6648
67−--deriving instance ( GShow k
68−-- , HasZip Show k p
69−-- , Has' Show k (PatchTarget1 p)
70−-- ) => Show (PatchDMapWithMove k p)
71−--deriving instance ( GRead k
72−-- , HasZip Read k p
73−-- , Has' Read k (PatchTarget1 p)
74−-- ) => Read (PatchDMapWithMove k p)
75−--deriving instance ( GEq k
76−-- , HasZip Eq k p
77−-- , Has' Eq k (PatchTarget1 p)
78−-- ) => Eq (PatchDMapWithMove k p)
79−--deriving instance ( GCompare k
80−-- , HasZip Ord k p
81−-- , Has' Ord k (PatchTarget1 p)
82−-- ) => Ord (PatchDMapWithMove k p)
83−
84−-- | Structure which represents what changes apply to a particular key.
85−-- @_nodeInfo_from@ specifies what happens to this key, and in particular what
86−-- other key the current key is moving from, while @_nodeInfo_to@ specifies what
87−-- key the current key is moving to if involved in a move.
88−data NodeInfo k p a = NodeInfo
89− { _nodeInfo_from :: !(From k p a)
90− -- ^ Change applying to the current key, be it an insert, move, or delete.
91− , _nodeInfo_to :: !(To k p a)
92− -- ^ Where this key is moving to, if involved in a move. Should only be
93− -- @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
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'.
9460 }
95−
96−--deriving instance ( Show (k a)
97−-- , Show (p a a)
98−-- , Show (PatchTarget1 p a)
99−-- ) => Show (NodeInfo k p a)
100−--deriving instance ( Read (k a)
101−-- , Read (p a a)
102−-- , Read (PatchTarget1 p a)
103−-- ) => Read (NodeInfo k p a)
104−--deriving instance ( Eq (k a)
105−-- , Eq (p a a)
106−-- , Eq (PatchTarget1 p a)
107−-- ) => Eq (NodeInfo k p a)
108−--deriving instance ( Ord (k a)
109−-- , Ord (p a a)
110−-- , Ord (PatchTarget1 p a)
111−-- ) => Ord (NodeInfo k p a)
112−
113−-- | Structure describing a particular change to a key, be it inserting a new
114−-- key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting
115−-- a key (@From_Delete@), or moving a key (@From_Move@).
116−--
117−-- This type isn't used directly as the from field patch, but is instead wrapped
118−-- in an existential. However, it is nice to be able to reason about this in
119−-- isolation as it is itself a @Semigroupoid@ when the underlying patch is.
120−data From (k :: a -> *) (p :: a -> a -> *) :: a -> * where
121− -- | Insert a new or update an existing key with the given value @PatchTarget1
122− -- p a@
123− From_Insert :: PatchTarget1 p to -> From k p to
124− -- | Delete the existing key
125− From_Delete :: From k p to
126− -- | Move the value from the given key @k a@ to this key. The source key
127− -- should also have an entry in the patch giving the current key as
128− -- @_nodeInfo_to@, usually but not necessarily with @From_Delete@.
129− From_Move :: !(DSum k (Flip p to)) -> From k p to
130−
131−deriving instance ( Show (k a), GShow k
132− , Has' Show k (Flip p a)
133− , Show (PatchTarget1 p a)
134− ) => Show (From k p a)
135−deriving instance ( Read (k a), GRead k
136− , Has' Read k (Flip p a)
137− , Read (PatchTarget1 p a)
138− ) => Read (From k p a)
139−deriving instance ( GEq k
140− , Has' Eq k (Flip p a)
141− , Eq (PatchTarget1 p a)
142− ) => Eq (From k p a)
143−deriving instance ( GCompare k
144− , Has' Eq k (Flip p a) -- superclass bug
145− , Has' Ord k (Flip p a)
146− , Ord (PatchTarget1 p a)
147− ) => Ord (From k p a)
148−
149−newtype Flip p to from = Flip (p from to)
150−
151−instance Cat.Category p => Cat.Category (Flip (p :: k -> k -> *)) where
152− id = Flip Cat.id
153− Flip y . Flip x = Flip $ x Cat.. y
154−
155−-- | The "to" part of a 'NodeInfo'. Rather than be built out of @From@ like @From@
156−-- is, we store just the information necessary to compose a @To@ and @From@ like
157−-- @oLocal@ composes two @From@s.
158−data To (k :: a -> *) (p :: a -> a -> *) :: a -> * where
159− -- | Delete or leave in place
160− To_NonMove :: To k p from
161− -- | Move the value from the given key @k a@ to this key. The target key
162− -- should also have an entry in the patch giving the current key in
163− -- @_nodeInfo_from@, usually but not necessarily with @To_Delete@.
164− To_Move :: !(DSum k (p from)) -> To k p from
165−
166−deriving instance ( Show (k a), GShow k
167− , Has' Show k (p a)
168− , Show (PatchTarget1 p a)
169− ) => Show (To k p a)
170−deriving instance ( Read (k a), GRead k
171− , Has' Read k (p a)
172− , Read (PatchTarget1 p a)
173− ) => Read (To k p a)
174−deriving instance ( GEq k
175− , Has' Eq k (p a)
176− , Eq (PatchTarget1 p a)
177− ) => Eq (To k p a)
178−deriving instance ( GCompare k
179− , Has' Eq k (p a) -- superclass bug
180− , Has' Ord k (p a)
181− , Ord (PatchTarget1 p a)
182− ) => Ord (To k p a)
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
18378
18479-- |Test whether a 'PatchDMapWithMove' satisfies its invariants.
185−validPatchDMapWithMove
186− :: forall k v
187− . (GCompare k, GShow k)
188− => DMap k (NodeInfo k v)
189− -> Bool
80+validPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Bool
19081validPatchDMapWithMove = not . null . validationErrorsForPatchDMapWithMove
19182
19283-- |Enumerate what reasons a 'PatchDMapWithMove' doesn't satisfy its invariants, returning @[]@ if it's valid.
193−validationErrorsForPatchDMapWithMove
194− :: forall k v
195− . (GCompare k, GShow k)
196− => DMap k (NodeInfo k v)
197− -> [String]
84+validationErrorsForPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> [String]
19885validationErrorsForPatchDMapWithMove m =
19986 noSelfMoves <> movesBalanced
20087 where
20188 noSelfMoves = mapMaybe selfMove . DMap.toAscList $ m
202− selfMove (dst :=> NodeInfo (From_Move (src :=> _)) _)
203− | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
204− selfMove (src :=> NodeInfo _ (To_Move (dst :=> _)))
205− | Just _ <- src `geq` dst = Just $ "self move of key " <> gshow dst <> " at source side"
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"
20691 selfMove _ = Nothing
20792 movesBalanced = mapMaybe unbalancedMove . DMap.toAscList $ m
208− unbalancedMove (dst :=> NodeInfo (From_Move (src :=> _)) _) =
93+ unbalancedMove (dst :=> NodeInfo (From_Move src) _) =
20994 case DMap.lookup src m of
21095 Nothing -> Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key is not in the patch"
211− Just (NodeInfo _ (To_Move (dst' :=> _))) ->
96+ Just (NodeInfo _ (ComposeMaybe (Just dst'))) ->
21297 if isNothing (dst' `geq` dst)
21398 then Just $ "unbalanced move at destination key " <> gshow dst <> " from " <> gshow src <> " is going to " <> gshow dst' <> " instead"
21499 else Nothing
215100 _ ->
216101 Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key has no move to key"
217− unbalancedMove (src :=> NodeInfo _ (To_Move (dst :=> _))) =
102+ unbalancedMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) =
218103 case DMap.lookup dst m of
219104 Nothing -> Just $ " unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not in the patch"
220− Just (NodeInfo (From_Move (src' :=> _)) _) ->
105+ Just (NodeInfo (From_Move src') _) ->
221106 if isNothing (src' `geq` src)
222107 then Just $ "unbalanced move at source key " <> gshow src <> " to " <> gshow dst <> " is coming from " <> gshow src' <> " instead"
223108 else Nothing
@@ -226,49 +111,35 @@ validationErrorsForPatchDMapWithMove m =
226111 Just $ "unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not moving"
227112 unbalancedMove _ = Nothing
228113
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+
229118-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
230119data Pair1 f g a = Pair1 (f a) (g a)
231120
232121-- |Helper data structure used for composing patches using the monoid instance.
233−data Fixup k p a
122+data Fixup k v a
234123 = Fixup_Delete
235− | Fixup_Update (These (From k p a) (To k p a))
236−
237−-- | Compose patches having the same effect as applying the patches in turn:
238−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
239−instance ( GCompare k
240− , Cat.Semigroupoid p
241− -- , Cat.DecidablyEmpty p
242− , PatchHet2 p
243− , PatchSource1 p ~ PatchTarget1 p
244− ) => Semigroup (PatchDMapWithMove k p) where
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
245128 PatchDMapWithMove ma <> PatchDMapWithMove mb = PatchDMapWithMove m
246129 where
247− connections :: [DSum k (Pair1 (To k p) (From k p))]
248− connections = DMap.toList $ DMap.intersectionWithKey
249− (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b))
250− ma
251− mb
252− h :: DSum k (Pair1 (To k p) (From k p)) -> [DSum k (Fixup k p)]
253− h ((_ :: k between) :=> Pair1 editAfter editBefore) = case (editAfter, editBefore) of
254− (To_Move ((toAfter :: k after) :=> p1), From_Move ((fromBefore :: k before) :=> Flip p0)) ->
255− --case toAfter `geq` fromBefore of
256− -- Just Refl | Just Refl <- Cat.isId p0 ->
257− -- [ toAfter :=> Fixup_Delete ]
258− -- _ ->
259− [ toAfter :=> Fixup_Update (This $ From_Move $ fromBefore :=> (Flip $ p1 `o` p0))
260− , fromBefore :=> Fixup_Update (That $ To_Move $ toAfter :=> (p1 `o` p0))
261− ]
262− (To_NonMove, From_Move (fromBefore :=> _)) ->
263− -- The item is destroyed in the second patch, so indicate that it is
264− -- destroyed in the source map
265− [fromBefore :=> Fixup_Update (That To_NonMove)]
266− (To_Move (toAfter :=> p), From_Insert val) ->
267− [toAfter :=> Fixup_Update (This $ From_Insert $ applyAlwaysHet2 p val)]
268− (To_Move (toAfter :=> _), From_Delete) ->
269− [toAfter :=> Fixup_Update (This From_Delete)]
270− (To_NonMove, _) ->
271− []
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, _) -> []
272143 mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
273144 mergeFixups _ (Fixup_Update a) (Fixup_Update b)
274145 | This x <- a, That y <- b
@@ -299,19 +170,13 @@ instance ( GCompare k
299170 These _ b -> Just b
300171 That b -> Just b
301172
302−-- | Compose patches having the same effect as applying the patches in turn:
303−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
304−instance ( GCompare k
305− , Cat.Semigroupoid p
306− -- , DecidablyEmpty p
307− , PatchHet2 p
308− , PatchSource1 p ~ PatchTarget1 p
309− ) => Monoid (PatchDMapWithMove k p) where
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
310175 mempty = PatchDMapWithMove mempty
311176 mappend = (<>)
312177
313178{-
314−mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
179+mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
315180PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
316181 where
317182 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
@@ -332,51 +197,44 @@ PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWith
332197 src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
333198-}
334199
335−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of inserting or
336−-- updating a value @PatchTarget1 p a@ to the given key @k a@, like
337−-- 'DMap.insert'.
338−insertDMapKey :: k a -> PatchTarget1 p a -> PatchDMapWithMove k p
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
339202insertDMapKey k v =
340− PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) To_NonMove
203+ PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
341204
342−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of moving the value
343−-- from the first key @k a@ to the second key @k a@, equivalent to:
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:
344206--
345207-- @
346208-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
347209-- @
348−moveDMapKey
349− :: GCompare k
350− => k a -> k a -> PatchDMapWithMove k (Proxy3 v)
210+moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
351211moveDMapKey src dst = case src `geq` dst of
352212 Nothing -> PatchDMapWithMove $ DMap.fromList
353− [ dst :=> NodeInfo (From_Move (src :=> Flip Proxy3)) To_NonMove
354− , src :=> NodeInfo From_Delete (To_Move $ dst :=> Proxy3)
213+ [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
214+ , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
355215 ]
356− Just _ -> PatchDMapWithMove DMap.empty
216+ Just _ -> mempty
357217
358−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys
359−-- in the mapping, equivalent to:
218+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
360219--
361220-- @
362221-- let aMay = DMap.lookup a dmap
363222-- bMay = DMap.lookup b dmap
364−-- in maybe id (DMap.insert a) (bMay `mplus` aMay)
365−-- . maybe id (DMap.insert b) (aMay `mplus` bMay)
223+-- in maybe id (DMap.insert a) (bMay <> aMay)
224+-- . maybe id (DMap.insert b) (aMay <> bMay)
366225-- . DMap.delete a . DMap.delete b $ dmap
367226-- @
368−swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k (Proxy3 v)
227+swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
369228swapDMapKey src dst = case src `geq` dst of
370229 Nothing -> PatchDMapWithMove $ DMap.fromList
371− [ dst :=> NodeInfo (From_Move (src :=> Flip Proxy3)) (To_Move $ src :=> Proxy3)
372− , src :=> NodeInfo (From_Move (dst :=> Flip Proxy3)) (To_Move $ dst :=> Proxy3)
230+ [ dst :=> NodeInfo (From_Move src) (ComposeMaybe $ Just src)
231+ , src :=> NodeInfo (From_Move dst) (ComposeMaybe $ Just dst)
373232 ]
374− Just _ -> PatchDMapWithMove DMap.empty
233+ Just _ -> mempty
375234
376−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in
377−-- the mapping, equivalent to 'DMap.delete'.
235+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'DMap.delete'.
378236deleteDMapKey :: k a -> PatchDMapWithMove k v
379−deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete To_NonMove
237+deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
380238
381239{-
382240k1, k2 :: Const2 Int () ()
@@ -402,20 +260,17 @@ dst (PatchDMapWithMove x _) = x
402260src (PatchDMapWithMove _ x) = x
403261-}
404262
405−-- | Extract the 'DMap' representing the patch changes from the
406−-- 'PatchDMapWithMove'.
263+-- |Extract the 'DMap' representing the patch changes from the 'PatchDMapWithMove'.
407264unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
408265unPatchDMapWithMove (PatchDMapWithMove p) = p
409266
410−-- | Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove',
411−-- without checking any invariants.
267+-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove', without checking any invariants.
412268--
413269-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithMove' are preserved; they will not be checked.
414270unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
415271unsafePatchDMapWithMove = PatchDMapWithMove
416272
417−-- | Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while
418−-- checking invariants. If the invariants are satisfied, @Right p@ is returned
273+-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while checking invariants. If the invariants are satisfied, @Right p@ is returned
419274-- otherwise @Left errors@.
420275patchDMapWithMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
421276patchDMapWithMove dm =
@@ -423,196 +278,94 @@ patchDMapWithMove dm =
423278 [] -> Right $ unsafePatchDMapWithMove dm
424279 errs -> Left errs
425280
426−-- | Map a natural transform @v -> v'@ over the given patch, transforming
427−-- @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
428−mapPatchDMapWithMove
429− :: forall k p p'
430− . (forall a. PatchTarget1 p a -> PatchTarget1 p' a)
431− -> (forall from to. p from to -> p' from to)
432− -> PatchDMapWithMove k p
433− -> PatchDMapWithMove k p'
434−mapPatchDMapWithMove f g (PatchDMapWithMove m) =
435− PatchDMapWithMove $ DMap.map (\ni -> NodeInfo
436− { _nodeInfo_from = h $ _nodeInfo_from ni
437− , _nodeInfo_to = j $ _nodeInfo_to ni
438− }) m
439− where h :: forall a. From k p a -> From k p' a
440− h = \case
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
441287 From_Insert v -> From_Insert $ f v
442288 From_Delete -> From_Delete
443− From_Move (k :=> (Flip p)) -> From_Move $ k :=> Flip (g p)
444− j :: forall a. To k p a -> To k p' a
445− j = \case
446− To_NonMove -> To_NonMove
447− To_Move (k :=> p) -> To_Move $ k :=> g p
448−
449−-- | Traverse an effectful function @forall a. PatchTarget1 p a -> m (v ' a)@
450−-- over the given patch, transforming @'PatchDMapWithMove' k v@ into @m
451−-- ('PatchDMapWithMove' k v')@.
452−traversePatchDMapWithMove
453− :: forall m k p p'
454− . Applicative m
455− => (forall a. PatchTarget1 p a -> m (PatchTarget1 p' a))
456− -> (forall from to. p from to -> m (p' from to))
457− -> PatchDMapWithMove k p
458− -> m (PatchDMapWithMove k p')
459−traversePatchDMapWithMove f g = traversePatchDMapWithMoveWithKey
460− (\_ -> f)
461− (\_ _ -> g)
462−
463−-- | Map an effectful function @forall a. k a -> PatchTarget1 p a -> m (v ' a)@
464−-- over the given patch, transforming @'PatchDMapWithMove' k v@ into @m
465−-- ('PatchDMapWithMove' k v')@.
466−traversePatchDMapWithMoveWithKey
467− :: forall m k p p'
468− . Applicative m
469− => (forall a. k a -> PatchTarget1 p a -> m (PatchTarget1 p' a))
470− -> (forall from to. k from -> k to -> p from to -> m (p' from to))
471− -> PatchDMapWithMove k p
472− -> m (PatchDMapWithMove k p')
473−traversePatchDMapWithMoveWithKey f g (PatchDMapWithMove m) =
474− fmap PatchDMapWithMove $ DMap.traverseWithKey (\k ni -> NodeInfo
475− <$> (h k $ _nodeInfo_from ni)
476− <*> (j k $ _nodeInfo_to ni)) m
477− where h :: forall a. k a -> From k p a -> m (From k p' a)
478− h k = \case
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
479300 From_Insert v -> From_Insert <$> f k v
480301 From_Delete -> pure From_Delete
481− From_Move (fromKey :=> Flip p) -> From_Move . (fromKey :=>) . Flip <$> g fromKey k p
482− j :: forall a. k a -> To k p a -> m (To k p' a)
483− j k = \case
484− To_NonMove -> pure To_NonMove
485− To_Move (toKey :=> p) -> To_Move . (toKey :=>) <$> g k toKey p
486−
487−-- | Map a function which transforms @'From k PatchTarget1 p a@ into a @'From k
488−-- PatchTarget1 p' a@ over a @'NodeInfo' k PatchTarget1 p a@.
489−nodeInfoMapFrom
490− :: (From k p a -> From k p' a)
491− -> (To k p a -> To k p' a)
492− -> NodeInfo k p a
493− -> NodeInfo k p' a
494−nodeInfoMapFrom f g ni = NodeInfo
495− { _nodeInfo_from = f $ _nodeInfo_from ni
496− , _nodeInfo_to = g $ _nodeInfo_to ni
497− }
498−
499−-- | Map an effectful function which transforms @'From k PatchTarget1 p a@ into
500−-- a @f ('From k PatchTarget1 p' a)@ over a @'NodeInfo' k PatchTarget1 p a@.
501−nodeInfoMapFromM
502− :: Applicative f
503− => (From k p a -> f (From k p' a))
504− -> (To k p a -> f (To k p' a))
505− -> NodeInfo k p a
506− -> f (NodeInfo k p' a)
507−nodeInfoMapFromM f g ni = NodeInfo
508− <$> (f $ _nodeInfo_from ni)
509− <*> (g $ _nodeInfo_to ni)
510−
511−-- | Weaken a 'PatchDMapWithMove' to a 'PatchMapWithMove' by weakening the keys
512−-- from @k a@ to @'Some' k@ and applying a given weakening function
513−-- @PatchTarget1 p a -> v'@ to values.
514−weakenPatchDMapWithMoveWith
515− :: forall k p p'
516− . (forall a. PatchTarget1 p a -> PatchTarget p')
517− -> (forall from to. p from to -> p')
518− -> PatchDMapWithMove k p
519− -> PatchMapWithMove (Some k) p'
520−weakenPatchDMapWithMoveWith f g (PatchDMapWithMove m) =
521− PatchMapWithMove $ weakenDMapWith h m
522− where h :: forall a. NodeInfo k p a -> MapWithMove.NodeInfo (Some k) p'
523− h ni = MapWithMove.NodeInfo
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
524318 { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
525319 From_Insert v -> MapWithMove.From_Insert $ f v
526320 From_Delete -> MapWithMove.From_Delete
527− From_Move (k :=> Flip p) -> MapWithMove.From_Move (Some k) $ g p
528− , MapWithMove._nodeInfo_to = case _nodeInfo_to ni of
529− To_NonMove -> MapWithMove.To_NonMove
530− To_Move (k :=> p) -> MapWithMove.To_Move (Some k) $ g p
321+ From_Move k -> MapWithMove.From_Move $ mkSome k
322+ , MapWithMove._nodeInfo_to = mkSome <$> getComposeMaybe (_nodeInfo_to ni)
531323 }
532324
533−-- | "Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k
534−-- v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
535−-- dependency in the typing and all points are already @a@, hence the function
536−-- to map each value to @v'@ is not higher rank.
537−patchDMapWithMoveToPatchMapWithMoveWith
538− :: forall k p p' a
539− . (PatchTarget1 p a -> PatchTarget p')
540− -> (p a a -> p')
541− -> PatchDMapWithMove (Const2 k a) p
542− -> PatchMapWithMove k p'
543−patchDMapWithMoveToPatchMapWithMoveWith f g (PatchDMapWithMove m) =
544− PatchMapWithMove $ dmapToMapWith h m
545− where h :: NodeInfo (Const2 k a) p a -> MapWithMove.NodeInfo k p'
546− h ni = MapWithMove.NodeInfo
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
547331 { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
548332 From_Insert v -> MapWithMove.From_Insert $ f v
549333 From_Delete -> MapWithMove.From_Delete
550− From_Move (Const2 k :=> Flip p) -> MapWithMove.From_Move k $ g p
551− , MapWithMove._nodeInfo_to = case _nodeInfo_to ni of
552− To_NonMove -> MapWithMove.To_NonMove
553− To_Move (Const2 k :=> p) -> MapWithMove.To_Move k $ g p
334+ From_Move (Const2 k) -> MapWithMove.From_Move k
335+ , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
554336 }
555337
556−-- | "Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove
557−-- ('Const2' k a)@; that is, turn a non-dependently-typed patch into a
558−-- dependently typed one but which always has a constant key type represented by
559−-- 'Const2'. Apply the given function to each @v@ to produce a @PatchTarget1 p'
560−-- a@. Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
561−const2PatchDMapWithMoveWith
562− :: forall k v v' a
563− . (v -> v' a)
564− -> PatchMapWithMove k (Proxy v)
565− -> PatchDMapWithMove (Const2 k a) (Proxy3 v')
566−const2PatchDMapWithMoveWith f (PatchMapWithMove p) =
567− PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
568− where g :: (k, MapWithMove.NodeInfo k (Proxy v))
569− -> DSum (Const2 k a) (NodeInfo (Const2 k a) (Proxy3 v'))
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')
570344 g (k, ni) = Const2 k :=> NodeInfo
571345 { _nodeInfo_from = case MapWithMove._nodeInfo_from ni of
572346 MapWithMove.From_Insert v -> From_Insert $ f v
573347 MapWithMove.From_Delete -> From_Delete
574− MapWithMove.From_Move fromKey Proxy -> From_Move $ Const2 fromKey :=> Flip Proxy3
575− , _nodeInfo_to = case MapWithMove._nodeInfo_to ni of
576− MapWithMove.To_NonMove -> To_NonMove
577− MapWithMove.To_Move toKey Proxy -> To_Move $ Const2 toKey :=> Proxy3
348+ MapWithMove.From_Move fromKey -> From_Move $ Const2 fromKey
349+ , _nodeInfo_to = ComposeMaybe $ Const2 <$> MapWithMove._nodeInfo_to ni
578350 }
579351
580352-- | Apply the insertions, deletions, and moves to a given 'DMap'.
581−instance ( GCompare k
582− , PatchHet2 p
583− , PatchSource1 p ~ PatchTarget1 p
584− ) => PatchHet (PatchDMapWithMove k p) where
585− type PatchSource (PatchDMapWithMove k p) = DMap k (PatchSource1 p)
586− type PatchTarget (PatchDMapWithMove k p) = DMap k (PatchTarget1 p)
587−
588−instance ( GCompare k
589− , PatchHet2 p
590− , PatchSource1 p ~ PatchTarget1 p
591− ) => Patch (PatchDMapWithMove k p) where
592− apply (PatchDMapWithMove m) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions)
593− -- TODO: return Nothing sometimes --Note: the strict application here is
594− -- critical to ensuring that incremental merges don't hold onto all their
595− -- prerequisite events forever; can we make this more robust?
596− where insertions = DMap.mapMaybeWithKey insertFunc m
597− insertFunc :: forall a. k a -> NodeInfo k p a -> Maybe (PatchTarget1 p a)
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)
598358 insertFunc _ ni = case _nodeInfo_from ni of
599359 From_Insert v -> Just v
600− From_Move (k :=> Flip p) -> applyAlwaysHet2 p <$> DMap.lookup k old
360+ From_Move k -> DMap.lookup k old
601361 From_Delete -> Nothing
602− deletions = DMap.mapMaybeWithKey deleteFunc m
603− deleteFunc :: forall a. k a -> NodeInfo k p a -> Maybe (Constant () a)
362+ deletions = DMap.mapMaybeWithKey deleteFunc p
363+ deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
604364 deleteFunc _ ni = case _nodeInfo_from ni of
605365 From_Delete -> Just $ Constant ()
606366 _ -> Nothing
607367
608−-- | Get the values that will be replaced, deleted, or moved if the given patch
609−-- is applied to the given 'DMap'.
610−getDeletionsAndMoves
611− :: ( GCompare k
612− , PatchSource1 p ~ PatchTarget1 p
613− )
614− => PatchDMapWithMove k p
615− -> DMap k (PatchSource1 p)
616− -> DMap k (Product (PatchTarget1 p) (To k p))
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))
617370getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
618371 where f _ v ni = Pair v $ _nodeInfo_to ni