{-# LANGUAGE DeriveFoldable #-}
{-# LANGUAGE DeriveFunctor #-}
{-# LANGUAGE DerivingStrategies #-}

module Data.Bytes.Parser.Types
  ( Parser
  , Result (..)
  , Slice (..)
  ) where

import Data.Bytes.Parser.Internal (Parser (..))

-- | The result of running a parser.
data Result e a
  = -- | An error message indicating what went wrong.
    Failure e
  | -- | The parsed value and the number of bytes
    -- remaining in parsed slice.
    Success {-# UNPACK #-} !(Slice a)
  deriving stock (Result e a -> Result e a -> Bool
(Result e a -> Result e a -> Bool)
-> (Result e a -> Result e a -> Bool) -> Eq (Result e a)
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
forall e a. (Eq e, Eq a) => Result e a -> Result e a -> Bool
$c== :: forall e a. (Eq e, Eq a) => Result e a -> Result e a -> Bool
== :: Result e a -> Result e a -> Bool
$c/= :: forall e a. (Eq e, Eq a) => Result e a -> Result e a -> Bool
/= :: Result e a -> Result e a -> Bool
Eq, Int -> Result e a -> ShowS
[Result e a] -> ShowS
Result e a -> String
(Int -> Result e a -> ShowS)
-> (Result e a -> String)
-> ([Result e a] -> ShowS)
-> Show (Result e a)
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
forall e a. (Show e, Show a) => Int -> Result e a -> ShowS
forall e a. (Show e, Show a) => [Result e a] -> ShowS
forall e a. (Show e, Show a) => Result e a -> String
$cshowsPrec :: forall e a. (Show e, Show a) => Int -> Result e a -> ShowS
showsPrec :: Int -> Result e a -> ShowS
$cshow :: forall e a. (Show e, Show a) => Result e a -> String
show :: Result e a -> String
$cshowList :: forall e a. (Show e, Show a) => [Result e a] -> ShowS
showList :: [Result e a] -> ShowS
Show, (forall m. Monoid m => Result e m -> m)
-> (forall m a. Monoid m => (a -> m) -> Result e a -> m)
-> (forall m a. Monoid m => (a -> m) -> Result e a -> m)
-> (forall a b. (a -> b -> b) -> b -> Result e a -> b)
-> (forall a b. (a -> b -> b) -> b -> Result e a -> b)
-> (forall b a. (b -> a -> b) -> b -> Result e a -> b)
-> (forall b a. (b -> a -> b) -> b -> Result e a -> b)
-> (forall a. (a -> a -> a) -> Result e a -> a)
-> (forall a. (a -> a -> a) -> Result e a -> a)
-> (forall a. Result e a -> [a])
-> (forall a. Result e a -> Bool)
-> (forall a. Result e a -> Int)
-> (forall a. Eq a => a -> Result e a -> Bool)
-> (forall a. Ord a => Result e a -> a)
-> (forall a. Ord a => Result e a -> a)
-> (forall a. Num a => Result e a -> a)
-> (forall a. Num a => Result e a -> a)
-> Foldable (Result e)
forall a. Eq a => a -> Result e a -> Bool
forall a. Num a => Result e a -> a
forall a. Ord a => Result e a -> a
forall m. Monoid m => Result e m -> m
forall a. Result e a -> Bool
forall a. Result e a -> Int
forall a. Result e a -> [a]
forall a. (a -> a -> a) -> Result e a -> a
forall e a. Eq a => a -> Result e a -> Bool
forall e a. Num a => Result e a -> a
forall e a. Ord a => Result e a -> a
forall m a. Monoid m => (a -> m) -> Result e a -> m
forall e m. Monoid m => Result e m -> m
forall e a. Result e a -> Bool
forall e a. Result e a -> Int
forall e a. Result e a -> [a]
forall b a. (b -> a -> b) -> b -> Result e a -> b
forall a b. (a -> b -> b) -> b -> Result e a -> b
forall e a. (a -> a -> a) -> Result e a -> a
forall e m a. Monoid m => (a -> m) -> Result e a -> m
forall e b a. (b -> a -> b) -> b -> Result e a -> b
forall e a b. (a -> b -> b) -> b -> Result e 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
$cfold :: forall e m. Monoid m => Result e m -> m
fold :: forall m. Monoid m => Result e m -> m
$cfoldMap :: forall e m a. Monoid m => (a -> m) -> Result e a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> Result e a -> m
$cfoldMap' :: forall e m a. Monoid m => (a -> m) -> Result e a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> Result e a -> m
$cfoldr :: forall e a b. (a -> b -> b) -> b -> Result e a -> b
foldr :: forall a b. (a -> b -> b) -> b -> Result e a -> b
$cfoldr' :: forall e a b. (a -> b -> b) -> b -> Result e a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> Result e a -> b
$cfoldl :: forall e b a. (b -> a -> b) -> b -> Result e a -> b
foldl :: forall b a. (b -> a -> b) -> b -> Result e a -> b
$cfoldl' :: forall e b a. (b -> a -> b) -> b -> Result e a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> Result e a -> b
$cfoldr1 :: forall e a. (a -> a -> a) -> Result e a -> a
foldr1 :: forall a. (a -> a -> a) -> Result e a -> a
$cfoldl1 :: forall e a. (a -> a -> a) -> Result e a -> a
foldl1 :: forall a. (a -> a -> a) -> Result e a -> a
$ctoList :: forall e a. Result e a -> [a]
toList :: forall a. Result e a -> [a]
$cnull :: forall e a. Result e a -> Bool
null :: forall a. Result e a -> Bool
$clength :: forall e a. Result e a -> Int
length :: forall a. Result e a -> Int
$celem :: forall e a. Eq a => a -> Result e a -> Bool
elem :: forall a. Eq a => a -> Result e a -> Bool
$cmaximum :: forall e a. Ord a => Result e a -> a
maximum :: forall a. Ord a => Result e a -> a
$cminimum :: forall e a. Ord a => Result e a -> a
minimum :: forall a. Ord a => Result e a -> a
$csum :: forall e a. Num a => Result e a -> a
sum :: forall a. Num a => Result e a -> a
$cproduct :: forall e a. Num a => Result e a -> a
product :: forall a. Num a => Result e a -> a
Foldable, (forall a b. (a -> b) -> Result e a -> Result e b)
-> (forall a b. a -> Result e b -> Result e a)
-> Functor (Result e)
forall a b. a -> Result e b -> Result e a
forall a b. (a -> b) -> Result e a -> Result e b
forall e a b. a -> Result e b -> Result e a
forall e a b. (a -> b) -> Result e a -> Result e b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall e a b. (a -> b) -> Result e a -> Result e b
fmap :: forall a b. (a -> b) -> Result e a -> Result e b
$c<$ :: forall e a b. a -> Result e b -> Result e a
<$ :: forall a b. a -> Result e b -> Result e a
Functor)

{- | Slicing metadata (an offset and a length) accompanied
by a value. This does not represent a slice into the
value. This type is intended to be used as the result
of an executed parser. In this context the slicing metadata
describe a slice into to the array (or byte array) that
from which the value was parsed.

It is often useful to check the @length@ when a parser
succeeds since a non-zero length indicates that there
was additional unconsumed input. The @offset@ is only
ever needed to construct a new slice (via @Bytes@ or
@SmallVector@) from the remaining input.
-}
data Slice a = Slice
  { forall a. Slice a -> Int
offset :: {-# UNPACK #-} !Int
  -- ^ Offset into the array.
  , forall a. Slice a -> Int
length :: {-# UNPACK #-} !Int
  -- ^ Length of the slice.
  , forall a. Slice a -> a
value :: a
  -- ^ The structured data that was successfully parsed.
  }
  deriving stock (Slice a -> Slice a -> Bool
(Slice a -> Slice a -> Bool)
-> (Slice a -> Slice a -> Bool) -> Eq (Slice a)
forall a. Eq a => Slice a -> Slice a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: forall a. Eq a => Slice a -> Slice a -> Bool
== :: Slice a -> Slice a -> Bool
$c/= :: forall a. Eq a => Slice a -> Slice a -> Bool
/= :: Slice a -> Slice a -> Bool
Eq, Int -> Slice a -> ShowS
[Slice a] -> ShowS
Slice a -> String
(Int -> Slice a -> ShowS)
-> (Slice a -> String) -> ([Slice a] -> ShowS) -> Show (Slice a)
forall a. Show a => Int -> Slice a -> ShowS
forall a. Show a => [Slice a] -> ShowS
forall a. Show a => Slice a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: forall a. Show a => Int -> Slice a -> ShowS
showsPrec :: Int -> Slice a -> ShowS
$cshow :: forall a. Show a => Slice a -> String
show :: Slice a -> String
$cshowList :: forall a. Show a => [Slice a] -> ShowS
showList :: [Slice a] -> ShowS
Show, (forall m. Monoid m => Slice m -> m)
-> (forall m a. Monoid m => (a -> m) -> Slice a -> m)
-> (forall m a. Monoid m => (a -> m) -> Slice a -> m)
-> (forall a b. (a -> b -> b) -> b -> Slice a -> b)
-> (forall a b. (a -> b -> b) -> b -> Slice a -> b)
-> (forall b a. (b -> a -> b) -> b -> Slice a -> b)
-> (forall b a. (b -> a -> b) -> b -> Slice a -> b)
-> (forall a. (a -> a -> a) -> Slice a -> a)
-> (forall a. (a -> a -> a) -> Slice a -> a)
-> (forall a. Slice a -> [a])
-> (forall a. Slice a -> Bool)
-> (forall a. Slice a -> Int)
-> (forall a. Eq a => a -> Slice a -> Bool)
-> (forall a. Ord a => Slice a -> a)
-> (forall a. Ord a => Slice a -> a)
-> (forall a. Num a => Slice a -> a)
-> (forall a. Num a => Slice a -> a)
-> Foldable Slice
forall a. Eq a => a -> Slice a -> Bool
forall a. Num a => Slice a -> a
forall a. Ord a => Slice a -> a
forall m. Monoid m => Slice m -> m
forall a. Slice a -> Bool
forall a. Slice a -> Int
forall a. Slice a -> [a]
forall a. (a -> a -> a) -> Slice a -> a
forall m a. Monoid m => (a -> m) -> Slice a -> m
forall b a. (b -> a -> b) -> b -> Slice a -> b
forall a b. (a -> b -> b) -> b -> Slice 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
$cfold :: forall m. Monoid m => Slice m -> m
fold :: forall m. Monoid m => Slice m -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> Slice a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> Slice a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> Slice a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> Slice a -> m
$cfoldr :: forall a b. (a -> b -> b) -> b -> Slice a -> b
foldr :: forall a b. (a -> b -> b) -> b -> Slice a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> Slice a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> Slice a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> Slice a -> b
foldl :: forall b a. (b -> a -> b) -> b -> Slice a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> Slice a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> Slice a -> b
$cfoldr1 :: forall a. (a -> a -> a) -> Slice a -> a
foldr1 :: forall a. (a -> a -> a) -> Slice a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> Slice a -> a
foldl1 :: forall a. (a -> a -> a) -> Slice a -> a
$ctoList :: forall a. Slice a -> [a]
toList :: forall a. Slice a -> [a]
$cnull :: forall a. Slice a -> Bool
null :: forall a. Slice a -> Bool
$clength :: forall a. Slice a -> Int
length :: forall a. Slice a -> Int
$celem :: forall a. Eq a => a -> Slice a -> Bool
elem :: forall a. Eq a => a -> Slice a -> Bool
$cmaximum :: forall a. Ord a => Slice a -> a
maximum :: forall a. Ord a => Slice a -> a
$cminimum :: forall a. Ord a => Slice a -> a
minimum :: forall a. Ord a => Slice a -> a
$csum :: forall a. Num a => Slice a -> a
sum :: forall a. Num a => Slice a -> a
$cproduct :: forall a. Num a => Slice a -> a
product :: forall a. Num a => Slice a -> a
Foldable, (forall a b. (a -> b) -> Slice a -> Slice b)
-> (forall a b. a -> Slice b -> Slice a) -> Functor Slice
forall a b. a -> Slice b -> Slice a
forall a b. (a -> b) -> Slice a -> Slice b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall a b. (a -> b) -> Slice a -> Slice b
fmap :: forall a b. (a -> b) -> Slice a -> Slice b
$c<$ :: forall a b. a -> Slice b -> Slice a
<$ :: forall a b. a -> Slice b -> Slice a
Functor)