@@ -1,101 +1,314 @@
11{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE InstanceSigs #-}
57{-# LANGUAGE LambdaCase #-}
68{-# LANGUAGE MultiParamTypeClasses #-}
79{-# LANGUAGE PatternGuards #-}
810{-# LANGUAGE PolyKinds #-}
911{-# LANGUAGE Rank2Types #-}
1012{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE StandaloneDeriving #-}
14+{-# LANGUAGE TypeApplications #-}
1115{-# LANGUAGE TypeFamilies #-}
1216{-# LANGUAGE UndecidableInstances #-}
17+{-# LANGUAGE UndecidableSuperClasses #-}
1318
1419-- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
1520-- move values between keys.
1621module Data.Patch.DMapWithMove where
1722
18−import Data.Patch.Class
19−import Data.Patch.MapWithMove (PatchMapWithMove (..))
20−import qualified Data.Patch.MapWithMove as MapWithMove
21−
23+import qualified Control.Category as Cat
2224import Data.Constraint.Extras
25+import Data.Constraint.Compose
2326import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
2427import qualified Data.Dependent.Map as DMap
2528import Data.Functor.Constant
2629import Data.Functor.Misc
2730import Data.Functor.Product
28−import Data.GADT.Compare (GEq (..))
29−import Data.GADT.Show (GShow, gshow)
31+import Data.GADT.Compare (GEq (..), GCompare)
32+import Data.GADT.Show (GRead, GShow, gshow)
3033import qualified Data.Map as Map
3134import Data.Maybe
35+import Data.Monoid.DecidablyEmpty
3236import Data.Semigroup (Semigroup (..), (<>))
37+import Data.Semigroupoid as Cat
3338import Data.Some (Some(Some))
3439import Data.Proxy
3540import Data.These
41+import Data.Type.Equality ((:~:) (..))
42+import Data.Kind (Constraint)
43+
44+import Data.Patch.Class
45+import Data.Patch.MapWithMove (PatchMapWithMove (..))
46+import qualified Data.Patch.MapWithMove as MapWithMove
47+
48+-- | Composition for constraints.
49+class p (f a a) => DupC (p :: k2 -> Constraint) (f :: k1 -> k1 -> k2) (a :: k1)
50+instance p (f a a) => DupC p f a
51+
52+type ConstraintsForZip f (c :: k -> Constraint) (g :: k' -> k' -> k) =
53+ ConstraintsFor f (DupC c g)
3654
37−-- | 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
38−-- destinations.
55+type HasZip (c :: k -> Constraint) f (g :: k' -> k' -> k) =
56+ (ArgDict (DupC c g) f, ConstraintsForZip f c g)
57+
58+-- | Like 'PatchMapWithMove', but for 'DMap'. Each key carries a 'NodeInfo'
59+-- which describes how it will be changed by the patch and connects move sources
60+-- and destinations.
3961--
4062-- Invariants:
4163--
42−-- * A key should not move to itself.
43−-- * A move should always be represented with both the destination key (as a 'From_Move') and the source key (as a @'ComposeMaybe' ('Just' destination)@)
64+-- * A key should not move to itself.
65+--
66+-- * A move should always be represented with both the destination key (as a
67+-- 'From_Move') and the source key (as a @'ComposeMaybe' ('Just'
68+-- destination)@)
4469newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
4570
46−-- |Structure which represents what changes apply to a particular key. @_nodeInfo_from@ specifies what happens to this key, and in particular what other key
47−-- the current key is moving from, while @_nodeInfo_to@ specifies what key the current key is moving to if involved in a move.
48−data NodeInfo k v a = NodeInfo
49− { _nodeInfo_from :: !(From k v a)
50− -- ^Change applying to the current key, be it an insert, move, or delete.
51− , _nodeInfo_to :: !(To k a)
52− -- ^Where this key is moving to, if involved in a move. Should only be @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
71+deriving instance ( GShow k
72+ , HasZip Show k p
73+ , Has' Show k (PatchTarget1 p)
74+ ) => Show (PatchDMapWithMove k p)
75+deriving instance ( GRead k
76+ , HasZip Read k p
77+ , Has' Read k (PatchTarget1 p)
78+ ) => Read (PatchDMapWithMove k p)
79+deriving instance ( GEq k
80+ , HasZip Eq k p
81+ , Has' Eq k (PatchTarget1 p)
82+ ) => Eq (PatchDMapWithMove k p)
83+deriving instance ( GCompare k
84+ , HasZip Ord k p
85+ , Has' Ord k (PatchTarget1 p)
86+ ) => Ord (PatchDMapWithMove k p)
87+
88+-- | Structure which represents what changes apply to a particular key.
89+-- @_nodeInfo_from@ specifies what happens to this key, and in particular what
90+-- other key the current key is moving from, while @_nodeInfo_to@ specifies what
91+-- key the current key is moving to if involved in a move.
92+data NodeInfo k p a = NodeInfo
93+ { _nodeInfo_from :: !(From k p a)
94+ -- ^ Change applying to the current key, be it an insert, move, or delete.
95+ , _nodeInfo_to :: !(To k p a)
96+ -- ^ Where this key is moving to, if involved in a move. Should only be
97+ -- @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
5398 }
54− deriving (Show)
55−
56−-- |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
57−-- key (@From_Delete@), or moving a key (@From_Move@).
58−data From (k :: a -> *) (v :: a -> *) :: a -> * where
59− -- |Insert a new or update an existing key with the given value @v a@
60− From_Insert :: v a -> From k v a
61− -- |Delete the existing key
62− From_Delete :: From k v a
63− -- |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@,
64− -- usually but not necessarily with @From_Delete@.
65− From_Move :: !(k a) -> From k v a
66− deriving (Show, Read, Eq, Ord)
67−
68−-- |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
69−-- operation.
70−type To = ComposeMaybe
99+
100+deriving instance ( Show (k a)
101+ , Show (p a a)
102+ , Show (PatchTarget1 p a)
103+ ) => Show (NodeInfo k p a)
104+deriving instance ( Read (k a)
105+ , Read (p a a)
106+ , Read (PatchTarget1 p a)
107+ ) => Read (NodeInfo k p a)
108+deriving instance ( Eq (k a)
109+ , Eq (p a a)
110+ , Eq (PatchTarget1 p a)
111+ ) => Eq (NodeInfo k p a)
112+deriving instance ( Ord (k a)
113+ , Ord (p a a)
114+ , Ord (PatchTarget1 p a)
115+ ) => Ord (NodeInfo k p a)
116+
117+-- | Structure describing a particular change to a key, be it inserting a new
118+-- key (@By_Insert@), updating an existing key (@By_Insert@ again), deleting
119+-- a key (@By_Delete@), or moving a key (@By_Move@).
120+--
121+-- This type isn't used directly as the from field patch, but is instead wrapped
122+-- in an existential. However, it is nice to be able to reason about this in
123+-- isolation as it is itself a @Semigroupoid@ when the underlying patch is.
124+data By (k :: a -> *) (p :: a -> a -> *) :: a -> a -> * where
125+ -- | Insert a new or update an existing key with the given value @PatchTarget1
126+ -- p a@
127+ By_Insert :: PatchTarget1 p to -> By k p from to
128+ -- | Delete the existing key
129+ By_Delete :: By k p from to
130+ -- | Move the value from the given key @k a@ to this key. The source key
131+ -- should also have an entry in the patch giving the current key as
132+ -- @_nodeInfo_to@, usually but not necessarily with @By_Delete@.
133+ By_Move :: !(k from) -> p from to -> By k p from to
134+
135+deriving instance ( Show (k to)
136+ , Show (p from to)
137+ , Show (PatchTarget1 p to)
138+ ) => Show (By k p from to)
139+deriving instance ( Read (k to)
140+ , Read (p from to)
141+ , Read (PatchTarget1 p to)
142+ ) => Read (By k p from to)
143+deriving instance ( Eq (k to)
144+ , Eq (p from to)
145+ , Eq (PatchTarget1 p to)
146+ ) => Eq (By k p from to)
147+deriving instance ( Ord (k to)
148+ , Ord (p from to)
149+ , Ord (PatchTarget1 p to)
150+ ) => Ord (By k p from to)
151+
152+mapByPatch
153+ :: PatchTarget1 p0 ~ PatchTarget1 p1
154+ => ((p0 from to) -> (p1 from to))
155+ -> By k p0 from to
156+ -> By k p1 from to
157+mapByPatch f = \case
158+ By_Insert v -> By_Insert v
159+ By_Delete -> By_Delete
160+ By_Move k p -> By_Move k $ f p
161+
162+-- | Compose patches having the same effect as applying the patches in turn:
163+-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
164+instance ( PatchSource1 p ~ PatchTarget1 p
165+ , Cat.Semigroupoid p
166+ , PatchHet2 p
167+ ) => Cat.Semigroupoid (By k p) where
168+ o p0 p1 = mapByPatch unProjectLocal $
169+ oLocal (mapByPatch ProjectLocal p0) (mapByPatch ProjectLocal p1)
170+
171+oLocal
172+ :: ( PatchSource1 p ~ PatchTarget1 p
173+ , PatchHet2Locally p between after
174+ )
175+ => By k p between after
176+ -> By k p before between
177+ -> By k p before after
178+By_Insert new `oLocal` _ = By_Insert new
179+By_Delete `oLocal` _ = By_Delete
180+By_Move _ x `oLocal` By_Insert y = By_Insert $ applyAlwaysHet2 x y
181+By_Move _ x `oLocal` By_Move src y = By_Move src $ x `o` y
182+By_Move _ _ `oLocal` By_Delete = By_Delete
183+
184+newtype Flip p to from = Flip (p from to)
185+
186+-- | Structure describing a particular change to a key, be it inserting a new
187+-- key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting
188+-- a key (@From_Delete@), or moving a key (@From_Move@).
189+--
190+-- This type isn't used directly as the from field patch, but is instead wrapped
191+-- in an existential. However, it is nice to be able to reason about this in
192+-- isolation as it is itself a @Semigroupoid@ when the underlying patch is.
193+data From (k :: a -> *) (p :: a -> a -> *) :: a -> * where
194+ -- | Insert a new or update an existing key with the given value @PatchTarget1
195+ -- p a@
196+ From_Insert :: PatchTarget1 p to -> From k p to
197+ -- | Delete the existing key
198+ From_Delete :: From k p to
199+ -- | Move the value from the given key @k a@ to this key. The source key
200+ -- should also have an entry in the patch giving the current key as
201+ -- @_nodeInfo_to@, usually but not necessarily with @From_Delete@.
202+ From_Move :: !(DSum k (Flip p to)) -> From k p to
203+
204+deriving instance ( Show (k a)
205+ , Show (p a a)
206+ , Show (PatchTarget1 p a)
207+ ) => Show (From k p a)
208+deriving instance ( Read (k a)
209+ , Read (p a a)
210+ , Read (PatchTarget1 p a)
211+ ) => Read (From k p a)
212+
213+deriving instance ( GEq k
214+ , HasZip Eq k p
215+ , Eq (PatchTarget1 p a)
216+ ) => Eq (From k p a)
217+
218+deriving instance ( GCompare k
219+ , HasZip Ord k p
220+ , Ord (PatchTarget1 p a)
221+ ) => Ord (From k p a)
222+
223+-- | The "to" part of a 'NodeInfo'. Rather than be built out of @From@ like @From@
224+-- is, we store just the information necessary to compose a @To@ and @From@ like
225+-- @oLocal@ composes two @From@s.
226+data To (k :: a -> *) (p :: a -> a -> *) :: a -> * where
227+ -- | Delete or leave in place
228+ To_NonMove :: To k p a0
229+ -- | Move the value from the given key @k a@ to this key. The target key
230+ -- should also have an entry in the patch giving the current key in
231+ -- @_nodeInfo_from@, usually but not necessarily with @To_Delete@.
232+ To_Move :: !(k a1) -> p a0 a1 -> To k p a0
233+
234+deriving instance ( Show (k a)
235+ , Show (p a a)
236+ , Show (PatchTarget1 p a)
237+ ) => Show (To k p a)
238+deriving instance ( Read (k a)
239+ , Read (p a a)
240+ , Read (PatchTarget1 p a)
241+ ) => Read (To k p a)
242+
243+instance ( GEq k
244+ , HasZip Eq k p
245+ , Eq (PatchTarget1 p a)
246+ ) => Eq (To k p a) where
247+ To_NonMove == To_NonMove = True
248+ To_Move k0 p0 == To_Move k1 p1 = case geq k0 k1 of
249+ Nothing -> False
250+ Just Refl -> has @(DupC Eq p) k0 $ p0 == p1
251+
252+instance ( GCompare k
253+ , HasZip Ord k p
254+ , Ord (PatchTarget1 p a)
255+ ) => Ord (To k p a) where
256+ To_NonMove `compare` To_NonMove = EQ
257+ To_Move k0 p0 `compare` To_Move k1 p1 = case gcompare k0 k1 of
258+ DMap.GGT -> GT
259+ DMap.GEQ -> has @(DupC Ord p) k0 $ p0 `compare` p1
260+ DMap.GLT -> LT
261+
262+--oToFrom
263+-- :: ( PatchSource1 p ~ PatchTarget1 p
264+-- , PatchHet2 p
265+-- )
266+-- => To k p between
267+-- -> From k p between
268+-- -> DSum k (From k p)
269+--From_Insert new `oToFrom` _ = From_Insert new
270+--From_Delete `oToFrom` _ = From_Delete
271+--From_Move _ x `oToFrom` From_Insert y = From_Insert $ applyAlwaysHet2 x y
272+--From_Move _ x `oToFrom` From_Move src y = From_Move src $ x `o` y
273+--From_Move _ _ `oToFrom` From_Delete = From_Delete
71274
72275-- |Test whether a 'PatchDMapWithMove' satisfies its invariants.
73−validPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Bool
276+validPatchDMapWithMove
277+ :: forall k v
278+ . (GCompare k, GShow k)
279+ => DMap k (NodeInfo k v)
280+ -> Bool
74281validPatchDMapWithMove = not . null . validationErrorsForPatchDMapWithMove
75282
76283-- |Enumerate what reasons a 'PatchDMapWithMove' doesn't satisfy its invariants, returning @[]@ if it's valid.
77−validationErrorsForPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> [String]
284+validationErrorsForPatchDMapWithMove
285+ :: forall k v
286+ . (GCompare k, GShow k)
287+ => DMap k (NodeInfo k v)
288+ -> [String]
78289validationErrorsForPatchDMapWithMove m =
79290 noSelfMoves <> movesBalanced
80291 where
81292 noSelfMoves = mapMaybe selfMove . DMap.toAscList $ m
82− selfMove (dst :=> NodeInfo (From_Move src) _) | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
83− selfMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) | Just _ <- src `geq` dst = Just $ "self move of key " <> gshow dst <> " at source side"
293+ selfMove (dst :=> NodeInfo (From_Move (src :=> _)) _)
294+ | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
295+ selfMove (src :=> NodeInfo _ (To_Move dst _))
296+ | Just _ <- src `geq` dst = Just $ "self move of key " <> gshow dst <> " at source side"
84297 selfMove _ = Nothing
85298 movesBalanced = mapMaybe unbalancedMove . DMap.toAscList $ m
86− unbalancedMove (dst :=> NodeInfo (From_Move src) _) =
299+ unbalancedMove (dst :=> NodeInfo (From_Move (src :=> _)) _) =
87300 case DMap.lookup src m of
88301 Nothing -> Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key is not in the patch"
89− Just (NodeInfo _ (ComposeMaybe (Just dst'))) ->
302+ Just (NodeInfo _ (To_Move dst' _)) ->
90303 if isNothing (dst' `geq` dst)
91304 then Just $ "unbalanced move at destination key " <> gshow dst <> " from " <> gshow src <> " is going to " <> gshow dst' <> " instead"
92305 else Nothing
93306 _ ->
94307 Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key has no move to key"
95− unbalancedMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) =
308+ unbalancedMove (src :=> NodeInfo _ (To_Move dst _)) =
96309 case DMap.lookup dst m of
97310 Nothing -> Just $ " unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not in the patch"
98− Just (NodeInfo (From_Move src') _) ->
311+ Just (NodeInfo (From_Move (src' :=> _)) _) ->
99312 if isNothing (src' `geq` src)
100313 then Just $ "unbalanced move at source key " <> gshow src <> " to " <> gshow dst <> " is coming from " <> gshow src' <> " instead"
101314 else Nothing
@@ -104,33 +317,41 @@ validationErrorsForPatchDMapWithMove m =
104317 Just $ "unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not moving"
105318 unbalancedMove _ = Nothing
106319
107−-- |Test whether two @'PatchDMapWithMove' k v@ contain the same patch operations.
108−instance (GEq k, Has' Eq k (NodeInfo k v)) => Eq (PatchDMapWithMove k v) where
109− PatchDMapWithMove a == PatchDMapWithMove b = a == b
110−
111320-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
112321data Pair1 f g a = Pair1 (f a) (g a)
113322
114323-- |Helper data structure used for composing patches using the monoid instance.
115−data Fixup k v a
324+data Fixup k p a
116325 = Fixup_Delete
117− | Fixup_Update (These (From k v a) (To k a))
118−
119−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
120−instance GCompare k => Semigroup (PatchDMapWithMove k v) where
326+ | Fixup_Update (These (From k p a) (To k p a))
327+
328+-- | Compose patches having the same effect as applying the patches in turn:
329+-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
330+instance ( GCompare k
331+ , Cat.Semigroupoid p
332+ -- , DecidablyEmpty p
333+ , PatchHet2 p
334+ ) => Semigroup (PatchDMapWithMove k p) where
121335 PatchDMapWithMove ma <> PatchDMapWithMove mb = PatchDMapWithMove m
122336 where
123− connections = DMap.toList $ DMap.intersectionWithKey (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b)) ma mb
124− h :: DSum k (Pair1 (ComposeMaybe k) (From k v)) -> [DSum k (Fixup k v)]
125− h (_ :=> Pair1 (ComposeMaybe mToAfter) editBefore) = case (mToAfter, editBefore) of
126− (Just toAfter, From_Move fromBefore)
127− | isJust $ fromBefore `geq` toAfter
128− -> [toAfter :=> Fixup_Delete]
129− | otherwise
130− -> [ toAfter :=> Fixup_Update (This editBefore)
131− , fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))
132− ]
133− (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
337+ connections :: [DSum k (Pair1 (To k p) (From k p))]
338+ connections = DMap.toList $ DMap.intersectionWithKey
339+ (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b))
340+ ma
341+ mb
342+ h :: DSum k (Pair1 k (From k v)) -> [DSum k (Fixup k v)]
343+ h (between :=> Pair1 editAfter editBefore) = case (editAfter, editBefore) of
344+ (To_Move toAfter p1, From_Move (fromBefore :=> p0)) -> case toAfter `geq` fromBefore of
345+ Just Refl | isNull p0 ->
346+ [ toAfter :=> Fixup_Delete ]
347+ _ ->
348+ [ toAfter :=> Fixup_Update (This editBefore)
349+ , fromBefore :=> Fixup_Update (That editAfter)
350+ ]
351+ (To_NonMove, From_Move (fromBefore :=> _)) ->
352+ -- The item is destroyed in the second patch, so indicate that it is
353+ -- destroyed in the source map
354+ [fromBefore :=> Fixup_Update (That (ComposeMaybe editAfter))]
134355 (Just toAfter, _) -> [toAfter :=> Fixup_Update (This editBefore)]
135356 (Nothing, _) -> []
136357 mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
@@ -148,7 +369,13 @@ instance GCompare k => Semigroup (PatchDMapWithMove k v) where
148369 applyFixup _ ni = \case
149370 Fixup_Delete -> Nothing
150371 Fixup_Update u -> Just $ NodeInfo
151− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
372+ { _nodeInfo_from = case _nodeInfo_from ni of
373+ f@(From_Move (_ :=> p')) -> case _here u of -- The `from` fixup comes from the "old" patch
374+ Nothing -> f -- If there's no `from` fixup, just use the "new" `from`
375+ Just (From_Insert v) -> From_Insert $ applyAlways p' v
376+ Just From_Delete -> From_Delete
377+ Just (From_Move (oldKey :=> p)) -> From_Move $ oldKey :=> (p' <> p)
378+ _ -> error "DPatchMapWithMove: fixup for non-move From"
152379 , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
153380 }
154381 m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
@@ -169,7 +396,7 @@ instance GCompare k => Monoid (PatchDMapWithMove k v) where
169396 mappend = (<>)
170397
171398{-
172−mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
399+mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
173400PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
174401 where
175402 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
@@ -190,8 +417,8 @@ PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWith
190417 src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
191418-}
192419
193−-- |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'.
194−insertDMapKey :: k a -> v a -> PatchDMapWithMove k v
420+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of inserting or updating a value @PatchTarget1 p a@ to the given key @k a@, like 'DMap.insert'.
421+insertDMapKey :: k a -> PatchTarget1 p a -> PatchDMapWithMove k p
195422insertDMapKey k v =
196423 PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
197424
@@ -203,7 +430,7 @@ insertDMapKey k v =
203430moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
204431moveDMapKey src dst = case src `geq` dst of
205432 Nothing -> PatchDMapWithMove $ DMap.fromList
206− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
433+ [ dst :=> NodeInfo (From_Move (src :=> Cat.id)) (ComposeMaybe Nothing)
207434 , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
208435 ]
209436 Just _ -> mempty
@@ -220,8 +447,8 @@ moveDMapKey src dst = case src `geq` dst of
220447swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
221448swapDMapKey src dst = case src `geq` dst of
222449 Nothing -> PatchDMapWithMove $ DMap.fromList
223− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe $ Just src)
224− , src :=> NodeInfo (From_Move dst) (ComposeMaybe $ Just dst)
450+ [ dst :=> NodeInfo (From_Move (src :=> Cat.id)) (ComposeMaybe $ Just src)
451+ , src :=> NodeInfo (From_Move (dst :=> Cat.id)) (ComposeMaybe $ Just dst)
225452 ]
226453 Just _ -> mempty
227454
@@ -272,41 +499,75 @@ patchDMapWithMove dm =
272499 errs -> Left errs
273500
274501-- |Map a natural transform @v -> v'@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
275−mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
276−mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $
502+mapPatchDMapWithMove
503+ :: forall k p p'
504+ . (forall a. PatchTarget1 p a -> PatchTarget1 p' a)
505+ -> (forall from to. p from to -> p' from to)
506+ -> PatchDMapWithMove k p
507+ -> PatchDMapWithMove k p'
508+mapPatchDMapWithMove f g (PatchDMapWithMove p) = PatchDMapWithMove $
277509 DMap.map (\ni -> ni { _nodeInfo_from = g $ _nodeInfo_from ni }) p
278− where g :: forall a. From k v a -> From k v' a
510+ where g :: forall a. From k PatchTarget1 p a -> From k PatchTarget1 p' a
279511 g = \case
280512 From_Insert v -> From_Insert $ f v
281513 From_Delete -> From_Delete
282− From_Move k -> From_Move k
283−
284−-- |Traverse an effectful function @forall a. v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
285−traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
514+ From_Move k p -> From_Move k $ g p
515+
516+-- | Traverse an effectful function @forall a. PatchTarget1 p a -> m (v ' a)@
517+-- over the given patch, transforming @'PatchDMapWithMove' k v@ into @m
518+-- ('PatchDMapWithMove' k v')@.
519+traversePatchDMapWithMove
520+ :: forall m k p p'
521+ . Applicative m
522+ => (forall a. PatchTarget1 p a -> m (PatchTarget1 p' a))
523+ -> PatchDMapWithMove k p
524+ -> m (PatchDMapWithMove k p')
286525traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
287526
288−-- |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')@.
289−traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
290−traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
291− where g :: forall a. k a -> From k v a -> m (From k v' a)
527+-- | Map an effectful function @forall a. k a -> PatchTarget1 p a -> m (v ' a)@
528+-- over the given patch, transforming @'PatchDMapWithMove' k v@ into @m
529+-- ('PatchDMapWithMove' k v')@.
530+traversePatchDMapWithMoveWithKey
531+ :: forall m k p p'
532+ . Applicative m
533+ => (forall a. k a -> PatchTarget1 p a -> m (PatchTarget1 p' a))
534+ -> PatchDMapWithMove k p
535+ -> m (PatchDMapWithMove k p')
536+traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) =
537+ PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
538+ where g :: forall a. k a -> From k PatchTarget1 p a -> m (From k PatchTarget1 p' a)
292539 g k = \case
293540 From_Insert v -> From_Insert <$> f k v
294541 From_Delete -> pure From_Delete
295542 From_Move fromKey -> pure $ From_Move fromKey
296543
297−-- |Map a function which transforms @'From' k v a@ into a @'From' k v' a@ over a @'NodeInfo' k v a@.
298−nodeInfoMapFrom :: (From k v a -> From k v' a) -> NodeInfo k v a -> NodeInfo k v' a
544+-- | Map a function which transforms @'From k PatchTarget1 p a@ into a @'From k
545+-- PatchTarget1 p' a@ over a @'NodeInfo' k PatchTarget1 p a@.
546+nodeInfoMapFrom
547+ :: (From k p a -> From k p' a)
548+ -> NodeInfo k p a
549+ -> NodeInfo k p' a
299550nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
300551
301−-- |Map an effectful function which transforms @'From' k v a@ into a @f ('From' k v' a)@ over a @'NodeInfo' k v a@.
302−nodeInfoMapFromM :: Functor f => (From k v a -> f (From k v' a)) -> NodeInfo k v a -> f (NodeInfo k v' a)
552+-- | Map an effectful function which transforms @'From k PatchTarget1 p a@ into
553+-- a @f ('From k PatchTarget1 p' a)@ over a @'NodeInfo' k PatchTarget1 p a@.
554+nodeInfoMapFromM
555+ :: Functor f
556+ => (From k p a -> f (From k p' a))
557+ -> NodeInfo k p a
558+ -> f (NodeInfo k p' a)
303559nodeInfoMapFromM f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
304560
305−-- |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
306−-- values.
307−weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) (Proxy v')
561+-- | Weaken a 'PatchDMapWithMove' to a 'PatchMapWithMove' by weakening the keys
562+-- from @k a@ to @'Some' k@ and applying a given weakening function
563+-- @PatchTarget1 p a -> v'@ to values.
564+weakenPatchDMapWithMoveWith
565+ :: forall k p v'
566+ . (forall a. PatchTarget1 p a -> v')
567+ -> PatchDMapWithMove k p
568+ -> PatchMapWithMove (Some k) (Proxy v')
308569weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
309− where g :: forall a. NodeInfo k v a -> MapWithMove.NodeInfo (Some k) (Proxy v')
570+ where g :: forall a. NodeInfo k PatchTarget1 p a -> MapWithMove.NodeInfo (Some k) (Proxy v')
310571 g ni = MapWithMove.NodeInfo
311572 { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
312573 From_Insert v -> MapWithMove.From_Insert $ f v
@@ -315,11 +576,16 @@ weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenD
315576 , MapWithMove._nodeInfo_to = Some <$> getComposeMaybe (_nodeInfo_to ni)
316577 }
317578
318−-- |"Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
319−-- dependency in the typing and all points are already @a@, hence the function to map each value to @v'@ is not higher rank.
320−patchDMapWithMoveToPatchMapWithMoveWith :: forall k v v' a. (v a -> v') -> PatchDMapWithMove (Const2 k a) v -> PatchMapWithMove k (Proxy v')
579+-- | "Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k
580+-- v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
581+-- dependency in the typing and all points are already @a@, hence the function
582+-- to map each value to @v'@ is not higher rank.
583+patchDMapWithMoveToPatchMapWithMoveWith
584+ :: forall k p v' a. (PatchTarget1 p a -> v')
585+ -> PatchDMapWithMove (Const2 k a) p
586+ -> PatchMapWithMove k (Proxy v')
321587patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
322− where g :: NodeInfo (Const2 k a) v a -> MapWithMove.NodeInfo k (Proxy v')
588+ where g :: NodeInfo (Const2 k a) PatchTarget1 p a -> MapWithMove.NodeInfo k (Proxy v')
323589 g ni = MapWithMove.NodeInfo
324590 { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
325591 From_Insert v -> MapWithMove.From_Insert $ f v
@@ -328,10 +594,16 @@ patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMo
328594 , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
329595 }
330596
331−-- |"Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove ('Const2' k a)@; that is, turn a non-dependently-typed patch into a dependently typed
332−-- one but which always has a constant key type represented by 'Const2'. Apply the given function to each @v@ to produce a @v' a@.
333−-- Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
334−const2PatchDMapWithMoveWith :: forall k v v' a. (v -> v' a) -> PatchMapWithMove k (Proxy v) -> PatchDMapWithMove (Const2 k a) v'
597+-- | "Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove
598+-- ('Const2' k a)@; that is, turn a non-dependently-typed patch into a
599+-- dependently typed one but which always has a constant key type represented by
600+-- 'Const2'. Apply the given function to each @v@ to produce a @PatchTarget1 p'
601+-- a@. Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
602+const2PatchDMapWithMoveWith
603+ :: forall k v p' a
604+ . (v -> PatchTarget1 p' a)
605+ -> PatchMapWithMove k (Proxy v)
606+ -> PatchDMapWithMove (Const2 k a) p'
335607const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
336608 where g :: (k, MapWithMove.NodeInfo k (Proxy v)) -> DSum (Const2 k a) (NodeInfo (Const2 k a) v')
337609 g (k, ni) = Const2 k :=> NodeInfo
@@ -343,22 +615,28 @@ const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fr
343615 }
344616
345617-- | Apply the insertions, deletions, and moves to a given 'DMap'.
346−instance GCompare k => Patch (PatchDMapWithMove k v) where
347− type PatchTarget (PatchDMapWithMove k v) = DMap k v
348− 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?
618+instance GCompare k => PatchHet (PatchDMapWithMove k p) where
619+ type PatchSource (PatchDMapWithMove k p) = DMap k (PatchSource1 p)
620+ type PatchTarget (PatchDMapWithMove k p) = DMap k (PatchTarget1 p)
621+instance GCompare k => Patch (PatchDMapWithMove k p) where
622+ apply (PatchDMapWithMove p) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions)
623+ -- TODO: return Nothing sometimes --Note: the strict application here is
624+ -- critical to ensuring that incremental merges don't hold onto all their
625+ -- prerequisite events forever; can we make this more robust?
349626 where insertions = DMap.mapMaybeWithKey insertFunc p
350− insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
627+ insertFunc :: forall a. k a -> NodeInfo k p a -> Maybe (PatchTarget1 p a)
351628 insertFunc _ ni = case _nodeInfo_from ni of
352629 From_Insert v -> Just v
353630 From_Move k -> DMap.lookup k old
354631 From_Delete -> Nothing
355632 deletions = DMap.mapMaybeWithKey deleteFunc p
356− deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
633+ deleteFunc :: forall a. k a -> NodeInfo k p a -> Maybe (Constant () a)
357634 deleteFunc _ ni = case _nodeInfo_from ni of
358635 From_Delete -> Just $ Constant ()
359636 _ -> Nothing
360637
361−-- | Get the values that will be replaced, deleted, or moved if the given patch is applied to the given 'DMap'.
638+-- | Get the values that will be replaced, deleted, or moved if the given patch
639+-- is applied to the given 'DMap'.
362640getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
363641getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
364642 where f _ v ni = Pair v $ _nodeInfo_to ni