module BytePatch.Core where

-- | A single in-place edit.
--
-- Overwrites may store extra metadata that can be used at patch time to
-- validate input data (i.e. check we're patching the expected file).
data Overwrite a = Overwrite a (OverwriteMeta a)
    deriving (Overwrite a -> Overwrite a -> Bool
(Overwrite a -> Overwrite a -> Bool)
-> (Overwrite a -> Overwrite a -> Bool) -> Eq (Overwrite a)
forall a. Eq a => Overwrite a -> Overwrite a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Overwrite a -> Overwrite a -> Bool
$c/= :: forall a. Eq a => Overwrite a -> Overwrite a -> Bool
== :: Overwrite a -> Overwrite a -> Bool
$c== :: forall a. Eq a => Overwrite a -> Overwrite a -> Bool
Eq, Int -> Overwrite a -> ShowS
[Overwrite a] -> ShowS
Overwrite a -> String
(Int -> Overwrite a -> ShowS)
-> (Overwrite a -> String)
-> ([Overwrite a] -> ShowS)
-> Show (Overwrite a)
forall a. Show a => Int -> Overwrite a -> ShowS
forall a. Show a => [Overwrite a] -> ShowS
forall a. Show a => Overwrite a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Overwrite a] -> ShowS
$cshowList :: forall a. Show a => [Overwrite a] -> ShowS
show :: Overwrite a -> String
$cshow :: forall a. Show a => Overwrite a -> String
showsPrec :: Int -> Overwrite a -> ShowS
$cshowsPrec :: forall a. Show a => Int -> Overwrite a -> ShowS
Show)

