{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- Represents a byte range as used in the Range header.
-- 
-- If /@end@/ is non-negative, then /@start@/ and /@end@/ represent the bounds
-- of of the range, counting from 0. (Eg, the first 500 bytes would be
-- represented as /@start@/ = 0 and /@end@/ = 499.)
-- 
-- If /@end@/ is -1 and /@start@/ is non-negative, then this represents a
-- range starting at /@start@/ and ending with the last byte of the
-- requested resource body. (Eg, all but the first 500 bytes would be
-- /@start@/ = 500, and /@end@/ = -1.)
-- 
-- If /@end@/ is -1 and /@start@/ is negative, then it represents a \"suffix
-- range\", referring to the last -/@start@/ bytes of the resource body.
-- (Eg, the last 500 bytes would be /@start@/ = -500 and /@end@/ = -1.)
-- 
-- /Since: 2.26/

#if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__))
#define ENABLE_OVERLOADING
#endif

module GI.Soup.Structs.Range
    ( 

-- * Exported types
    Range(..)                               ,
    newZeroRange                            ,


 -- * Methods
-- ** Overloaded methods #method:Overloaded methods#

#if defined(ENABLE_OVERLOADING)
    ResolveRangeMethod                      ,
#endif




 -- * Properties
-- ** end #attr:end#
-- | the end of the range

    getRangeEnd                             ,
#if defined(ENABLE_OVERLOADING)
    range_end                               ,
#endif
    setRangeEnd                             ,


-- ** start #attr:start#
-- | the start of the range

    getRangeStart                           ,
#if defined(ENABLE_OVERLOADING)
    range_start                             ,
#endif
    setRangeStart                           ,




    ) where

import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P

import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.BasicTypes as B.Types
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.GI.Base.Signals as B.Signals
import qualified Control.Monad.IO.Class as MIO
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL


-- | Memory-managed wrapper type.
newtype Range = Range (SP.ManagedPtr Range)
    deriving (Range -> Range -> Bool
(Range -> Range -> Bool) -> (Range -> Range -> Bool) -> Eq Range
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Range -> Range -> Bool
$c/= :: Range -> Range -> Bool
== :: Range -> Range -> Bool
$c== :: Range -> Range -> Bool
Eq)

instance SP.ManagedPtrNewtype Range where
    toManagedPtr :: Range -> ManagedPtr Range
toManagedPtr (Range ManagedPtr Range
p) = ManagedPtr Range
p

instance BoxedPtr Range where
    boxedPtrCopy :: Range -> IO Range
boxedPtrCopy = \Range
p -> Range -> (Ptr Range -> IO Range) -> IO Range
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr Range
p (Int -> Ptr Range -> IO (Ptr Range)
forall a. (HasCallStack, CallocPtr a) => Int -> Ptr a -> IO (Ptr a)
copyBytes Int
16 (Ptr Range -> IO (Ptr Range))
-> (Ptr Range -> IO Range) -> Ptr Range -> IO Range
forall (m :: * -> *) a b c.
Monad m =>
(a -> m b) -> (b -> m c) -> a -> m c
>=> (ManagedPtr Range -> Range) -> Ptr Range -> IO Range
forall a.
(HasCallStack, BoxedPtr a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
B.ManagedPtr.wrapPtr ManagedPtr Range -> Range
Range)
    boxedPtrFree :: Range -> IO ()
boxedPtrFree = \Range
x -> Range -> (Ptr Range -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
SP.withManagedPtr Range
x Ptr Range -> IO ()
forall a. Ptr a -> IO ()
SP.freeMem
instance CallocPtr Range where
    boxedPtrCalloc :: IO (Ptr Range)
boxedPtrCalloc = Int -> IO (Ptr Range)
forall a. Int -> IO (Ptr a)
callocBytes Int
16


-- | Construct a `Range` struct initialized to zero.
newZeroRange :: MonadIO m => m Range
newZeroRange :: m Range
newZeroRange = IO Range -> m Range
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Range -> m Range) -> IO Range -> m Range
forall a b. (a -> b) -> a -> b
$ IO (Ptr Range)
forall a. CallocPtr a => IO (Ptr a)
boxedPtrCalloc IO (Ptr Range) -> (Ptr Range -> IO Range) -> IO Range
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= (ManagedPtr Range -> Range) -> Ptr Range -> IO Range
forall a.
(HasCallStack, BoxedPtr a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapPtr ManagedPtr Range -> Range
Range

instance tag ~ 'AttrSet => Constructible Range tag where
    new :: (ManagedPtr Range -> Range) -> [AttrOp Range tag] -> m Range
new ManagedPtr Range -> Range
_ [AttrOp Range tag]
attrs = do
        Range
o <- m Range
forall (m :: * -> *). MonadIO m => m Range
newZeroRange
        Range -> [AttrOp Range 'AttrSet] -> m ()
forall o (m :: * -> *).
MonadIO m =>
o -> [AttrOp o 'AttrSet] -> m ()
GI.Attributes.set Range
o [AttrOp Range tag]
[AttrOp Range 'AttrSet]
attrs
        Range -> m Range
forall (m :: * -> *) a. Monad m => a -> m a
return Range
o


-- | Get the value of the “@start@” field.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.get' range #start
-- @
getRangeStart :: MonadIO m => Range -> m Int64
getRangeStart :: Range -> m Int64
getRangeStart Range
s = IO Int64 -> m Int64
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Int64 -> m Int64) -> IO Int64 -> m Int64
forall a b. (a -> b) -> a -> b
$ Range -> (Ptr Range -> IO Int64) -> IO Int64
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr Range
s ((Ptr Range -> IO Int64) -> IO Int64)
-> (Ptr Range -> IO Int64) -> IO Int64
forall a b. (a -> b) -> a -> b
$ \Ptr Range
ptr -> do
    Int64
val <- Ptr Int64 -> IO Int64
forall a. Storable a => Ptr a -> IO a
peek (Ptr Range
ptr Ptr Range -> Int -> Ptr Int64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0) :: IO Int64
    Int64 -> IO Int64
forall (m :: * -> *) a. Monad m => a -> m a
return Int64
val

-- | Set the value of the “@start@” field.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.set' range [ #start 'Data.GI.Base.Attributes.:=' value ]
-- @
setRangeStart :: MonadIO m => Range -> Int64 -> m ()
setRangeStart :: Range -> Int64 -> m ()
setRangeStart Range
s Int64
val = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ Range -> (Ptr Range -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr Range
s ((Ptr Range -> IO ()) -> IO ()) -> (Ptr Range -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \Ptr Range
ptr -> do
    Ptr Int64 -> Int64 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (Ptr Range
ptr Ptr Range -> Int -> Ptr Int64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0) (Int64
val :: Int64)

#if defined(ENABLE_OVERLOADING)
data RangeStartFieldInfo
instance AttrInfo RangeStartFieldInfo where
    type AttrBaseTypeConstraint RangeStartFieldInfo = (~) Range
    type AttrAllowedOps RangeStartFieldInfo = '[ 'AttrSet, 'AttrGet]
    type AttrSetTypeConstraint RangeStartFieldInfo = (~) Int64
    type AttrTransferTypeConstraint RangeStartFieldInfo = (~)Int64
    type AttrTransferType RangeStartFieldInfo = Int64
    type AttrGetType RangeStartFieldInfo = Int64
    type AttrLabel RangeStartFieldInfo = "start"
    type AttrOrigin RangeStartFieldInfo = Range
    attrGet = getRangeStart
    attrSet = setRangeStart
    attrConstruct = undefined
    attrClear = undefined
    attrTransfer _ v = do
        return v

range_start :: AttrLabelProxy "start"
range_start = AttrLabelProxy

#endif


-- | Get the value of the “@end@” field.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.get' range #end
-- @
getRangeEnd :: MonadIO m => Range -> m Int64
getRangeEnd :: Range -> m Int64
getRangeEnd Range
s = IO Int64 -> m Int64
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Int64 -> m Int64) -> IO Int64 -> m Int64
forall a b. (a -> b) -> a -> b
$ Range -> (Ptr Range -> IO Int64) -> IO Int64
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr Range
s ((Ptr Range -> IO Int64) -> IO Int64)
-> (Ptr Range -> IO Int64) -> IO Int64
forall a b. (a -> b) -> a -> b
$ \Ptr Range
ptr -> do
    Int64
val <- Ptr Int64 -> IO Int64
forall a. Storable a => Ptr a -> IO a
peek (Ptr Range
ptr Ptr Range -> Int -> Ptr Int64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8) :: IO Int64
    Int64 -> IO Int64
forall (m :: * -> *) a. Monad m => a -> m a
return Int64
val

-- | Set the value of the “@end@” field.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.set' range [ #end 'Data.GI.Base.Attributes.:=' value ]
-- @
setRangeEnd :: MonadIO m => Range -> Int64 -> m ()
setRangeEnd :: Range -> Int64 -> m ()
setRangeEnd Range
s Int64
val = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ Range -> (Ptr Range -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr Range
s ((Ptr Range -> IO ()) -> IO ()) -> (Ptr Range -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \Ptr Range
ptr -> do
    Ptr Int64 -> Int64 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (Ptr Range
ptr Ptr Range -> Int -> Ptr Int64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8) (Int64
val :: Int64)

#if defined(ENABLE_OVERLOADING)
data RangeEndFieldInfo
instance AttrInfo RangeEndFieldInfo where
    type AttrBaseTypeConstraint RangeEndFieldInfo = (~) Range
    type AttrAllowedOps RangeEndFieldInfo = '[ 'AttrSet, 'AttrGet]
    type AttrSetTypeConstraint RangeEndFieldInfo = (~) Int64
    type AttrTransferTypeConstraint RangeEndFieldInfo = (~)Int64
    type AttrTransferType RangeEndFieldInfo = Int64
    type AttrGetType RangeEndFieldInfo = Int64
    type AttrLabel RangeEndFieldInfo = "end"
    type AttrOrigin RangeEndFieldInfo = Range
    attrGet = getRangeEnd
    attrSet = setRangeEnd
    attrConstruct = undefined
    attrClear = undefined
    attrTransfer _ v = do
        return v

range_end :: AttrLabelProxy "end"
range_end = AttrLabelProxy

#endif



#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList Range
type instance O.AttributeList Range = RangeAttributeList
type RangeAttributeList = ('[ '("start", RangeStartFieldInfo), '("end", RangeEndFieldInfo)] :: [(Symbol, *)])
#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveRangeMethod (t :: Symbol) (o :: *) :: * where
    ResolveRangeMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveRangeMethod t Range, O.MethodInfo info Range p) => OL.IsLabel t (Range -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod @info
#else
    fromLabel _ = O.overloadedMethod @info
#endif

#endif