@@ -1,234 +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 #-}
1411{-# LANGUAGE TypeFamilies #-}
1512{-# LANGUAGE UndecidableInstances #-}
16−{-# LANGUAGE UndecidableSuperClasses #-}
1713
1814-- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
1915-- move values between keys.
2016module Data.Patch.DMapWithMove where
2117
22−import qualified Control.Category as Cat
23−--import qualified Control.Category.DecidablyEmpty as Cat
18+import Data.Patch.Class
19+import Data.Patch.MapWithMove (PatchMapWithMove (..))
20+import qualified Data.Patch.MapWithMove as MapWithMove
2421
25−import Data.Constraint.Extras (Has')
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
4033import Data.Monoid.DecidablyEmpty
41−import Data.Semigroupoid as Cat
4234#if !MIN_VERSION_base(4,11,0)
43−import Data.Semigroup (Semigroup (..), (<>))
35+import Data.Semigroup (Semigroup (..))
4436#endif
4537import Data.Some (Some, mkSome)
46−import Data.Proxy (Proxy (..))
47−import Data.These (These (..))
38+import Data.These
4839
49−import Data.Patch.Class
50− ( Patch (..), PatchHet (..)
51− , PatchHet2 (..), PatchSource1, PatchTarget1
52− , applyAlwaysHet2
53− )
54−import Data.Patch.MapWithPatchingMove (PatchMapWithPatchingMove (..))
55−import qualified Data.Patch.MapWithPatchingMove as MapWithPatchingMove
56−
57−-- | Like 'PatchMapWithPatchingMove', but for 'DMap'. Each key carries a 'NodeInfo'
58−-- which describes how it will be changed by the patch and connects move sources
59−-- and destinations.
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.
6042--
6143-- Invariants:
6244--
63−-- * A key should not move to itself.
64−--
65−-- * A move should always be represented with both the destination key (as a
66−-- 'From_Move') and the source key (as a @'ComposeMaybe' ('Just'
67−-- 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)@)
6847newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
6948
70−--deriving instance ( GShow k
71−-- , HasZip Show k p
72−-- , Has' Show k (PatchTarget1 p)
73−-- ) => Show (PatchDMapWithMove k p)
74−--deriving instance ( GRead k
75−-- , HasZip Read k p
76−-- , Has' Read k (PatchTarget1 p)
77−-- ) => Read (PatchDMapWithMove k p)
78−--deriving instance ( GEq k
79−-- , HasZip Eq k p
80−-- , Has' Eq k (PatchTarget1 p)
81−-- ) => Eq (PatchDMapWithMove k p)
82−--deriving instance ( GCompare k
83−-- , HasZip Ord k p
84−-- , Has' Ord k (PatchTarget1 p)
85−-- ) => Ord (PatchDMapWithMove k p)
86−
8749-- It won't let me derive for some reason
88−instance ( GCompare k
89− , Cat.Semigroupoid v
90− , PatchHet2 v
91− , PatchSource1 v ~ PatchTarget1 v
92− ) => DecidablyEmpty (PatchDMapWithMove k v) where
50+instance GCompare k => DecidablyEmpty (PatchDMapWithMove k v) where
9351 isEmpty (PatchDMapWithMove m) = DMap.null m
9452
95−-- | Structure which represents what changes apply to a particular key.
96−-- @_nodeInfo_from@ specifies what happens to this key, and in particular what
97−-- other key the current key is moving from, while @_nodeInfo_to@ specifies what
98−-- key the current key is moving to if involved in a move.
99−data NodeInfo k p a = NodeInfo
100− { _nodeInfo_from :: !(From k p a)
101− -- ^ Change applying to the current key, be it an insert, move, or delete.
102− , _nodeInfo_to :: !(To k p a)
103− -- ^ Where this key is moving to, if involved in a move. Should only be
104− -- @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
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'.
10560 }
106−
107−--deriving instance ( Show (k a)
108−-- , Show (p a a)
109−-- , Show (PatchTarget1 p a)
110−-- ) => Show (NodeInfo k p a)
111−--deriving instance ( Read (k a)
112−-- , Read (p a a)
113−-- , Read (PatchTarget1 p a)
114−-- ) => Read (NodeInfo k p a)
115−--deriving instance ( Eq (k a)
116−-- , Eq (p a a)
117−-- , Eq (PatchTarget1 p a)
118−-- ) => Eq (NodeInfo k p a)
119−--deriving instance ( Ord (k a)
120−-- , Ord (p a a)
121−-- , Ord (PatchTarget1 p a)
122−-- ) => Ord (NodeInfo k p a)
123−
124−-- | Structure describing a particular change to a key, be it inserting a new
125−-- key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting
126−-- a key (@From_Delete@), or moving a key (@From_Move@).
127−--
128−-- This type isn't used directly as the from field patch, but is instead wrapped
129−-- in an existential. However, it is nice to be able to reason about this in
130−-- isolation as it is itself a @Semigroupoid@ when the underlying patch is.
131−data From (k :: a -> *) (p :: a -> a -> *) :: a -> * where
132− -- | Insert a new or update an existing key with the given value @PatchTarget1
133− -- p a@
134− From_Insert :: PatchTarget1 p to -> From k p to
135− -- | Delete the existing key
136− From_Delete :: From k p to
137− -- | Move the value from the given key @k a@ to this key. The source key
138− -- should also have an entry in the patch giving the current key as
139− -- @_nodeInfo_to@, usually but not necessarily with @From_Delete@.
140− From_Move :: !(DSum k (Flip p to)) -> From k p to
141−
142−deriving instance ( Show (k a), GShow k
143− , Has' Show k (Flip p a)
144− , Show (PatchTarget1 p a)
145− ) => Show (From k p a)
146−deriving instance ( Read (k a), GRead k
147− , Has' Read k (Flip p a)
148− , Read (PatchTarget1 p a)
149− ) => Read (From k p a)
150−deriving instance ( GEq k
151− , Has' Eq k (Flip p a)
152− , Eq (PatchTarget1 p a)
153− ) => Eq (From k p a)
154−deriving instance ( GCompare k
155− , Has' Eq k (Flip p a) -- superclass bug
156− , Has' Ord k (Flip p a)
157− , Ord (PatchTarget1 p a)
158− ) => Ord (From k p a)
159−
160−newtype Flip p to from = Flip (p from to)
161−
162−instance Cat.Category p => Cat.Category (Flip (p :: k -> k -> *)) where
163− id = Flip Cat.id
164− Flip y . Flip x = Flip $ x Cat.. y
165−
166−-- | The "to" part of a 'NodeInfo'. Rather than be built out of @From@ like @From@
167−-- is, we store just the information necessary to compose a @To@ and @From@ like
168−-- @oLocal@ composes two @From@s.
169−data To (k :: a -> *) (p :: a -> a -> *) :: a -> * where
170− -- | Delete or leave in place
171− To_NonMove :: To k p from
172− -- | Move the value from the given key @k a@ to this key. The target key
173− -- should also have an entry in the patch giving the current key in
174− -- @_nodeInfo_from@, usually but not necessarily with @To_Delete@.
175− To_Move :: !(DSum k (p from)) -> To k p from
176−
177−deriving instance ( Show (k a), GShow k
178− , Has' Show k (p a)
179− , Show (PatchTarget1 p a)
180− ) => Show (To k p a)
181−deriving instance ( Read (k a), GRead k
182− , Has' Read k (p a)
183− , Read (PatchTarget1 p a)
184− ) => Read (To k p a)
185−deriving instance ( GEq k
186− , Has' Eq k (p a)
187− , Eq (PatchTarget1 p a)
188− ) => Eq (To k p a)
189−deriving instance ( GCompare k
190− , Has' Eq k (p a) -- superclass bug
191− , Has' Ord k (p a)
192− , Ord (PatchTarget1 p a)
193− ) => 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
19478
19579-- |Test whether a 'PatchDMapWithMove' satisfies its invariants.
196−validPatchDMapWithMove
197− :: forall k v
198− . (GCompare k, GShow k)
199− => DMap k (NodeInfo k v)
200− -> Bool
80+validPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Bool
20181validPatchDMapWithMove = not . null . validationErrorsForPatchDMapWithMove
20282
20383-- |Enumerate what reasons a 'PatchDMapWithMove' doesn't satisfy its invariants, returning @[]@ if it's valid.
204−validationErrorsForPatchDMapWithMove
205− :: forall k v
206− . (GCompare k, GShow k)
207− => DMap k (NodeInfo k v)
208− -> [String]
84+validationErrorsForPatchDMapWithMove :: forall k v. (GCompare k, GShow k) => DMap k (NodeInfo k v) -> [String]
20985validationErrorsForPatchDMapWithMove m =
21086 noSelfMoves <> movesBalanced
21187 where
21288 noSelfMoves = mapMaybe selfMove . DMap.toAscList $ m
213− selfMove (dst :=> NodeInfo (From_Move (src :=> _)) _)
214− | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
215− selfMove (src :=> NodeInfo _ (To_Move (dst :=> _)))
216− | 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"
21791 selfMove _ = Nothing
21892 movesBalanced = mapMaybe unbalancedMove . DMap.toAscList $ m
219− unbalancedMove (dst :=> NodeInfo (From_Move (src :=> _)) _) =
93+ unbalancedMove (dst :=> NodeInfo (From_Move src) _) =
22094 case DMap.lookup src m of
22195 Nothing -> Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key is not in the patch"
222− Just (NodeInfo _ (To_Move (dst' :=> _))) ->
96+ Just (NodeInfo _ (ComposeMaybe (Just dst'))) ->
22397 if isNothing (dst' `geq` dst)
22498 then Just $ "unbalanced move at destination key " <> gshow dst <> " from " <> gshow src <> " is going to " <> gshow dst' <> " instead"
22599 else Nothing
226100 _ ->
227101 Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key has no move to key"
228− unbalancedMove (src :=> NodeInfo _ (To_Move (dst :=> _))) =
102+ unbalancedMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) =
229103 case DMap.lookup dst m of
230104 Nothing -> Just $ " unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not in the patch"
231− Just (NodeInfo (From_Move (src' :=> _)) _) ->
105+ Just (NodeInfo (From_Move src') _) ->
232106 if isNothing (src' `geq` src)
233107 then Just $ "unbalanced move at source key " <> gshow src <> " to " <> gshow dst <> " is coming from " <> gshow src' <> " instead"
234108 else Nothing
@@ -237,49 +111,35 @@ validationErrorsForPatchDMapWithMove m =
237111 Just $ "unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not moving"
238112 unbalancedMove _ = Nothing
239113
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+
240118-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
241119data Pair1 f g a = Pair1 (f a) (g a)
242120
243121-- |Helper data structure used for composing patches using the monoid instance.
244−data Fixup k p a
122+data Fixup k v a
245123 = Fixup_Delete
246− | Fixup_Update (These (From k p a) (To k p a))
247−
248−-- | Compose patches having the same effect as applying the patches in turn:
249−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
250−instance ( GCompare k
251− , Cat.Semigroupoid p
252− -- , Cat.DecidablyEmpty p
253− , PatchHet2 p
254− , PatchSource1 p ~ PatchTarget1 p
255− ) => 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
256128 PatchDMapWithMove ma <> PatchDMapWithMove mb = PatchDMapWithMove m
257129 where
258− connections :: [DSum k (Pair1 (To k p) (From k p))]
259− connections = DMap.toList $ DMap.intersectionWithKey
260− (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b))
261− ma
262− mb
263− h :: DSum k (Pair1 (To k p) (From k p)) -> [DSum k (Fixup k p)]
264− h ((_ :: k between) :=> Pair1 editAfter editBefore) = case (editAfter, editBefore) of
265− (To_Move ((toAfter :: k after) :=> p1), From_Move ((fromBefore :: k before) :=> Flip p0)) ->
266− --case toAfter `geq` fromBefore of
267− -- Just Refl | Just Refl <- Cat.isId p0 ->
268− -- [ toAfter :=> Fixup_Delete ]
269− -- _ ->
270− [ toAfter :=> Fixup_Update (This $ From_Move $ fromBefore :=> (Flip $ p1 `o` p0))
271− , fromBefore :=> Fixup_Update (That $ To_Move $ toAfter :=> (p1 `o` p0))
272− ]
273− (To_NonMove, From_Move (fromBefore :=> _)) ->
274− -- The item is destroyed in the second patch, so indicate that it is
275− -- destroyed in the source map
276− [fromBefore :=> Fixup_Update (That To_NonMove)]
277− (To_Move (toAfter :=> p), From_Insert val) ->
278− [toAfter :=> Fixup_Update (This $ From_Insert $ applyAlwaysHet2 p val)]
279− (To_Move (toAfter :=> _), From_Delete) ->
280− [toAfter :=> Fixup_Update (This From_Delete)]
281− (To_NonMove, _) ->
282− []
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, _) -> []
283143 mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
284144 mergeFixups _ (Fixup_Update a) (Fixup_Update b)
285145 | This x <- a, That y <- b
@@ -310,19 +170,13 @@ instance ( GCompare k
310170 These _ b -> Just b
311171 That b -> Just b
312172
313−-- | Compose patches having the same effect as applying the patches in turn:
314−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
315−instance ( GCompare k
316− , Cat.Semigroupoid p
317− -- , DecidablyEmpty p
318− , PatchHet2 p
319− , PatchSource1 p ~ PatchTarget1 p
320− ) => 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
321175 mempty = PatchDMapWithMove mempty
322176 mappend = (<>)
323177
324178{-
325−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
326180PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
327181 where
328182 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
@@ -343,31 +197,25 @@ PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWith
343197 src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
344198-}
345199
346−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of inserting or
347−-- updating a value @PatchTarget1 p a@ to the given key @k a@, like
348−-- 'DMap.insert'.
349−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
350202insertDMapKey k v =
351− PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) To_NonMove
203+ PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
352204
353−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of moving the value
354−-- 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:
355206--
356207-- @
357208-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
358209-- @
359−moveDMapKey
360− :: GCompare k
361− => k a -> k a -> PatchDMapWithMove k (Proxy3 v)
210+moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
362211moveDMapKey src dst = case src `geq` dst of
363212 Nothing -> PatchDMapWithMove $ DMap.fromList
364− [ dst :=> NodeInfo (From_Move (src :=> Flip Proxy3)) To_NonMove
365− , src :=> NodeInfo From_Delete (To_Move $ dst :=> Proxy3)
213+ [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
214+ , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
366215 ]
367− Just _ -> PatchDMapWithMove DMap.empty
216+ Just _ -> mempty
368217
369−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys
370−-- in the mapping, equivalent to:
218+-- |Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
371219--
372220-- @
373221-- let aMay = DMap.lookup a dmap
@@ -376,18 +224,17 @@ moveDMapKey src dst = case src `geq` dst of
376224-- . maybe id (DMap.insert b) (aMay <> bMay)
377225-- . DMap.delete a . DMap.delete b $ dmap
378226-- @
379−swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k (Proxy3 v)
227+swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
380228swapDMapKey src dst = case src `geq` dst of
381229 Nothing -> PatchDMapWithMove $ DMap.fromList
382− [ dst :=> NodeInfo (From_Move (src :=> Flip Proxy3)) (To_Move $ src :=> Proxy3)
383− , 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)
384232 ]
385− Just _ -> PatchDMapWithMove DMap.empty
233+ Just _ -> mempty
386234
387−-- | Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in
388−-- 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'.
389236deleteDMapKey :: k a -> PatchDMapWithMove k v
390−deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete To_NonMove
237+deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
391238
392239{-
393240k1, k2 :: Const2 Int () ()
@@ -413,217 +260,115 @@ dst (PatchDMapWithMove x _) = x
413260src (PatchDMapWithMove _ x) = x
414261-}
415262
416−-- | Extract the 'DMap' representing the patch changes from the
417−-- 'PatchDMapWithMove'.
263+-- |Extract the 'DMap' representing the patch changes from the 'PatchDMapWithMove'.
418264unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
419265unPatchDMapWithMove (PatchDMapWithMove p) = p
420266
421−-- | Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove',
422−-- without checking any invariants.
267+-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove', without checking any invariants.
423268--
424269-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithMove' are preserved; they will not be checked.
425270unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
426271unsafePatchDMapWithMove = PatchDMapWithMove
427272
428−-- | Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while
429−-- 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
430274-- otherwise @Left errors@.
431−patchDMapWithPatchingMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
432−patchDMapWithPatchingMove dm =
275+patchDMapWithMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
276+patchDMapWithMove dm =
433277 case validationErrorsForPatchDMapWithMove dm of
434278 [] -> Right $ unsafePatchDMapWithMove dm
435279 errs -> Left errs
436280
437−-- | Map a natural transform @v -> v'@ over the given patch, transforming
438−-- @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
439−mapPatchDMapWithMove
440− :: forall k p p'
441− . (forall a. PatchTarget1 p a -> PatchTarget1 p' a)
442− -> (forall from to. p from to -> p' from to)
443− -> PatchDMapWithMove k p
444− -> PatchDMapWithMove k p'
445−mapPatchDMapWithMove f g (PatchDMapWithMove m) =
446− PatchDMapWithMove $ DMap.map (\ni -> NodeInfo
447− { _nodeInfo_from = h $ _nodeInfo_from ni
448− , _nodeInfo_to = j $ _nodeInfo_to ni
449− }) m
450− where h :: forall a. From k p a -> From k p' a
451− 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
452287 From_Insert v -> From_Insert $ f v
453288 From_Delete -> From_Delete
454− From_Move (k :=> Flip p) -> From_Move $ k :=> Flip (g p)
455− j :: forall a. To k p a -> To k p' a
456− j = \case
457− To_NonMove -> To_NonMove
458− To_Move (k :=> p) -> To_Move $ k :=> g p
459−
460−-- | Traverse an effectful function @forall a. PatchTarget1 p a -> m (v ' a)@
461−-- over the given patch, transforming @'PatchDMapWithMove' k v@ into @m
462−-- ('PatchDMapWithMove' k v')@.
463−traversePatchDMapWithMove
464− :: forall m k p p'
465− . Applicative m
466− => (forall a. PatchTarget1 p a -> m (PatchTarget1 p' a))
467− -> (forall from to. p from to -> m (p' from to))
468− -> PatchDMapWithMove k p
469− -> m (PatchDMapWithMove k p')
470−traversePatchDMapWithMove f g = traversePatchDMapWithMoveWithKey
471− (\_ -> f)
472− (\_ _ -> g)
473−
474−-- | Map an effectful function @forall a. k a -> PatchTarget1 p a -> m (v ' a)@
475−-- over the given patch, transforming @'PatchDMapWithMove' k v@ into @m
476−-- ('PatchDMapWithMove' k v')@.
477−traversePatchDMapWithMoveWithKey
478− :: forall m k p p'
479− . Applicative m
480− => (forall a. k a -> PatchTarget1 p a -> m (PatchTarget1 p' a))
481− -> (forall from to. k from -> k to -> p from to -> m (p' from to))
482− -> PatchDMapWithMove k p
483− -> m (PatchDMapWithMove k p')
484−traversePatchDMapWithMoveWithKey f g (PatchDMapWithMove m) =
485− PatchDMapWithMove <$> DMap.traverseWithKey (\k ni -> NodeInfo
486− <$> h k (_nodeInfo_from ni)
487− <*> j k (_nodeInfo_to ni)) m
488− where h :: forall a. k a -> From k p a -> m (From k p' a)
489− 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
490300 From_Insert v -> From_Insert <$> f k v
491301 From_Delete -> pure From_Delete
492− From_Move (fromKey :=> Flip p) -> From_Move . (fromKey :=>) . Flip <$> g fromKey k p
493− j :: forall a. k a -> To k p a -> m (To k p' a)
494− j k = \case
495− To_NonMove -> pure To_NonMove
496− To_Move (toKey :=> p) -> To_Move . (toKey :=>) <$> g k toKey p
497−
498−-- | Map a function which transforms @'From k PatchTarget1 p a@ into a @'From k
499−-- PatchTarget1 p' a@ over a @'NodeInfo' k PatchTarget1 p a@.
500−nodeInfoMapFrom
501− :: (From k p a -> From k p' a)
502− -> (To k p a -> To k p' a)
503− -> NodeInfo k p a
504− -> NodeInfo k p' a
505−nodeInfoMapFrom f g ni = NodeInfo
506− { _nodeInfo_from = f $ _nodeInfo_from ni
507− , _nodeInfo_to = g $ _nodeInfo_to ni
508− }
509−
510−-- | Map an effectful function which transforms @'From k PatchTarget1 p a@ into
511−-- a @f ('From k PatchTarget1 p' a)@ over a @'NodeInfo' k PatchTarget1 p a@.
512−nodeInfoMapFromM
513− :: Applicative f
514− => (From k p a -> f (From k p' a))
515− -> (To k p a -> f (To k p' a))
516− -> NodeInfo k p a
517− -> f (NodeInfo k p' a)
518−nodeInfoMapFromM f g ni = NodeInfo
519− <$> f (_nodeInfo_from ni)
520− <*> g (_nodeInfo_to ni)
521−
522−-- | Weaken a 'PatchDMapWithMove' to a 'PatchMapWithPatchingMove' by weakening the keys
523−-- from @k a@ to @'Some' k@ and applying a given weakening function
524−-- @PatchTarget1 p a -> v'@ to values.
525−weakenPatchDMapWithMoveWith
526− :: forall k p p'
527− . (forall a. PatchTarget1 p a -> PatchTarget p')
528− -> (forall from to. p from to -> p')
529− -> PatchDMapWithMove k p
530− -> PatchMapWithPatchingMove (Some k) p'
531−weakenPatchDMapWithMoveWith f g (PatchDMapWithMove m) =
532− PatchMapWithPatchingMove $ weakenDMapWith h m
533− where h :: forall a. NodeInfo k p a -> MapWithPatchingMove.NodeInfo (Some k) p'
534− h ni = MapWithPatchingMove.NodeInfo
535− { MapWithPatchingMove._nodeInfo_from = case _nodeInfo_from ni of
536− From_Insert v -> MapWithPatchingMove.From_Insert $ f v
537− From_Delete -> MapWithPatchingMove.From_Delete
538− From_Move (k :=> Flip p) -> MapWithPatchingMove.From_Move (mkSome k) $ g p
539− , MapWithPatchingMove._nodeInfo_to = case _nodeInfo_to ni of
540− To_NonMove -> Nothing
541− To_Move (k :=> _) -> Just (mkSome k)
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)
542323 }
543324
544−-- | "Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithPatchingMove' k
545−-- v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
546−-- dependency in the typing and all points are already @a@, hence the function
547−-- to map each value to @v'@ is not higher rank.
548−patchDMapWithMoveToPatchMapWithPatchingMoveWith
549− :: forall k p p' a
550− . (PatchTarget1 p a -> PatchTarget p')
551− -> (p a a -> p')
552− -> PatchDMapWithMove (Const2 k a) p
553− -> PatchMapWithPatchingMove k p'
554−patchDMapWithMoveToPatchMapWithPatchingMoveWith f g (PatchDMapWithMove m) =
555− PatchMapWithPatchingMove $ dmapToMapWith h m
556− where h :: NodeInfo (Const2 k a) p a -> MapWithPatchingMove.NodeInfo k p'
557− h ni = MapWithPatchingMove.NodeInfo
558− { MapWithPatchingMove._nodeInfo_from = case _nodeInfo_from ni of
559− From_Insert v -> MapWithPatchingMove.From_Insert $ f v
560− From_Delete -> MapWithPatchingMove.From_Delete
561− From_Move (Const2 k :=> Flip p) -> MapWithPatchingMove.From_Move k $ g p
562− , MapWithPatchingMove._nodeInfo_to = case _nodeInfo_to ni of
563− To_NonMove -> Nothing
564− To_Move (Const2 k :=> _) -> Just k
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)
565336 }
566337
567−-- | "Strengthen" a @'PatchMapWithPatchingMove' k v@ into a @'PatchDMapWithMove
568−-- ('Const2' k a)@; that is, turn a non-dependently-typed patch into a
569−-- dependently typed one but which always has a constant key type represented by
570−-- 'Const2'. Apply the given function to each @v@ to produce a @PatchTarget1 p'
571−-- a@. Completemented by 'patchDMapWithMoveToPatchMapWithPatchingMoveWith'
572−const2PatchDMapWithMoveWith
573− :: forall k v v' a
574− . (v -> v' a)
575− -> PatchMapWithPatchingMove k (Proxy v)
576− -> PatchDMapWithMove (Const2 k a) (Proxy3 v')
577−const2PatchDMapWithMoveWith f (PatchMapWithPatchingMove p) =
578− PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
579− where g :: (k, MapWithPatchingMove.NodeInfo k (Proxy v))
580− -> 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')
581344 g (k, ni) = Const2 k :=> NodeInfo
582− { _nodeInfo_from = case MapWithPatchingMove._nodeInfo_from ni of
583− MapWithPatchingMove.From_Insert v -> From_Insert $ f v
584− MapWithPatchingMove.From_Delete -> From_Delete
585− MapWithPatchingMove.From_Move fromKey Proxy -> From_Move $ Const2 fromKey :=> Flip Proxy3
586− , _nodeInfo_to = case MapWithPatchingMove._nodeInfo_to ni of
587− Nothing -> To_NonMove
588− Just toKey -> To_Move $ Const2 toKey :=> Proxy3
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
589350 }
590351
591352-- | Apply the insertions, deletions, and moves to a given 'DMap'.
592−instance ( GCompare k
593− , PatchHet2 p
594− , PatchSource1 p ~ PatchTarget1 p
595− ) => PatchHet (PatchDMapWithMove k p) where
596− type PatchSource (PatchDMapWithMove k p) = DMap k (PatchSource1 p)
597− type PatchTarget (PatchDMapWithMove k p) = DMap k (PatchTarget1 p)
598−
599−instance ( GCompare k
600− , PatchHet2 p
601− , PatchSource1 p ~ PatchTarget1 p
602− ) => Patch (PatchDMapWithMove k p) where
603− apply (PatchDMapWithMove m) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions)
604− -- TODO: return Nothing sometimes --Note: the strict application here is
605− -- critical to ensuring that incremental merges don't hold onto all their
606− -- prerequisite events forever; can we make this more robust?
607− where insertions = DMap.mapMaybeWithKey insertFunc m
608− insertFunc :: forall a. k a -> NodeInfo k p a -> Maybe (PatchTarget1 p a)
353+instance GCompare k => PatchHet (PatchDMapWithMove k v) where
354+ type PatchSource (PatchDMapWithMove k v) = DMap k v
355+ type PatchTarget (PatchDMapWithMove k v) = DMap k v
356+
357+instance GCompare k => Patch (PatchDMapWithMove k v) where
358+ 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?
359+ where insertions = DMap.mapMaybeWithKey insertFunc p
360+ insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
609361 insertFunc _ ni = case _nodeInfo_from ni of
610362 From_Insert v -> Just v
611− From_Move (k :=> Flip p) -> applyAlwaysHet2 p <$> DMap.lookup k old
363+ From_Move k -> DMap.lookup k old
612364 From_Delete -> Nothing
613− deletions = DMap.mapMaybeWithKey deleteFunc m
614− deleteFunc :: forall a. k a -> NodeInfo k p a -> Maybe (Constant () a)
365+ deletions = DMap.mapMaybeWithKey deleteFunc p
366+ deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
615367 deleteFunc _ ni = case _nodeInfo_from ni of
616368 From_Delete -> Just $ Constant ()
617369 _ -> Nothing
618370
619−-- | Get the values that will be replaced, deleted, or moved if the given patch
620−-- is applied to the given 'DMap'.
621−getDeletionsAndMoves
622− :: ( GCompare k
623− , PatchSource1 p ~ PatchTarget1 p
624− )
625− => PatchDMapWithMove k p
626− -> DMap k (PatchSource1 p)
627− -> DMap k (Product (PatchTarget1 p) (To k p))
371+-- | Get the values that will be replaced, deleted, or moved if the given patch is applied to the given 'DMap'.
372+getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
628373getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
629374 where f _ v ni = Pair v $ _nodeInfo_to ni