{-# LANGUAGE CPP #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE DefaultSignatures #-}
{-# LANGUAGE Trustworthy #-}
#if __GLASGOW_HASKELL__ >= 806
{-# LANGUAGE QuantifiedConstraints #-}
#endif

{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
--------------------------------------------------------------------
-- |
-- Copyright :  (c) Edward Kmett 2013-2015
-- License   :  BSD3
-- Maintainer:  Edward Kmett <ekmett@gmail.com>
-- Stability :  experimental
-- Portability: type-families
--
-- This module generalizes the @binary@ 'B.Get' and @cereal@ 'S.Get'
-- monads in an ad hoc fashion to permit code to be written that is
-- compatible across them.
--
-- Moreover, this class permits code to be written to be portable over
-- various monad transformers applied to these as base monads.
--------------------------------------------------------------------
module Data.Bytes.Get
  ( MonadGet(..)
  , runGetL
  , runGetS
  ) where

#if __GLASGOW_HASKELL__ < 710
import Control.Applicative
import Data.Monoid (Monoid(..))
#endif
import Control.Monad (liftM, unless)
import Control.Monad.Trans.Class (MonadTrans(..))
import Control.Monad.Trans.Except as Except
import Control.Monad.Trans.Reader (ReaderT(..))
import Control.Monad.Trans.RWS.Lazy as Lazy
import Control.Monad.Trans.RWS.Strict as Strict
import Control.Monad.Trans.State.Lazy as Lazy
import Control.Monad.Trans.State.Strict as Strict
import Control.Monad.Trans.Writer.Lazy as Lazy
import Control.Monad.Trans.Writer.Strict as Strict
import qualified Data.Binary.Get as B
import qualified Data.ByteString.Lazy as Lazy
import qualified Data.ByteString as Strict
import Data.Int
import qualified Data.Serialize.Get as S
import Data.Word

import Control.Monad.Trans.Instances ()
import Data.Binary.Orphans ()
import qualified Control.Monad.Fail as Fail
#if __GLASGOW_HASKELL__ >= 806
import Data.Coerce (Coercible)
#endif

class (
#if __GLASGOW_HASKELL__ >= 806
     -- This superclass exists for the benefit of Serial, which uses MonadGet
     -- in one of its methods. Giving MonadGet this superclass allows Serial to
     -- be derived using GeneralizedNewtypeDeriving/DerivingVia.
     forall a b. Coercible a b => Coercible (m a) (m b),
#endif
     Integral (Remaining m), Fail.MonadFail m, Applicative m) => MonadGet m where
  -- | An 'Integral' number type used for unchecked skips and counting.
  type Remaining m :: *

  -- | The underlying ByteString type used by this instance
  type Bytes m :: *

  -- | Skip ahead @n@ bytes. Fails if fewer than @n@ bytes are available.
  skip :: Int -> m ()
#ifndef HLINT
  default skip :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m ()
  skip = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *). MonadGet m => Int -> m ()
skip
#endif

  -- | If at least @n@ bytes are available return at least that much of the current input.
  -- Otherwise fail.
  ensure :: Int -> m Strict.ByteString
#ifndef HLINT
  default ensure :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m Strict.ByteString
  ensure = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *). MonadGet m => Int -> m ByteString
ensure
#endif

  -- | Run @ga@, but return without consuming its input.
  -- Fails if @ga@ fails.
  lookAhead :: m a -> m a

  -- | Like 'lookAhead', but consume the input if @gma@ returns 'Just _'.
  -- Fails if @gma@ fails.
  lookAheadM :: m (Maybe a) -> m (Maybe a)

  -- | Like 'lookAhead', but consume the input if @gea@ returns 'Right _'.
  -- Fails if @gea@ fails.
  lookAheadE :: m (Either a b) -> m (Either a b)

  -- | Pull @n@ bytes from the input, as a strict ByteString.
  getBytes :: Int -> m Strict.ByteString
#ifndef HLINT
  default getBytes :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m Strict.ByteString
  getBytes = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *). MonadGet m => Int -> m ByteString
getBytes
#endif

  -- | Get the number of remaining unparsed bytes.
  -- Useful for checking whether all input has been consumed.
  -- Note that this forces the rest of the input.
  remaining :: m (Remaining m)
#ifndef HLINT
  default remaining :: (MonadTrans t, MonadGet n, m ~ t n, Remaining m ~ Remaining n)
                    => m (Remaining m)
  remaining = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m (Remaining m)
remaining
#endif

  -- | Test whether all input has been consumed,
  -- i.e. there are no remaining unparsed bytes.
  isEmpty :: m Bool
#ifndef HLINT
  default isEmpty :: (MonadTrans t, MonadGet n, m ~ t n) => m Bool
  isEmpty = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Bool
isEmpty
#endif

  -- | Read a Word8 from the monad state
  getWord8 :: m Word8
#ifndef HLINT
  default getWord8 :: (MonadTrans t, MonadGet n, m ~ t n) => m Word8
  getWord8 = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word8
getWord8
#endif

  -- | An efficient 'get' method for strict ByteStrings. Fails if fewer
  -- than @n@ bytes are left in the input.
  getByteString :: Int -> m Strict.ByteString
#ifndef HLINT
  default getByteString :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m Strict.ByteString
  getByteString = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *). MonadGet m => Int -> m ByteString
