@@ -19,9 +19,7 @@
19module Data.Patch.MapWithMove
19module Data.Patch.MapWithMove
20 ( PatchMapWithMove
20 ( PatchMapWithMove
21 ( PatchMapWithMove
21 ( PatchMapWithMove
22− , -- | Extract the representation of the 'PatchMapWithMove' as a map of
24− unPatchMapWithMove
22+ , unPatchMapWithMove
27 , patchMapWithMove
25 , patchMapWithMove
@@ -65,13 +63,10 @@ module Data.Patch.MapWithMove
65import Data.Coerce
63import Data.Coerce
66import Data.Kind (Type)
64import Data.Kind (Type)
67import Data.Patch.Class
65import Data.Patch.Class
68−import Data.Patch.MapWithPatchingMove
66+import Data.Patch.MapWithPatchingMove (PatchMapWithPatchingMove(..), To)
69− ( PatchMapWithPatchingMove (..)
71−import qualified Data.Patch.MapWithPatchingMove as PM
67+import qualified Data.Patch.MapWithPatchingMove as PM -- already a transparent synonym
72−import Data.Patch.MapWithPatchingMove (To) -- already a transparent synonym
74−import Control.Lens hiding (from, to)
69+import Control.Lens
75import Data.List
70import Data.List
76import Data.Map (Map)
71import Data.Map (Map)
77import qualified Data.Map as Map
72import qualified Data.Map as Map
@@ -89,9 +84,13 @@ newtype PatchMapWithMove k (v :: Type) = PatchMapWithMove'
89 unPatchMapWithMove' :: PatchMapWithPatchingMove k (Proxy v)
84 unPatchMapWithMove' :: PatchMapWithPatchingMove k (Proxy v)
91 deriving ( Show, Read, Eq, Ord
86 deriving ( Show, Read, Eq, Ord
87+-- Haddock cannot handle documentation here before GHC 8.6
89+#if __GLASGOW_HASKELL__ >= 806
92− , -- | Compose patches having the same effect as applying the
90+ -- | Compose patches having the same effect as applying the
93 -- patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p .
91 -- patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p .
94 -- 'applyAlways' q@
92 -- 'applyAlways' q@
@@ -102,6 +101,8 @@ pattern Coerce x <- (coerce -> x)
103{-# COMPLETE PatchMapWithMove #-}
102{-# COMPLETE PatchMapWithMove #-}
104pattern PatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
103pattern PatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
104+-- | Extract the representation of the 'PatchMapWithMove' as a map of
105unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
106unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
106pattern PatchMapWithMove { unPatchMapWithMove } = PatchMapWithMove' (PatchMapWithPatchingMove (Coerce unPatchMapWithMove))
107pattern PatchMapWithMove { unPatchMapWithMove } = PatchMapWithMove' (PatchMapWithPatchingMove (Coerce unPatchMapWithMove))
@@ -136,7 +137,7 @@ instance TraversableWithIndex k (PatchMapWithMove k) where
137-- | Create a 'PatchMapWithMove', validating it
138-- | Create a 'PatchMapWithMove', validating it
138patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
139patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
139−patchMapWithMove = fmap coerce . PM.patchMapWithPatchingMove . coerce
140+patchMapWithMove = fmap PatchMapWithMove' . PM.patchMapWithPatchingMove . coerce
141-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
142-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
142patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
143patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
@@ -159,8 +160,8 @@ moveMapKey src dst = PatchMapWithMove' $ PM.moveMapKey src dst
160-- let aMay = Map.lookup a map
161-- let aMay = Map.lookup a map
161-- bMay = Map.lookup b map
162-- bMay = Map.lookup b map
162−-- in maybe id (Map.insert a) (bMay `mplus` aMay)
163+-- in maybe id (Map.insert a) (bMay <> aMay)
163−-- . maybe id (Map.insert b) (aMay `mplus` bMay)
164+-- . maybe id (Map.insert b) (aMay <> bMay)
164-- . Map.delete a . Map.delete b $ map
165-- . Map.delete a . Map.delete b $ map
166swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
167swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
@@ -174,7 +175,7 @@ deleteMapKey = PatchMapWithMove' . PM.deleteMapKey
175-- __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.
176unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
177unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
177−unsafePatchMapWithMove = PatchMapWithMove' . PM.unsafePatchMapWithPatchingMove . coerce
178+unsafePatchMapWithMove = coerce PM.unsafePatchMapWithPatchingMove
179-- | Apply the insertions, deletions, and moves to a given 'Map'
180-- | Apply the insertions, deletions, and moves to a given 'Map'
180instance Ord k => Patch (PatchMapWithMove k v) where
181instance Ord k => Patch (PatchMapWithMove k v) where
@@ -198,7 +199,7 @@ patchThatSortsMapWith cmp = PatchMapWithMove' . PM.patchThatSortsMapWith cmp
198-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
199-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
199-- 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
200-- values sorted with the given ordering function.
201-- values sorted with the given ordering function.
201−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
202patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
203patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
203 where newList = Map.toList newByIndexUnsorted
204 where newList = Map.toList newByIndexUnsorted
204 newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
205 newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
@@ -226,11 +227,11 @@ deriving instance (Ord k, Ord p) => Ord (NodeInfo k p)
226pattern NodeInfo :: To k -> From k v -> NodeInfo k v
227pattern NodeInfo :: To k -> From k v -> NodeInfo k v
227_nodeInfo_to :: NodeInfo k v -> To k
228_nodeInfo_to :: NodeInfo k v -> To k
228_nodeInfo_from :: NodeInfo k v -> From k v
229_nodeInfo_from :: NodeInfo k v -> From k v
229−pattern NodeInfo { _nodeInfo_to, _nodeInfo_from } =
230+pattern NodeInfo { _nodeInfo_to, _nodeInfo_from } = NodeInfo'
230− NodeInfo' (PM.NodeInfo
231+ PM.NodeInfo
231 { PM._nodeInfo_to = _nodeInfo_to
232 { PM._nodeInfo_to = _nodeInfo_to
232 , PM._nodeInfo_from = Coerce _nodeInfo_from
233 , PM._nodeInfo_from = Coerce _nodeInfo_from
@@ -247,24 +248,20 @@ instance Foldable (NodeInfo k) where
247 foldMap = foldMapDefault
248 foldMap = foldMapDefault
249instance Traversable (NodeInfo k) where
250instance Traversable (NodeInfo k) where
250− traverse = _NodeInfo . traverseNodeInfo
253− :: Traversal (PM.NodeInfo k (Proxy a)) (PM.NodeInfo k (Proxy b)) a b
254− traverseNodeInfo = PM.bitraverseNodeInfo pure (\ ~Proxy -> pure Proxy)
251+ traverse = bitraverseNodeInfo pure
256bitraverseNodeInfo
253bitraverseNodeInfo
257 :: Applicative f
254 :: Applicative f
258 => (k0 -> f k1)
255 => (k0 -> f k1)
259 -> (v0 -> f v1)
256 -> (v0 -> f v1)
260 -> NodeInfo k0 v0 -> f (NodeInfo k1 v1)
257 -> NodeInfo k0 v0 -> f (NodeInfo k1 v1)
261−bitraverseNodeInfo fk fv = fmap coerce
258+bitraverseNodeInfo fk fv = fmap NodeInfo'
262 . PM.bitraverseNodeInfo fk (\ ~Proxy -> pure Proxy) fv
259 . PM.bitraverseNodeInfo fk (\ ~Proxy -> pure Proxy) fv
265-- | Change the 'From' value of a 'NodeInfo'
262-- | Change the 'From' value of a 'NodeInfo'
266nodeInfoMapFrom :: (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
267−nodeInfoMapFrom f = coerce . PM.nodeInfoMapFrom (unFrom' . f . From') . coerce
264+nodeInfoMapFrom f = coerce $ PM.nodeInfoMapFrom (unFrom' . f . From')
269-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
266-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
270-- 'Applicative', 'Monad', etc.) action to get the new value
267-- 'Applicative', 'Monad', etc.) action to get the new value
@@ -272,7 +269,7 @@ nodeInfoMapMFrom
272 :: Functor f
269 :: Functor f
273 => (From k v -> f (From k v))
270 => (From k v -> f (From k v))
274 -> NodeInfo k v -> f (NodeInfo k v)
271 -> NodeInfo k v -> f (NodeInfo k v)
275−nodeInfoMapMFrom f = fmap coerce
272+nodeInfoMapMFrom f = fmap NodeInfo'
276 . PM.nodeInfoMapMFrom (fmap unFrom' . f . From')
273 . PM.nodeInfoMapMFrom (fmap unFrom' . f . From')
@@ -295,7 +292,7 @@ pattern From_Insert v = From' (PM.From_Insert v)
296-- | Delete the existing value, if any, from here
293-- | Delete the existing value, if any, from here
297pattern From_Delete :: From k v
294pattern From_Delete :: From k v
298−pattern From_Delete = From' (PM.From_Delete)
295+pattern From_Delete = From' PM.From_Delete
300-- | Move the value here from the given key
297-- | Move the value here from the given key
301pattern From_Move :: k -> From k v
298pattern From_Move :: k -> From k v
@@ -306,9 +303,10 @@ bitraverseFrom
306 => (k0 -> f k1)
303 => (k0 -> f k1)
307 -> (v0 -> f v1)
304 -> (v0 -> f v1)
308 -> From k0 v0 -> f (From k1 v1)
305 -> From k0 v0 -> f (From k1 v1)
309−bitraverseFrom fk fv = fmap coerce
306+bitraverseFrom fk fv = fmap From'
310 . PM.bitraverseFrom fk (\ ~Proxy -> pure Proxy) fv
307 . PM.bitraverseFrom fk (\ ~Proxy -> pure Proxy) fv
313makeWrapped ''PatchMapWithMove
310makeWrapped ''PatchMapWithMove
314makeWrapped ''NodeInfo
311makeWrapped ''NodeInfo