@@ -2,98 +2,150 @@
2{-# LANGUAGE DeriveTraversable #-}
2{-# LANGUAGE DeriveTraversable #-}
3{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5{-# LANGUAGE LambdaCase #-}
6{-# LANGUAGE LambdaCase #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE PatternGuards #-}
8{-# LANGUAGE PatternGuards #-}
9+{-# LANGUAGE PatternSynonyms #-}
8{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
11+{-# LANGUAGE StandaloneDeriving #-}
9{-# LANGUAGE TemplateHaskell #-}
12{-# LANGUAGE TemplateHaskell #-}
10{-# LANGUAGE TypeApplications #-}
13{-# LANGUAGE TypeApplications #-}
11{-# LANGUAGE TypeFamilies #-}
14{-# LANGUAGE TypeFamilies #-}
15+{-# LANGUAGE ViewPatterns #-}
13-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
17-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
15−module Data.Patch.MapWithMove where
19+module Data.Patch.MapWithMove
26+ , patchMapWithMoveInsertAll
31+ , unsafePatchMapWithMove
32+ , patchMapWithMoveNewElements
33+ , patchMapWithMoveNewElementsMap
34+ , patchThatSortsMapWith
35+ , patchThatChangesAndSortsMapWith
36+ , patchThatChangesMap
64+import Data.Kind (Type)
17import Data.Patch.Class
65import Data.Patch.Class
66+import Data.Patch.MapWithPatchingMove (PatchMapWithPatchingMove(..), To)
67+import qualified Data.Patch.MapWithPatchingMove as PM -- already a transparent synonym
19−import Control.Arrow
69+import Control.Lens
20−import Control.Lens hiding (from, to)
21−import Control.Monad.Trans.State
24import Data.List
70import Data.List
25import Data.Map (Map)
71import Data.Map (Map)
26import qualified Data.Map as Map
72import qualified Data.Map as Map
27−import Data.Maybe
73+import Data.Proxy
28#if !MIN_VERSION_base(4,11,0)
74#if !MIN_VERSION_base(4,11,0)
29import Data.Semigroup (Semigroup (..))
75import Data.Semigroup (Semigroup (..))
31−import qualified Data.Set as Set
77+import Data.Traversable (foldMapDefault)
32−import Data.These (These(..))
35-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
79-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
36-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
80-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
37-- and vice versa. There should never be any unpaired From/To keys.
81-- and vice versa. There should never be any unpaired From/To keys.
38−newtype PatchMapWithMove k v = PatchMapWithMove
82+newtype PatchMapWithMove k (v :: Type) = PatchMapWithMove'
39− { -- | Extract the internal representation of the 'PatchMapWithMove'
83+ { -- | Extract the underlying 'PatchMapWithPatchingMove k (Proxy v)'
40− unPatchMapWithMove :: Map k (NodeInfo k v)
84+ unPatchMapWithMove' :: PatchMapWithPatchingMove k (Proxy v)
42 deriving ( Show, Read, Eq, Ord
86 deriving ( Show, Read, Eq, Ord
43− , Functor, Foldable, Traversable
87+-- Haddock cannot handle documentation here before GHC 8.6
89+#if __GLASGOW_HASKELL__ >= 806
90+ -- | Compose patches having the same effect as applying the
91+ -- patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p .
46−-- | Holds the information about each key: where its new value should come from,
98+pattern Coerce :: Coercible a b => a -> b
47−-- and where its old value should go to
99+pattern Coerce x <- (coerce -> x)
48−data NodeInfo k v = NodeInfo
100+ where Coerce x = coerce x
49− { _nodeInfo_from :: !(From k v)
50− -- ^ Where do we get the new value for this key?
51− , _nodeInfo_to :: !(To k)
52− -- ^ If the old value is being kept (i.e. moved rather than deleted or
53− -- replaced), where is it going?
55− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
57−-- | Describe how a key's new value should be produced
102+{-# COMPLETE PatchMapWithMove #-}
58−data From k v
103+pattern PatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
59− = From_Insert v -- ^ Insert the given value here
104+-- | Extract the representation of the 'PatchMapWithMove' as a map of
60− | From_Delete -- ^ Delete the existing value, if any, from here
105+-- 'NodeInfo'.
61− | From_Move !k -- ^ Move the value here from the given key
106+unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
62− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
107+pattern PatchMapWithMove { unPatchMapWithMove } = PatchMapWithMove' (PatchMapWithPatchingMove (Coerce unPatchMapWithMove))
64−-- | Describe where a key's old value will go. If this is 'Just', that means
109+_PatchMapWithMove
65−-- the key's old value will be moved to the given other key; if it is 'Nothing',
110+ :: Iso
66−-- that means it will be deleted.
111+ (PatchMapWithMove k0 v0)
67−type To = Maybe
112+ (PatchMapWithMove k1 v1)
113+ (Map k0 (NodeInfo k0 v0))
114+ (Map k1 (NodeInfo k1 v1))
115+_PatchMapWithMove = iso unPatchMapWithMove PatchMapWithMove
117+instance Functor (PatchMapWithMove k) where
118+ fmap f = runIdentity . traverse (Identity . f)
120+instance Foldable (PatchMapWithMove k) where
121+ foldMap = foldMapDefault
69−makeWrapped ''PatchMapWithMove
123+instance Traversable (PatchMapWithMove k) where
71instance FunctorWithIndex k (PatchMapWithMove k)
129instance FunctorWithIndex k (PatchMapWithMove k)
72instance FoldableWithIndex k (PatchMapWithMove k)
130instance FoldableWithIndex k (PatchMapWithMove k)
73instance TraversableWithIndex k (PatchMapWithMove k) where
131instance TraversableWithIndex k (PatchMapWithMove k) where
74 itraverse = itraversed . Indexed
132 itraverse = itraversed . Indexed
75− itraversed = _Wrapped .> itraversed <. traversed
133+ itraversed =
134+ _PatchMapWithMove .>
77-- | Create a 'PatchMapWithMove', validating it
138-- | Create a 'PatchMapWithMove', validating it
78patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
139patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
79−patchMapWithMove m = if valid then Just $ PatchMapWithMove m else Nothing
140+patchMapWithMove = fmap PatchMapWithMove' . PM.patchMapWithPatchingMove . coerce
80− where valid = forwardLinks == backwardLinks
81− forwardLinks = Map.mapMaybe _nodeInfo_to m
82− backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, v) ->
83− case _nodeInfo_from v of
84− From_Move from -> Just (from, to)
87-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
142-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
88patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
143patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
89−patchMapWithMoveInsertAll m = PatchMapWithMove $ flip fmap m $ \v -> NodeInfo
144+patchMapWithMoveInsertAll = PatchMapWithMove' . PM.patchMapWithPatchingMoveInsertAll
90− { _nodeInfo_from = From_Insert v
91− , _nodeInfo_to = Nothing
94-- | Make a @'PatchMapWithMove' k v@ which has the effect of inserting or updating a value @v@ to the given key @k@, like 'Map.insert'.
146-- | Make a @'PatchMapWithMove' k v@ which has the effect of inserting or updating a value @v@ to the given key @k@, like 'Map.insert'.
95insertMapKey :: k -> v -> PatchMapWithMove k v
147insertMapKey :: k -> v -> PatchMapWithMove k v
96−insertMapKey k v = PatchMapWithMove . Map.singleton k $ NodeInfo (From_Insert v) Nothing
148+insertMapKey k v = PatchMapWithMove' $ PM.insertMapKey k v
98-- |Make a @'PatchMapWithMove' k v@ which has the effect of moving the value from the first key @k@ to the second key @k@, equivalent to:
150-- |Make a @'PatchMapWithMove' k v@ which has the effect of moving the value from the first key @k@ to the second key @k@, equivalent to:
@@ -101,84 +153,53 @@ insertMapKey k v = PatchMapWithMove . Map.singleton k $ NodeInfo (From_Insert v)
101-- 'Map.delete' src (maybe map ('Map.insert' dst) (Map.lookup src map))
153-- 'Map.delete' src (maybe map ('Map.insert' dst) (Map.lookup src map))
103moveMapKey :: Ord k => k -> k -> PatchMapWithMove k v
155moveMapKey :: Ord k => k -> k -> PatchMapWithMove k v
104−moveMapKey src dst
156+moveMapKey src dst = PatchMapWithMove' $ PM.moveMapKey src dst
105− | src == dst = mempty
107− PatchMapWithMove $ Map.fromList
108− [ (dst, NodeInfo (From_Move src) Nothing)
109− , (src, NodeInfo From_Delete (Just dst))
112-- |Make a @'PatchMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
158-- |Make a @'PatchMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
115-- let aMay = Map.lookup a map
161-- let aMay = Map.lookup a map
116-- bMay = Map.lookup b map
162-- bMay = Map.lookup b map
117−-- in maybe id (Map.insert a) (bMay `mplus` aMay)
163+-- in maybe id (Map.insert a) (bMay <> aMay)
118−-- . maybe id (Map.insert b) (aMay `mplus` bMay)
164+-- . maybe id (Map.insert b) (aMay <> bMay)
119-- . Map.delete a . Map.delete b $ map
165-- . Map.delete a . Map.delete b $ map
121swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
167swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
122−swapMapKey src dst
168+swapMapKey src dst = PatchMapWithMove' $ PM.swapMapKey src dst
123− | src == dst = mempty
125− PatchMapWithMove $ Map.fromList
126− [ (dst, NodeInfo (From_Move src) (Just src))
127− , (src, NodeInfo (From_Move dst) (Just dst))
130-- |Make a @'PatchMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'Map.delete'.
170-- |Make a @'PatchMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'Map.delete'.
131deleteMapKey :: k -> PatchMapWithMove k v
171deleteMapKey :: k -> PatchMapWithMove k v
132−deleteMapKey k = PatchMapWithMove . Map.singleton k $ NodeInfo From_Delete Nothing
172+deleteMapKey = PatchMapWithMove' . PM.deleteMapKey
134-- | Wrap a @'Map' k (NodeInfo k v)@ representing patch changes into a @'PatchMapWithMove' k v@, without checking any invariants.
174-- | Wrap a @'Map' k (NodeInfo k v)@ representing patch changes into a @'PatchMapWithMove' k v@, without checking any invariants.
136-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithMove' are preserved; they will not be checked.
176-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithMove' are preserved; they will not be checked.
137unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
177unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
138−unsafePatchMapWithMove = PatchMapWithMove
178+unsafePatchMapWithMove = coerce PM.unsafePatchMapWithPatchingMove
140-- | Apply the insertions, deletions, and moves to a given 'Map'
180-- | Apply the insertions, deletions, and moves to a given 'Map'
141instance Ord k => Patch (PatchMapWithMove k v) where
181instance Ord k => Patch (PatchMapWithMove k v) where
142 type PatchTarget (PatchMapWithMove k v) = Map k v
182 type PatchTarget (PatchMapWithMove k v) = Map k v
143− apply (PatchMapWithMove p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
183+ apply (PatchMapWithMove' p) = apply p
144− where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
145− From_Insert v -> Just v
146− From_Move k -> Map.lookup k old
147− From_Delete -> Nothing
148− deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
149− From_Delete -> Just ()
152-- | Returns all the new elements that will be added to the 'Map'.
185-- | Returns all the new elements that will be added to the 'Map'.
153patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
186patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
154−patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
187+patchMapWithMoveNewElements = PM.patchMapWithPatchingMoveNewElements . unPatchMapWithMove'
156-- | Return a @'Map' k v@ with all the inserts/updates from the given @'PatchMapWithMove' k v@.
189-- | Return a @'Map' k v@ with all the inserts/updates from the given @'PatchMapWithMove' k v@.
157patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
190patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
158−patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
191+patchMapWithMoveNewElementsMap = PM.patchMapWithPatchingMoveNewElementsMap . unPatchMapWithMove'
159− where f ni = case _nodeInfo_from ni of
160− From_Insert v -> Just v
161− From_Move _ -> Nothing
162− From_Delete -> Nothing
164-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
193-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
165-- its values using the given ordering function. The set keys of the 'Map' is
194-- its values using the given ordering function. The set keys of the 'Map' is
166-- not changed.
195-- not changed.
167patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
196patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
168−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
197+patchThatSortsMapWith cmp = PatchMapWithMove' . PM.patchThatSortsMapWith cmp
169− where unsorted = Map.toList m
170− sorted = sortBy (cmp `on` snd) unsorted
171− f (to, _) (from, _) = if to == from then Nothing else
173− reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
174− g (to, _) (from, _) = if to == from then Nothing else
175− let Just movingTo = Map.lookup to reverseMapping
176− in Just (to, NodeInfo (From_Move from) $ Just movingTo)
178-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
199-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
179-- will produce a 'Map' with the same values as the second 'Map' but with the
200-- will produce a 'Map' with the same values as the second 'Map' but with the
180-- values sorted with the given ordering function.
201-- values sorted with the given ordering function.
181−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
202+patchThatChangesAndSortsMapWith :: (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
182patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
203patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
183 where newList = Map.toList newByIndexUnsorted
204 where newList = Map.toList newByIndexUnsorted
184 newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
205 newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
@@ -186,104 +207,106 @@ patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatCha
186-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
207-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
187-- will produce the second 'Map'.
208-- will produce the second 'Map'.
188patchThatChangesMap :: (Ord k, Ord v) => Map k v -> Map k v -> PatchMapWithMove k v
209patchThatChangesMap :: (Ord k, Ord v) => Map k v -> Map k v -> PatchMapWithMove k v
189−patchThatChangesMap oldByIndex newByIndex = patch
210+patchThatChangesMap oldByIndex newByIndex = PatchMapWithMove' $
190− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
211+ PM.patchThatChangesMap oldByIndex newByIndex
191− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
212+
192− let f k v = do
213+--
193− remainingValues <- get
214+-- NodeInfo
194− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
215+--
195− then Map.delete v remainingValues
216+
196− else Map.insert v remainingKeys remainingValues
217+-- | Holds the information about each key: where its new value should come from,
197− case Map.lookup v remainingValues of
218+-- and where its old value should go to
198− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
219+newtype NodeInfo k (v :: Type) = NodeInfo' { unNodeInfo' :: PM.NodeInfo k (Proxy v) }
200− if k `Set.member` fromKs
221+deriving instance (Show k, Show p) => Show (NodeInfo k p)
201− then do
222+deriving instance (Read k, Read p) => Read (NodeInfo k p)
202− putRemainingKeys $ Set.delete k fromKs
223+deriving instance (Eq k, Eq p) => Eq (NodeInfo k p)
203− return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
224+deriving instance (Ord k, Ord p) => Ord (NodeInfo k p)
205− (fromK, remainingKeys) <- return $
226+{-# COMPLETE NodeInfo #-}
206− fromMaybe (error "PatchMapWithMove.patchThatChangesMap: impossible: fromKs was empty") $
227+pattern NodeInfo :: To k -> From k v -> NodeInfo k v
207− Set.minView fromKs -- There's an existing value, but it's not here; move it here
228+_nodeInfo_to :: NodeInfo k v -> To k
208− putRemainingKeys remainingKeys
229+_nodeInfo_from :: NodeInfo k v -> From k v
209− return $ NodeInfo (From_Move fromK) $ Just undefined
230+pattern NodeInfo { _nodeInfo_to, _nodeInfo_from } = NodeInfo'
210− Map.traverseWithKey f newByIndex
231+ PM.NodeInfo
211− unusedOldKeys = fold unusedValuesByValue
232+ { PM._nodeInfo_to = _nodeInfo_to
212− pointlessMove k = \case
233+ , PM._nodeInfo_from = Coerce _nodeInfo_from
213− From_Move k' | k == k' -> True
234+ }
215− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
236+_NodeInfo
216− then Just undefined
237+ :: Iso
217− else Nothing
238+ (NodeInfo k0 v0)
218− patch = unsafePatchMapWithMove $ Map.filterWithKey (\k -> not . pointlessMove k . _nodeInfo_from) $ Map.mergeWithKey (\k a _ -> Just $ nodeInfoSetTo (keyWasMoved k) a) (Map.mapWithKey $ \k -> nodeInfoSetTo $ keyWasMoved k) (Map.mapWithKey $ \k _ -> NodeInfo From_Delete $ keyWasMoved k) insertsAndMoves oldByIndex
239+ (NodeInfo k1 v1)
240+ (PM.NodeInfo k0 (Proxy v0))
241+ (PM.NodeInfo k1 (Proxy v1))
242+_NodeInfo = iso unNodeInfo' NodeInfo'
244+instance Functor (NodeInfo k) where
245+ fmap f = runIdentity . traverse (Identity . f)
247+instance Foldable (NodeInfo k) where
248+ foldMap = foldMapDefault
250+instance Traversable (NodeInfo k) where
251+ traverse = bitraverseNodeInfo pure
257+ -> NodeInfo k0 v0 -> f (NodeInfo k1 v1)
258+bitraverseNodeInfo fk fv = fmap NodeInfo'
259+ . PM.bitraverseNodeInfo fk (\ ~Proxy -> pure Proxy) fv
220-- | Change the 'From' value of a 'NodeInfo'
262-- | Change the 'From' value of a 'NodeInfo'
221nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
263nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
222−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
264+nodeInfoMapFrom f = coerce $ PM.nodeInfoMapFrom (unFrom' . f . From')
224-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
266-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
225-- 'Applicative', 'Monad', etc.) action to get the new value
267-- 'Applicative', 'Monad', etc.) action to get the new value
270+ => (From k v -> f (From k v))
226−nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
271+ -> NodeInfo k v -> f (NodeInfo k v)
227−nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
272+nodeInfoMapMFrom f = fmap NodeInfo'
273+ . PM.nodeInfoMapMFrom (fmap unFrom' . f . From')
229-- | Set the 'To' field of a 'NodeInfo'
276-- | Set the 'To' field of a 'NodeInfo'
230nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
277nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
231−nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
278+nodeInfoSetTo = coerce . PM.nodeInfoSetTo
233−-- |Helper data structure used for composing patches using the monoid instance.
280+--
234−data Fixup k v
281+-- From
235− = Fixup_Delete
282+--
236− | Fixup_Update (These (From k v) (To k))
283+
237−
284+-- | Describe how a key's new value should be produced
238−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
285+newtype From k (v :: Type) = From' { unFrom' :: PM.From k (Proxy v) }
239−instance Ord k => Semigroup (PatchMapWithMove k v) where
286+
240− PatchMapWithMove ma <> PatchMapWithMove mb = PatchMapWithMove m
287+{-# COMPLETE From_Insert, From_Delete, From_Move #-}
242− connections = Map.toList $ Map.intersectionWithKey (\_ a b -> (_nodeInfo_to a, _nodeInfo_from b)) ma mb
289+-- | Insert the given value here
243− h :: (k, (Maybe k, From k v)) -> [(k, Fixup k v)]
290+pattern From_Insert :: v -> From k v
244− h (_, (mToAfter, editBefore)) = case (mToAfter, editBefore) of
291+pattern From_Insert v = From' (PM.From_Insert v)
245− (Just toAfter, From_Move fromBefore)
292+
246− | fromBefore == toAfter
293+-- | Delete the existing value, if any, from here
247− -> [(toAfter, Fixup_Delete)]
294+pattern From_Delete :: From k v
248− | otherwise
295+pattern From_Delete = From' PM.From_Delete
249− -> [ (toAfter, Fixup_Update (This editBefore))
296+
250− , (fromBefore, Fixup_Update (That mToAfter))
297+-- | Move the value here from the given key
251− ]
298+pattern From_Move :: k -> From k v
252− (Nothing, From_Move fromBefore) -> [(fromBefore, Fixup_Update (That mToAfter))] -- The item is destroyed in the second patch, so indicate that it is destroyed in the source map
299+pattern From_Move k = From' (PM.From_Move k Proxy)
253− (Just toAfter, _) -> [(toAfter, Fixup_Update (This editBefore))]
300+
254− (Nothing, _) -> []
301+bitraverseFrom
255− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
302+ :: Applicative f
256− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
303+ => (k0 -> f k1)
257− | This x <- a, That y <- b
304+ -> (v0 -> f v1)
258− = Fixup_Update $ These x y
305+ -> From k0 v0 -> f (From k1 v1)
259− | That y <- a, This x <- b
306+bitraverseFrom fk fv = fmap From'
260− = Fixup_Update $ These x y
307+ . PM.bitraverseFrom fk (\ ~Proxy -> pure Proxy) fv
261− mergeFixups _ _ _ = error "PatchMapWithMove: incompatible fixups"
308+ . coerce
262− fixups = Map.fromListWithKey mergeFixups $ concatMap h connections
309+
263− combineNodeInfos _ nia nib = NodeInfo
310+makeWrapped ''PatchMapWithMove
264− { _nodeInfo_from = _nodeInfo_from nia
311+makeWrapped ''NodeInfo
265− , _nodeInfo_to = _nodeInfo_to nib
312+makeWrapped ''From
267− applyFixup _ ni = \case
268− Fixup_Delete -> Nothing
269− Fixup_Update u -> Just $ NodeInfo
270− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
271− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
273− m = Map.differenceWithKey applyFixup (Map.unionWithKey combineNodeInfos ma mb) fixups
274− getHere :: These a b -> Maybe a
279− getThere :: These a b -> Maybe b
285−--TODO: Figure out how to implement this in terms of PatchDMapWithMove rather than duplicating it here
286−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
287−instance Ord k => Monoid (PatchMapWithMove k v) where
288− mempty = PatchMapWithMove mempty