getByteString
#endif

  -- | An efficient 'get' method for lazy ByteStrings. Does not fail if fewer than
  -- @n@ bytes are left in the input.
  getLazyByteString :: Int64 -> m Lazy.ByteString
#ifndef HLINT
  default getLazyByteString :: (MonadTrans t, MonadGet n, m ~ t n) => Int64 -> m Lazy.ByteString
  getLazyByteString = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *). MonadGet m => Int64 -> m ByteString
getLazyByteString
#endif

  -- | Read a 'Word16' in big endian format
  getWord16be   :: m Word16
#ifndef HLINT
  default getWord16be :: (MonadTrans t, MonadGet n, m ~ t n) => m Word16
  getWord16be = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word16
getWord16be
#endif

  -- | Read a 'Word16' in little endian format
  getWord16le   :: m Word16
#ifndef HLINT
  default getWord16le :: (MonadTrans t, MonadGet n, m ~ t n) => m Word16
  getWord16le = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word16
getWord16le
#endif

  -- | /O(1)./ Read a 2 byte 'Word16' in native host order and host endianness.
  getWord16host :: m Word16
#ifndef HLINT
  default getWord16host :: (MonadTrans t, MonadGet n, m ~ t n) => m Word16
  getWord16host = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word16
getWord16host
#endif

  -- | Read a 'Word32' in big endian format
  getWord32be   :: m Word32
#ifndef HLINT
  default getWord32be :: (MonadTrans t, MonadGet n, m ~ t n) => m Word32
  getWord32be = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word32
getWord32be
#endif

  -- | Read a 'Word32' in little endian format
  getWord32le   :: m Word32
#ifndef HLINT
  default getWord32le :: (MonadTrans t, MonadGet n, m ~ t n) => m Word32
  getWord32le = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word32
getWord32le
#endif

  -- | /O(1)./ Read a 'Word32' in native host order and host endianness.
  getWord32host :: m Word32
#ifndef HLINT
  default getWord32host :: (MonadTrans t, MonadGet n, m ~ t n) => m Word32
  getWord32host = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word32
getWord32host
#endif

  -- | Read a 'Word64' in big endian format
  getWord64be   :: m Word64
#ifndef HLINT
  default getWord64be :: (MonadTrans t, MonadGet n, m ~ t n) => m Word64
  getWord64be = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word64
getWord64be
#endif


  -- | Read a 'Word64' in little endian format
  getWord64le   :: m Word64
#ifndef HLINT
  default getWord64le :: (MonadTrans t, MonadGet n, m ~ t n) => m Word64
  getWord64le = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word64
getWord64le
#endif

  -- | /O(1)./ Read a 'Word64' in native host order and host endianness.
  getWord64host :: m Word64
#ifndef HLINT
  default getWord64host :: (MonadTrans t, MonadGet n, m ~ t n) => m Word64
  getWord64host = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word64
getWord64host
#endif

  -- | /O(1)./ Read a single native machine word. The word is read in
  -- host order, host endian form, for the machine you're on. On a 64 bit
  -- machine the Word is an 8 byte value, on a 32 bit machine, 4 bytes.
  getWordhost :: m Word
