{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- /No description available in the introspection data./

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

module GI.Poppler.Objects.Attachment
    ( 

-- * Exported types
    Attachment(..)                          ,
    IsAttachment                            ,
    toAttachment                            ,


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

#if defined(ENABLE_OVERLOADING)
    ResolveAttachmentMethod                 ,
#endif


-- ** save #method:save#

#if defined(ENABLE_OVERLOADING)
    AttachmentSaveMethodInfo                ,
#endif
    attachmentSave                          ,


-- ** saveToCallback #method:saveToCallback#

#if defined(ENABLE_OVERLOADING)
    AttachmentSaveToCallbackMethodInfo      ,
#endif
    attachmentSaveToCallback                ,




    ) 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

import qualified GI.GObject.Objects.Object as GObject.Object
import qualified GI.Poppler.Callbacks as Poppler.Callbacks

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

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

foreign import ccall "poppler_attachment_get_type"
    c_poppler_attachment_get_type :: IO B.Types.GType

instance B.Types.TypedObject Attachment where
    glibType :: IO GType
glibType = IO GType
c_poppler_attachment_get_type

instance B.Types.GObject Attachment

-- | Convert 'Attachment' to and from 'Data.GI.Base.GValue.GValue' with 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue Attachment where
    toGValue :: Attachment -> IO GValue
toGValue Attachment
o = do
        GType
gtype <- IO GType
c_poppler_attachment_get_type
        Attachment -> (Ptr Attachment -> IO GValue) -> IO GValue
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr Attachment
o (GType
-> (GValue -> Ptr Attachment -> IO ())
-> Ptr Attachment
-> IO GValue
forall a. GType -> (GValue -> a -> IO ()) -> a -> IO GValue
B.GValue.buildGValue GType
gtype GValue -> Ptr Attachment -> IO ()
forall a. GObject a => GValue -> Ptr a -> IO ()
B.GValue.set_object)
        
    fromGValue :: GValue -> IO Attachment
fromGValue GValue
gv = do
        Ptr Attachment
ptr <- GValue -> IO (Ptr Attachment)
forall b. GObject b => GValue -> IO (Ptr b)
B.GValue.get_object GValue
gv :: IO (Ptr Attachment)
        (ManagedPtr Attachment -> Attachment)
-> Ptr Attachment -> IO Attachment
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
B.ManagedPtr.newObject ManagedPtr Attachment -> Attachment
Attachment Ptr Attachment
ptr
        
    

-- | Type class for types which can be safely cast to `Attachment`, for instance with `toAttachment`.
class (SP.GObject o, O.IsDescendantOf Attachment o) => IsAttachment o
instance (SP.GObject o, O.IsDescendantOf Attachment o) => IsAttachment o

instance O.HasParentTypes Attachment
type instance O.ParentTypes Attachment = '[GObject.Object.Object]

-- | Cast to `Attachment`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toAttachment :: (MonadIO m, IsAttachment o) => o -> m Attachment
toAttachment :: o -> m Attachment
toAttachment = IO Attachment -> m Attachment
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Attachment -> m Attachment)
-> (o -> IO Attachment) -> o -> m Attachment
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (ManagedPtr Attachment -> Attachment) -> o -> IO Attachment
forall o o'.
(HasCallStack, ManagedPtrNewtype o, TypedObject o,
 ManagedPtrNewtype o', TypedObject o') =>
(ManagedPtr o' -> o') -> o -> IO o'
unsafeCastTo ManagedPtr Attachment -> Attachment
Attachment