-- | Optional patch time data for an overwrite.
data OverwriteMeta a = OverwriteMeta
  { OverwriteMeta a -> Maybe Int
omNullTerminates :: Maybe Int
  -- ^ Stream segment should be null bytes (0x00) only from this index onwards.

  , OverwriteMeta a -> Maybe a
omExpected       :: Maybe a
  -- ^ Stream segment should be this.
  } deriving (OverwriteMeta a -> OverwriteMeta a -> Bool
(OverwriteMeta a -> OverwriteMeta a -> Bool)
-> (OverwriteMeta a -> OverwriteMeta a -> Bool)
-> Eq (OverwriteMeta a)
forall a. Eq a => OverwriteMeta a -> OverwriteMeta a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: OverwriteMeta a -> OverwriteMeta a -> Bool
$c/= :: forall a. Eq a => OverwriteMeta a -> OverwriteMeta a -> Bool
== :: OverwriteMeta a -> OverwriteMeta a -> Bool
$c== :: forall a. Eq a => OverwriteMeta a -> OverwriteMeta a -> Bool
Eq, Int -> OverwriteMeta a -> ShowS
[OverwriteMeta a] -> ShowS
OverwriteMeta a -> String
(Int -> OverwriteMeta a -> ShowS)
-> (OverwriteMeta a -> String)
-> ([OverwriteMeta a] -> ShowS)
-> Show (OverwriteMeta a)
forall a. Show a => Int -> OverwriteMeta a -> ShowS
forall a. Show a => [OverwriteMeta a] -> ShowS
forall a. Show a => OverwriteMeta a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [OverwriteMeta a] -> ShowS
$cshowList :: forall a. Show a => [OverwriteMeta a] -> ShowS
show :: OverwriteMeta a -> String
$cshow :: forall a. Show a => OverwriteMeta a -> String
showsPrec :: Int -> OverwriteMeta a -> ShowS
$cshowsPrec :: forall a. Show a => Int -> OverwriteMeta a -> ShowS
Show, a -> OverwriteMeta b -> OverwriteMeta a
(a -> b) -> OverwriteMeta a -> OverwriteMeta b
(forall a b. (a -> b) -> OverwriteMeta a -> OverwriteMeta b)
-> (forall a b. a -> OverwriteMeta b -> OverwriteMeta a)
-> Functor OverwriteMeta
forall a b. a -> OverwriteMeta b -> OverwriteMeta a
forall a b. (a -> b) -> OverwriteMeta a -> OverwriteMeta b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
<$ :: a -> OverwriteMeta b -> OverwriteMeta a
$c<$ :: forall a b. a -> OverwriteMeta b -> OverwriteMeta a
fmap :: (a -> b) -> OverwriteMeta a -> OverwriteMeta b
$cfmap :: forall a b. (a -> b) -> OverwriteMeta a -> OverwriteMeta b
Functor, OverwriteMeta a -> Bool
(a -> m) -> OverwriteMeta a -> m
(a -> b -> b) -> b -> OverwriteMeta a -> b
(forall m. Monoid m => OverwriteMeta m -> m)
-> (forall m a. Monoid m => (a -> m) -> OverwriteMeta a -> m)
-> (forall m a. Monoid m => (a -> m) -> OverwriteMeta a -> m)
-> (forall a b. (a -> b -> b) -> b -> OverwriteMeta a -> b)
-> (forall a b. (a -> b -> b) -> b -> OverwriteMeta a -> b)
-> (forall b a. (b -> a -> b) -> b -> OverwriteMeta a -> b)
-> (forall b a. (b -> a -> b) -> b -> OverwriteMeta a -> b)
-> (forall a. (a -> a -> a) -> OverwriteMeta a -> a)
-> (forall a. (a -> a -> a) -> OverwriteMeta a -> a)
-> (forall a. OverwriteMeta a -> [a])
-> (forall a. OverwriteMeta a -> Bool)
-> (forall a. OverwriteMeta a -> Int)
-> (forall a. Eq a => a -> OverwriteMeta a -> Bool)
-> (forall a. Ord a => OverwriteMeta a -> a)
-> (forall a. Ord a => OverwriteMeta a -> a)
-> (forall a. Num a => OverwriteMeta a -> a)
-> (forall a. Num a => OverwriteMeta a -> a)
-> Foldable OverwriteMeta
forall a. Eq a => a -> OverwriteMeta a -> Bool
forall a. Num a => OverwriteMeta a -> a
forall a. Ord a => OverwriteMeta a -> a
forall m. Monoid m => OverwriteMeta m -> m
forall a. OverwriteMeta a -> Bool
forall a. OverwriteMeta a -> Int
forall a. OverwriteMeta a -> [a]
forall a. (a -> a -> a) -> OverwriteMeta a -> a
forall m a. Monoid m => (a -> m) -> OverwriteMeta a -> m
forall b a. (b -> a -> b) -> b -> OverwriteMeta a -> b
forall a b. (a -> b -> b) -> b -> OverwriteMeta a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
product :: OverwriteMeta a -> a
$cproduct :: forall a. Num a => OverwriteMeta a -> a
sum :: OverwriteMeta a -> a
$csum :: forall a. Num a => OverwriteMeta a -> a
minimum :: OverwriteMeta a -> a
$cminimum :: forall a. Ord a => OverwriteMeta a -> a
maximum :: OverwriteMeta a -> a
$cmaximum :: forall a. Ord a => OverwriteMeta a -> a
elem :: a -> OverwriteMeta a -> Bool
$celem :: forall a. Eq a => a -> OverwriteMeta a -> Bool
length :: OverwriteMeta a -> Int
$clength :: forall a. OverwriteMeta a -> Int
null :: OverwriteMeta a -> Bool
$cnull :: forall a. OverwriteMeta a -> Bool
toList :: OverwriteMeta a -> [a]
$ctoList :: forall a. OverwriteMeta a -> [a]
foldl1 :: (a -> a -> a) -> OverwriteMeta a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> OverwriteMeta a -> a
foldr1 :: (a -> a -> a) -> OverwriteMeta a -> a
$cfoldr1 :: forall a. (a -> a -> a) -> OverwriteMeta a -> a
foldl' :: (b -> a -> b) -> b -> OverwriteMeta a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> OverwriteMeta a -> b
foldl :: (b -> a -> b) -> b -> OverwriteMeta a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> OverwriteMeta a -> b
foldr' :: (a -> b -> b) -> b -> OverwriteMeta a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> OverwriteMeta a -> b
foldr :: (a -> b -> b) -> b -> OverwriteMeta a -> b
$cfoldr :: forall a b. (a -> b -> b) -> b -> OverwriteMeta a -> b
foldMap' :: (a -> m) -> OverwriteMeta a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> OverwriteMeta a -> m
foldMap :: (a -> m) -> OverwriteMeta a -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> OverwriteMeta a -> m
fold :: OverwriteMeta m -> m
$cfold :: forall m. Monoid m => OverwriteMeta m -> m
Foldable, Functor OverwriteMeta
Foldable OverwriteMeta
Functor OverwriteMeta
-> Foldable OverwriteMeta
-> (forall (f :: * -> *) a b.
    Applicative f =>
    (a -> f b) -> OverwriteMeta a -> f (OverwriteMeta b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    OverwriteMeta (f a) -> f (OverwriteMeta a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> OverwriteMeta a -> m (OverwriteMeta b))
-> (forall (m :: * -> *) a.
    Monad m =>
    OverwriteMeta (m a) -> m (OverwriteMeta a))
-> Traversable OverwriteMeta
(a -> f b) -> OverwriteMeta a -> f (OverwriteMeta b)
forall (t :: * -> *).
Functor t
-> Foldable t
-> (forall (f :: * -> *) a b.
    Applicative f =>
    (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a.
Monad m =>
OverwriteMeta (m a) -> m (OverwriteMeta a)
forall (f :: * -> *) a.
Applicative f =>
OverwriteMeta (f a) -> f (OverwriteMeta a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> OverwriteMeta a -> m (OverwriteMeta b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> OverwriteMeta a -> f (OverwriteMeta b)
sequence :: OverwriteMeta (m a) -> m (OverwriteMeta a)
$csequence :: forall (m :: * -> *) a.
Monad m =>
OverwriteMeta (m a) -> m (OverwriteMeta a)
mapM :: (a -> m b) -> OverwriteMeta a -> m (OverwriteMeta b)
$cmapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> OverwriteMeta a -> m (OverwriteMeta b)
sequenceA :: OverwriteMeta (f a) -> f (OverwriteMeta a)
$csequenceA :: forall (f :: * -> *) a.
Applicative f =>
OverwriteMeta (f a) -> f (OverwriteMeta a)
traverse :: (a -> f b) -> OverwriteMeta a -> f (OverwriteMeta b)
$ctraverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> OverwriteMeta a -> f (OverwriteMeta b)
$cp2Traversable :: Foldable OverwriteMeta
$cp1Traversable :: Functor OverwriteMeta
Traversable)