#ifndef HLINT
  default getWordhost :: (MonadTrans t, MonadGet n, m ~ t n) => m Word
  getWordhost = forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall (m :: * -> *). MonadGet m => m Word
getWordhost
#endif

instance MonadGet B.Get where
  type Remaining B.Get = Int64
  type Bytes B.Get = Lazy.ByteString
  skip :: Int -> Get ()
skip = Int -> Get ()
B.skip
  {-# INLINE skip #-}
  lookAhead :: forall a. Get a -> Get a
lookAhead = forall a. Get a -> Get a
B.lookAhead
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. Get (Maybe a) -> Get (Maybe a)
lookAheadM = forall a. Get (Maybe a) -> Get (Maybe a)
B.lookAheadM
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. Get (Either a b) -> Get (Either a b)
lookAheadE = forall a b. Get (Either a b) -> Get (Either a b)
B.lookAheadE
  {-# INLINE lookAheadE #-}
  ensure :: Int -> Get ByteString
ensure Int
n = do
    ByteString
bs <- forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). MonadGet m => Int -> m ByteString
getByteString Int
n
    forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (ByteString -> Int
Strict.length ByteString
bs forall a. Ord a => a -> a -> Bool
>= Int
n) forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a. MonadFail m => String -> m a
Fail.fail String
"ensure: Required more bytes"
    forall (m :: * -> *) a. Monad m => a -> m a
return ByteString
bs
  {-# INLINE ensure #-}
  getBytes :: Int -> Get ByteString
getBytes = Int -> Get ByteString
B.getByteString
  {-# INLINE getBytes #-}
  remaining :: Get (Remaining Get)
remaining = Get Int64
B.remaining
  {-# INLINE remaining #-}
  isEmpty :: Get Bool
isEmpty = Get Bool
B.isEmpty
  {-# INLINE isEmpty #-}
  getWord8 :: Get Word8
getWord8 = Get Word8
B.getWord8
  {-# INLINE getWord8 #-}
  getByteString :: Int -> Get ByteString
getByteString = Int -> Get ByteString
B.getByteString
  {-# INLINE getByteString #-}
  getLazyByteString :: Int64 -> Get ByteString
getLazyByteString = Int64 -> Get ByteString
B.getLazyByteString
  {-# INLINE getLazyByteString #-}
  getWord16be :: Get Word16
getWord16be   = Get Word16
B.getWord16be
  {-# INLINE getWord16be #-}
  getWord16le :: Get Word16
getWord16le   = Get Word16
B.getWord16le
  {-# INLINE getWord16le #-}
  getWord16host :: Get Word16
getWord16host = Get Word16
B.getWord16host
  {-# INLINE getWord16host #-}
  getWord32be :: Get Word32
getWord32be   = Get Word32
B.getWord32be
  {-# INLINE getWord32be #-}
  getWord32le :: Get Word32
getWord32le   = Get Word32
B.getWord32le
  {-# INLINE getWord32le #-}
  getWord32host :: Get Word32
getWord32host = Get Word32
B.getWord32host
  {-# INLINE getWord32host #-}
  getWord64be :: Get Word64
getWord64be   = Get Word64
B.getWord64be
  {-# INLINE getWord64be #-}
  getWord64le :: Get Word64
getWord64le   = Get Word64
B.getWord64le
  {-# INLINE getWord64le #-}
  getWord64host :: Get Word64
getWord64host = Get Word64
B.getWord64host
  {-# INLINE getWord64host #-}
  getWordhost :: Get Word
getWordhost   = Get Word
B.getWordhost
  {-# INLINE getWordhost #-}

instance MonadGet S.Get where
  type Remaining S.Get = Int
  type Bytes S.Get = Strict.ByteString
  skip :: Int -> Get ()
skip = Int -> Get ()
S.skip
  {-# INLINE skip #-}
  lookAhead :: forall a. Get a -> Get a
lookAhead = forall a. Get a -> Get a
S.lookAhead
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. Get (Maybe a) -> Get (Maybe a)
lookAheadM = forall a. Get (Maybe a) -> Get (Maybe a)
S.lookAheadM
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. Get (Either a b) -> Get (Either a b)
lookAheadE = forall a b. Get (Either a b) -> Get (Either a b)
S.lookAheadE
  {-# INLINE lookAheadE #-}
  getBytes :: Int -> Get ByteString
getBytes = Int -> Get ByteString
S.getBytes
  {-# INLINE getBytes #-}
  ensure :: Int -> Get ByteString
ensure = Int -> Get ByteString
S.ensure
  {-# INLINE ensure #-}
  remaining :: Get (Remaining Get)
remaining = Get Int
S.remaining
  {-# INLINE remaining #-}
  isEmpty :: Get Bool
isEmpty = Get Bool
S.isEmpty
  {-# INLINE isEmpty #-}
  getWord8 :: Get Word8
getWord8 = Get Word8
S.getWord8
  {-# INLINE getWord8 #-}
  getByteString :: Int -> Get ByteString
getByteString = Int -> Get ByteString
S.getByteString
  {-# INLINE getByteString #-}
  getLazyByteString :: Int64 -> Get ByteString
getLazyByteString = Int64 -> Get ByteString
S.getLazyByteString
  {-# INLINE getLazyByteString #-}
  getWord16be :: Get Word16
getWord16be   = Get Word16
S.getWord16be
  {-# INLINE getWord16be #-}
  getWord16le :: Get Word16
getWord16le   = Get Word16
S.getWord16le
  {-# INLINE getWord16le #-}
  getWord16host :: Get Word16
getWord16host = Get Word16
S.getWord16host
  {-# INLINE getWord16host #-}
  getWord32be :: Get Word32
getWord32be   = Get Word32
S.getWord32be
  {-# INLINE getWord32be #-}
  getWord32le :: Get Word32
getWord32le   = Get Word32
S.getWord32le
  {-# INLINE getWord32le #-}
  getWord32host :: Get Word32
getWord32host = Get Word32
S.getWord32host
  {-# INLINE getWord32host #-}
  getWord64be :: Get Word64
getWord64be   = Get Word64
S.getWord64be
  {-# INLINE getWord64be #-}
  getWord64le :: Get Word64
getWord64le   = Get Word64
S.getWord64le
  {-# INLINE getWord64le #-}
  getWord64host :: Get Word64
getWord64host = Get Word64
S.getWord64host
  {-# INLINE getWord64host #-}
  getWordhost :: Get Word
getWordhost   = Get Word
S.getWordhost
  {-# INLINE getWordhost #-}

instance MonadGet m => MonadGet (Lazy.StateT s m) where
  type Remaining (Lazy.StateT s m) = Remaining m
  type Bytes (Lazy.StateT s m) = Bytes m
  lookAhead :: forall a. StateT s m a -> StateT s m a
lookAhead (Lazy.StateT s -> m (a, s)
m) = forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Lazy.StateT (forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead forall b c a. (b -> c) -> (a -> b) -> a -> c
. s -> m (a, s)
m)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. StateT s m (Maybe a) -> StateT s m (Maybe a)
lookAheadM (Lazy.StateT s -> m (Maybe a, s)
m) = forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Lazy.StateT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {a}.
(Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute forall b c a. (b -> c) -> (a -> b) -> a -> c
. s -> m (Maybe a, s)
m)
    where
    distribute :: (Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute (Maybe a
Nothing, b
s') = forall a b. a -> Either a b
Left (forall a. Maybe a
Nothing, b
s')
    distribute (Just a
a, b
s') = forall a b. b -> Either a b
Right (forall a. a -> Maybe a
Just a
a, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. StateT s m (Either a b) -> StateT s m (Either a b)
lookAheadE (Lazy.StateT s -> m (Either a b, s)
m) = forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Lazy.StateT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {b} {a}.
(Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute forall b c a. (b -> c) -> (a -> b) -> a -> c
. s -> m (Either a b, s)
m)
    where
    distribute :: (Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute (Left a
a, b
s') = forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
a, b
s')
    distribute (Right b
b, b
s') = forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
b, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

instance MonadGet m => MonadGet (Strict.StateT s m) where
  type Remaining (Strict.StateT s m) = Remaining m
  type Bytes (Strict.StateT s m) = Bytes m
  lookAhead :: forall a. StateT s m a -> StateT s m a
lookAhead (Strict.StateT s -> m (a, s)
m) = forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Strict.StateT (forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead forall b c a. (b -> c) -> (a -> b) -> a -> c
. s -> m (a, s)
m)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. StateT s m (Maybe a) -> StateT s m (Maybe a)
lookAheadM (Strict.StateT s -> m (Maybe a, s)
m) = forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Strict.StateT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {a}.
(Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute forall b c a. (b -> c) -> (a -> b) -> a -> c
. s -> m (Maybe a, s)
m)
    where
    distribute :: (Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute (Maybe a
Nothing, b
s') = forall a b. a -> Either a b
Left (forall a. Maybe a
Nothing, b
s')
    distribute (Just a
a, b
s') = forall a b. b -> Either a b
Right (forall a. a -> Maybe a
Just a
a, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. StateT s m (Either a b) -> StateT s m (Either a b)
lookAheadE (Strict.StateT s -> m (Either a b, s)
m) = forall s (m :: * -> *) a. (s -> m (a, s)) -> StateT s m a
Strict.StateT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {b} {a}.
(Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute forall b c a. (b -> c) -> (a -> b) -> a -> c
. s -> m (Either a b, s)
m)
    where
    distribute :: (Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute (Left a
a, b
s') = forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
a, b
s')
    distribute (Right b
b, b
s') = forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
b, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

instance MonadGet m => MonadGet (ReaderT e m) where
  type Remaining (ReaderT e m) = Remaining m
  type Bytes (ReaderT e m) = Bytes m
  lookAhead :: forall a. ReaderT e m a -> ReaderT e m a
lookAhead (ReaderT e -> m a
m) = forall r (m :: * -> *) a. (r -> m a) -> ReaderT r m a
ReaderT (forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead forall b c a. (b -> c) -> (a -> b) -> a -> c
. e -> m a
m)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. ReaderT e m (Maybe a) -> ReaderT e m (Maybe a)
lookAheadM (ReaderT e -> m (Maybe a)
m) = forall r (m :: * -> *) a. (r -> m a) -> ReaderT r m a
ReaderT (forall (m :: * -> *) a. MonadGet m => m (Maybe a) -> m (Maybe a)
lookAheadM forall b c a. (b -> c) -> (a -> b) -> a -> c
. e -> m (Maybe a)
m)
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. ReaderT e m (Either a b) -> ReaderT e m (Either a b)
lookAheadE (ReaderT e -> m (Either a b)
m) = forall r (m :: * -> *) a. (r -> m a) -> ReaderT r m a
ReaderT (forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall b c a. (b -> c) -> (a -> b) -> a -> c
. e -> m (Either a b)
m)
  {-# INLINE lookAheadE #-}

instance (MonadGet m, Monoid w) => MonadGet (Lazy.WriterT w m) where
  type Remaining (Lazy.WriterT w m) = Remaining m
  type Bytes (Lazy.WriterT w m) = Bytes m
  lookAhead :: forall a. WriterT w m a -> WriterT w m a
lookAhead (Lazy.WriterT m (a, w)
m) = forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Lazy.WriterT (forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead m (a, w)
m)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. WriterT w m (Maybe a) -> WriterT w m (Maybe a)
lookAheadM (Lazy.WriterT m (Maybe a, w)
m) = forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Lazy.WriterT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {a}.
(Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute m (Maybe a, w)
m)
    where
    distribute :: (Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute (Maybe a
Nothing, b
s') = forall a b. a -> Either a b
Left (forall a. Maybe a
Nothing, b
s')
    distribute (Just a
a, b
s') = forall a b. b -> Either a b
Right (forall a. a -> Maybe a
Just a
a, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. WriterT w m (Either a b) -> WriterT w m (Either a b)
lookAheadE (Lazy.WriterT m (Either a b, w)
m) = forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Lazy.WriterT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {b} {a}.
(Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute m (Either a b, w)
m)
    where
    distribute :: (Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute (Left a
a, b
s') = forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
a, b
s')
    distribute (Right b
b, b
s') = forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
b, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

instance (MonadGet m, Monoid w) => MonadGet (Strict.WriterT w m) where
  type Remaining (Strict.WriterT w m) = Remaining m
  type Bytes (Strict.WriterT w m) = Bytes m
  lookAhead :: forall a. WriterT w m a -> WriterT w m a
lookAhead (Strict.WriterT m (a, w)
m) = forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Strict.WriterT (forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead m (a, w)
m)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. WriterT w m (Maybe a) -> WriterT w m (Maybe a)
lookAheadM (Strict.WriterT m (Maybe a, w)
m) = forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Strict.WriterT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {a}.
(Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute m (Maybe a, w)
m)
    where
    distribute :: (Maybe a, b) -> Either (Maybe a, b) (Maybe a, b)
distribute (Maybe a
Nothing, b
s') = forall a b. a -> Either a b
Left (forall a. Maybe a
Nothing, b
s')
    distribute (Just a
a, b
s') = forall a b. b -> Either a b
Right (forall a. a -> Maybe a
Just a
a, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. WriterT w m (Either a b) -> WriterT w m (Either a b)
lookAheadE (Strict.WriterT m (Either a b, w)
m) = forall w (m :: * -> *) a. m (a, w) -> WriterT w m a
Strict.WriterT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {b} {a}.
(Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute m (Either a b, w)
m)
    where
    distribute :: (Either a b, b) -> Either (Either a b, b) (Either a b, b)
distribute (Left a
a, b
s') = forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
a, b
s')
    distribute (Right b
b, b
s') = forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
b, b
s')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

instance (MonadGet m, Monoid w) => MonadGet (Strict.RWST r w s m) where
  type Remaining (Strict.RWST r w s m) = Remaining m
  type Bytes (Strict.RWST r w s m) = Bytes m
  lookAhead :: forall a. RWST r w s m a -> RWST r w s m a
lookAhead (Strict.RWST r -> s -> m (a, s, w)
m) = forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Strict.RWST forall a b. (a -> b) -> a -> b
$ \r
r s
s -> forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead (r -> s -> m (a, s, w)
m r
r s
s)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. RWST r w s m (Maybe a) -> RWST r w s m (Maybe a)
lookAheadM (Strict.RWST r -> s -> m (Maybe a, s, w)
m) = forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Strict.RWST (\r
r s
s -> forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {c} {a}.
(Maybe a, b, c) -> Either (Maybe a, b, c) (Maybe a, b, c)
distribute forall a b. (a -> b) -> a -> b
$ r -> s -> m (Maybe a, s, w)
m r
r s
s )
    where
    distribute :: (Maybe a, b, c) -> Either (Maybe a, b, c) (Maybe a, b, c)
distribute (Maybe a
Nothing, b
s',c
w') = forall a b. a -> Either a b
Left (forall a. Maybe a
Nothing, b
s', c
w')
    distribute (Just a
a, b
s',c
w') = forall a b. b -> Either a b
Right (forall a. a -> Maybe a
Just a
a, b
s', c
w')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. RWST r w s m (Either a b) -> RWST r w s m (Either a b)
lookAheadE (Strict.RWST r -> s -> m (Either a b, s, w)
m) = forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Strict.RWST (\r
r s
s -> forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {c} {b} {a}.
(Either a b, b, c) -> Either (Either a b, b, c) (Either a b, b, c)
distribute forall a b. (a -> b) -> a -> b
$ r -> s -> m (Either a b, s, w)
m r
r s
s)
    where
    distribute :: (Either a b, b, c) -> Either (Either a b, b, c) (Either a b, b, c)
distribute (Left a
a, b
s', c
w') = forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
a, b
s', c
w')
    distribute (Right b
b, b
s', c
w') = forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
b, b
s', c
w')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

instance (MonadGet m, Monoid w) => MonadGet (Lazy.RWST r w s m) where
  type Remaining (Lazy.RWST r w s m) = Remaining m
  type Bytes (Lazy.RWST r w s m) = Bytes m
  lookAhead :: forall a. RWST r w s m a -> RWST r w s m a
lookAhead (Lazy.RWST r -> s -> m (a, s, w)
m) = forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Lazy.RWST forall a b. (a -> b) -> a -> b
$ \r
r s
s -> forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead (r -> s -> m (a, s, w)
m r
r s
s)
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. RWST r w s m (Maybe a) -> RWST r w s m (Maybe a)
lookAheadM (Lazy.RWST r -> s -> m (Maybe a, s, w)
m) = forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Lazy.RWST (\r
r s
s -> forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {c} {a}.
(Maybe a, b, c) -> Either (Maybe a, b, c) (Maybe a, b, c)
distribute forall a b. (a -> b) -> a -> b
$ r -> s -> m (Maybe a, s, w)
m r
r s
s )
    where
    distribute :: (Maybe a, b, c) -> Either (Maybe a, b, c) (Maybe a, b, c)
distribute (Maybe a
Nothing, b
s',c
w') = forall a b. a -> Either a b
Left (forall a. Maybe a
Nothing, b
s', c
w')
    distribute (Just a
a, b
s',c
w') = forall a b. b -> Either a b
Right (forall a. a -> Maybe a
Just a
a, b
s', c
w')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. RWST r w s m (Either a b) -> RWST r w s m (Either a b)
lookAheadE (Lazy.RWST r -> s -> m (Either a b, s, w)
m) = forall r w s (m :: * -> *) a.
(r -> s -> m (a, s, w)) -> RWST r w s m a
Lazy.RWST (\r
r s
s -> forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {c} {b} {a}.
(Either a b, b, c) -> Either (Either a b, b, c) (Either a b, b, c)
distribute forall a b. (a -> b) -> a -> b
$ r -> s -> m (Either a b, s, w)
m r
r s
s)
    where
    distribute :: (Either a b, b, c) -> Either (Either a b, b, c) (Either a b, b, c)
distribute (Left a
a, b
s', c
w') = forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
a, b
s', c
w')
    distribute (Right b
b, b
s', c
w') = forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
b, b
s', c
w')
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

instance MonadGet m => MonadGet (ExceptT e m) where
  type Remaining (ExceptT e m) = Remaining m
  type Bytes (ExceptT e m) = Bytes m
  lookAhead :: forall a. ExceptT e m a -> ExceptT e m a
lookAhead = forall (m :: * -> *) e a (n :: * -> *) e' b.
(m (Either e a) -> n (Either e' b))
-> ExceptT e m a -> ExceptT e' n b
mapExceptT forall (m :: * -> *) a. MonadGet m => m a -> m a
lookAhead
  {-# INLINE lookAhead #-}
  lookAheadM :: forall a. ExceptT e m (Maybe a) -> ExceptT e m (Maybe a)
lookAheadM (ExceptT m (Either e (Maybe a))
m) = forall e (m :: * -> *) a. m (Either e a) -> ExceptT e m a
ExceptT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {a}.
Either a b -> Either (Either a b) (Either a b)
distribute m (Either e (Maybe a))
m)
    where
    distribute :: Either a b -> Either (Either a b) (Either a b)
distribute (Left a
e) = (forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
e))
    distribute (Right b
j) = (forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
j))
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadM #-}
  lookAheadE :: forall a b. ExceptT e m (Either a b) -> ExceptT e m (Either a b)
lookAheadE (ExceptT m (Either e (Either a b))
m) = forall e (m :: * -> *) a. m (Either e a) -> ExceptT e m a
ExceptT (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {c}. Either c c -> c
factor forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a b.
MonadGet m =>
m (Either a b) -> m (Either a b)
lookAheadE forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM forall {a} {b} {b} {a}.
Either a b -> Either (Either a b) (Either a b)
distribute m (Either e (Either a b))
m)
    where
    distribute :: Either a b -> Either (Either a b) (Either a b)
distribute (Left a
e) = (forall a b. a -> Either a b
Left (forall a b. a -> Either a b
Left a
e))
    distribute (Right b
a) = (forall a b. b -> Either a b
Right (forall a b. b -> Either a b
Right b
a))
    factor :: Either c c -> c
factor = forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either forall a. a -> a
id forall a. a -> a
id
  {-# INLINE lookAheadE #-}

-- | Get something from a lazy 'Lazy.ByteString' using 'B.runGet'.
runGetL :: B.Get a -> Lazy.ByteString -> a
runGetL :: forall a. Get a -> ByteString -> a
runGetL = forall a. Get a -> ByteString -> a
B.runGet

-- | Get something from a strict 'Strict.ByteString' using 'S.runGet'.
runGetS :: S.Get a -> Strict.ByteString -> Either String a
runGetS :: forall a. Get a -> ByteString -> Either String a
runGetS = forall a. Get a -> ByteString -> Either String a
S.runGet