#if defined(ENABLE_OVERLOADING)
type family ResolveAttachmentMethod (t :: Symbol) (o :: *) :: * where
    ResolveAttachmentMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
    ResolveAttachmentMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
    ResolveAttachmentMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
    ResolveAttachmentMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
    ResolveAttachmentMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
    ResolveAttachmentMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
    ResolveAttachmentMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
    ResolveAttachmentMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
    ResolveAttachmentMethod "ref" o = GObject.Object.ObjectRefMethodInfo
    ResolveAttachmentMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
    ResolveAttachmentMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
    ResolveAttachmentMethod "save" o = AttachmentSaveMethodInfo
    ResolveAttachmentMethod "saveToCallback" o = AttachmentSaveToCallbackMethodInfo
    ResolveAttachmentMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
    ResolveAttachmentMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
    ResolveAttachmentMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
    ResolveAttachmentMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
    ResolveAttachmentMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
    ResolveAttachmentMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
    ResolveAttachmentMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
    ResolveAttachmentMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
    ResolveAttachmentMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
    ResolveAttachmentMethod "setDataFull" o = GObject.Object.ObjectSetDataFullMethodInfo
    ResolveAttachmentMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
    ResolveAttachmentMethod l o = O.MethodResolutionFailed l o

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

#endif

#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList Attachment
type instance O.AttributeList Attachment = AttachmentAttributeList
type AttachmentAttributeList = ('[ ] :: [(Symbol, *)])
#endif

#if defined(ENABLE_OVERLOADING)
#endif

#if defined(ENABLE_OVERLOADING)
type instance O.SignalList Attachment = AttachmentSignalList
type AttachmentSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, *)])

#endif

-- method Attachment::save
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "attachment"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "Attachment" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "A #PopplerAttachment."
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "filename"
--           , argType = TBasicType TUTF8
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "name of file to save"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False

foreign import ccall "poppler_attachment_save" poppler_attachment_save :: 
    Ptr Attachment ->                       -- attachment : TInterface (Name {namespace = "Poppler", name = "Attachment"})
    CString ->                              -- filename : TBasicType TUTF8
    Ptr (Ptr GError) ->                     -- error
    IO CInt

-- | Saves /@attachment@/ to a file indicated by /@filename@/.  If /@error@/ is set, 'P.False'
-- will be returned. Possible errors include those in the @/G_FILE_ERROR/@ domain
-- and whatever the save function generates.
attachmentSave ::
    (B.CallStack.HasCallStack, MonadIO m, IsAttachment a) =>
    a
    -- ^ /@attachment@/: A t'GI.Poppler.Objects.Attachment.Attachment'.
    -> T.Text
    -- ^ /@filename@/: name of file to save
    -> m ()
    -- ^ /(Can throw 'Data.GI.Base.GError.GError')/
attachmentSave :: a -> Text -> m ()
attachmentSave a
attachment Text
filename = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr Attachment
attachment' <- a -> IO (Ptr Attachment)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
attachment
    CString
filename' <- Text -> IO CString
textToCString Text
filename
    IO () -> IO () -> IO ()
forall a b. IO a -> IO b -> IO a
onException (do
        CInt
_ <- (Ptr (Ptr GError) -> IO CInt) -> IO CInt
forall a. (Ptr (Ptr GError) -> IO a) -> IO a
propagateGError ((Ptr (Ptr GError) -> IO CInt) -> IO CInt)
-> (Ptr (Ptr GError) -> IO CInt) -> IO CInt
forall a b. (a -> b) -> a -> b
$ Ptr Attachment -> CString -> Ptr (Ptr GError) -> IO CInt
poppler_attachment_save Ptr Attachment
attachment' CString
filename'
        a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
attachment
        CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
filename'
        () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()
     ) (do
        CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
filename'
     )

#if defined(ENABLE_OVERLOADING)
data AttachmentSaveMethodInfo
instance (signature ~ (T.Text -> m ()), MonadIO m, IsAttachment a) => O.MethodInfo AttachmentSaveMethodInfo a signature where
    overloadedMethod = attachmentSave

#endif

-- method Attachment::save_to_callback
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "attachment"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "Attachment" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "A #PopplerAttachment."
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "save_func"
--           , argType =
--               TInterface
--                 Name { namespace = "Poppler" , name = "AttachmentSaveFunc" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText =
--                     Just
--                       "a function that is called to save each block of data that the save routine generates."
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeCall
--           , argClosure = 2
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "user_data"
--           , argType = TBasicType TPtr
--           , direction = DirectionIn
--           , mayBeNull = True
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "user data to pass to the save function."
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TBoolean)
-- throws : True
-- Skip return : False

