{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A t'GI.Poppler.Structs.PageRange.PageRange' is used to specify a range of pages.
-- 
-- /Since: 0.80/

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

module GI.Poppler.Structs.PageRange
    ( 

-- * Exported types
    PageRange(..)                           ,
    newZeroPageRange                        ,


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

#if defined(ENABLE_OVERLOADING)
    ResolvePageRangeMethod                  ,
#endif




 -- * Properties
-- ** endPage #attr:endPage#
-- | last page in the range of pages

    getPageRangeEndPage                     ,
#if defined(ENABLE_OVERLOADING)
    pageRange_endPage                       ,
#endif
    setPageRangeEndPage                     ,


-- ** startPage #attr:startPage#
-- | first page in the range of pages

    getPageRangeStartPage                   ,
#if defined(ENABLE_OVERLOADING)
    pageRange_startPage                     ,
#endif
    setPageRangeStartPage                   ,




    ) 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.GArray as B.GArray
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 PageRange = PageRange (SP.ManagedPtr PageRange)
    deriving (PageRange -> PageRange -> Bool
(PageRange -> PageRange -> Bool)
-> (PageRange -> PageRange -> Bool) -> Eq PageRange
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PageRange -> PageRange -> Bool
$c/= :: PageRange -> PageRange -> Bool
== :: PageRange -> PageRange -> Bool
$c== :: PageRange -> PageRange -> Bool
Eq)

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

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


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

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


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

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

#if defined(ENABLE_OVERLOADING)
data PageRangeStartPageFieldInfo
instance AttrInfo PageRangeStartPageFieldInfo where
    type AttrBaseTypeConstraint PageRangeStartPageFieldInfo = (~) PageRange
    type AttrAllowedOps PageRangeStartPageFieldInfo = '[ 'AttrSet, 'AttrGet]
    type AttrSetTypeConstraint PageRangeStartPageFieldInfo = (~) Int32
    type AttrTransferTypeConstraint PageRangeStartPageFieldInfo = (~)Int32
    type AttrTransferType PageRangeStartPageFieldInfo = Int32
    type AttrGetType PageRangeStartPageFieldInfo = Int32
    type AttrLabel PageRangeStartPageFieldInfo = "start_page"
    type AttrOrigin PageRangeStartPageFieldInfo = PageRange
    attrGet = getPageRangeStartPage
    attrSet = setPageRangeStartPage
    attrConstruct = undefined
    attrClear = undefined
    attrTransfer _ v = do
        return v

pageRange_startPage :: AttrLabelProxy "startPage"
pageRange_startPage = AttrLabelProxy

#endif


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

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

#if defined(ENABLE_OVERLOADING)
data PageRangeEndPageFieldInfo
instance AttrInfo PageRangeEndPageFieldInfo where
    type AttrBaseTypeConstraint PageRangeEndPageFieldInfo = (~) PageRange
    type AttrAllowedOps PageRangeEndPageFieldInfo = '[ 'AttrSet, 'AttrGet]
    type AttrSetTypeConstraint PageRangeEndPageFieldInfo = (~) Int32
    type AttrTransferTypeConstraint PageRangeEndPageFieldInfo = (~)Int32
    type AttrTransferType PageRangeEndPageFieldInfo = Int32
    type AttrGetType PageRangeEndPageFieldInfo = Int32
    type AttrLabel PageRangeEndPageFieldInfo = "end_page"
    type AttrOrigin PageRangeEndPageFieldInfo = PageRange
    attrGet = getPageRangeEndPage
    attrSet = setPageRangeEndPage
    attrConstruct = undefined
    attrClear = undefined
    attrTransfer _ v = do
        return v

pageRange_endPage :: AttrLabelProxy "endPage"
pageRange_endPage = AttrLabelProxy

#endif



#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList PageRange
type instance O.AttributeList PageRange = PageRangeAttributeList
type PageRangeAttributeList = ('[ '("startPage", PageRangeStartPageFieldInfo), '("endPage", PageRangeEndPageFieldInfo)] :: [(Symbol, *)])
#endif

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

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

#endif