foreign import ccall "poppler_attachment_save_to_callback" poppler_attachment_save_to_callback :: 
    Ptr Attachment ->                       -- attachment : TInterface (Name {namespace = "Poppler", name = "Attachment"})
    FunPtr Poppler.Callbacks.C_AttachmentSaveFunc -> -- save_func : TInterface (Name {namespace = "Poppler", name = "AttachmentSaveFunc"})
    Ptr () ->                               -- user_data : TBasicType TPtr
    Ptr (Ptr GError) ->                     -- error
    IO CInt

-- | Saves /@attachment@/ by feeding the produced data to /@saveFunc@/. Can be used
-- when you want to store the attachment to something other than a file, such as
-- an in-memory buffer or a socket. If /@error@/ is set, 'P.False' will be
-- returned. Possible errors include those in the @/G_FILE_ERROR/@ domain and
-- whatever the save function generates.
attachmentSaveToCallback ::
    (B.CallStack.HasCallStack, MonadIO m, IsAttachment a) =>
    a
    -- ^ /@attachment@/: A t'GI.Poppler.Objects.Attachment.Attachment'.
    -> FunPtr Poppler.Callbacks.C_AttachmentSaveFunc
    -- ^ /@saveFunc@/: a function that is called to save each block of data that the save routine generates.
    -> m ()
    -- ^ /(Can throw 'Data.GI.Base.GError.GError')/
attachmentSaveToCallback :: a -> FunPtr C_AttachmentSaveFunc -> m ()
attachmentSaveToCallback a
attachment FunPtr C_AttachmentSaveFunc
saveFunc = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr Attachment
attachment' <- a -> IO (Ptr Attachment)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
attachment
    let userData :: Ptr a
userData = Ptr a
forall a. Ptr a
nullPtr
    IO () -> IO () -> IO ()
forall a b. IO a -> IO b -> IO a
onException (do
        CInt
_ <- (Ptr (Ptr GError) -> IO CInt) -> IO CInt
forall a. (Ptr (Ptr GError) -> IO a) -> IO a
propagateGError ((Ptr (Ptr GError) -> IO CInt) -> IO CInt)
-> (Ptr (Ptr GError) -> IO CInt) -> IO CInt
forall a b. (a -> b) -> a -> b
$ Ptr Attachment
-> FunPtr C_AttachmentSaveFunc
-> Ptr ()
-> Ptr (Ptr GError)
-> IO CInt
poppler_attachment_save_to_callback Ptr Attachment
attachment' FunPtr C_AttachmentSaveFunc
saveFunc Ptr ()
forall a. Ptr a
userData
        Ptr Any -> IO ()
forall a. Ptr a -> IO ()
safeFreeFunPtr (Ptr Any -> IO ()) -> Ptr Any -> IO ()
forall a b. (a -> b) -> a -> b
$ FunPtr C_AttachmentSaveFunc -> Ptr Any
forall a b. FunPtr a -> Ptr b
castFunPtrToPtr FunPtr C_AttachmentSaveFunc
saveFunc
        a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
attachment
        () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()
     ) (do
        Ptr Any -> IO ()
forall a. Ptr a -> IO ()
safeFreeFunPtr (Ptr Any -> IO ()) -> Ptr Any -> IO ()
forall a b. (a -> b) -> a -> b
$ FunPtr C_AttachmentSaveFunc -> Ptr Any
forall a b. FunPtr a -> Ptr b
castFunPtrToPtr FunPtr C_AttachmentSaveFunc
saveFunc
        () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()
     )

#if defined(ENABLE_OVERLOADING)
data AttachmentSaveToCallbackMethodInfo
instance (signature ~ (FunPtr Poppler.Callbacks.C_AttachmentSaveFunc -> m ()), MonadIO m, IsAttachment a) => O.MethodInfo AttachmentSaveToCallbackMethodInfo a signature where
    overloadedMethod = attachmentSaveToCallback

#endif