    {-# LANGUAGE TypeApplications #-}

    -- | Copyright  : Will Thompson and Iñaki García Etxebarria
    -- License    : LGPL-2.1
    -- Maintainer : Iñaki García Etxebarria
    --
    -- Structure used for scatter\/gather data output.
    -- You generally pass in an array of @/GOutputVectors/@
    -- and the operation will use all the buffers as if they were
    -- one buffer.
    --
    -- /Since: 2.22/

    #if !defined(__HADDOCK_VERSION__)
    #define ENABLE_OVERLOADING
    #endif

    module GI.Gio.Structs.OutputVector
        (

    -- * Exported types
        OutputVector(..)                        ,
        newZeroOutputVector                     ,

     -- * Methods

    #if defined(ENABLE_OVERLOADING)
        ResolveOutputVectorMethod               ,
    #endif

     -- * Properties

    -- ** buffer #attr:buffer#
    -- | Pointer to a buffer of data to read.

        clearOutputVectorBuffer                 ,
        getOutputVectorBuffer                   ,
    #if defined(ENABLE_OVERLOADING)
        outputVector_buffer                     ,
    #endif
        setOutputVectorBuffer                   ,

    -- ** size #attr:size#
    -- | the size of /@buffer@/.

        getOutputVectorSize                     ,
    #if defined(ENABLE_OVERLOADING)
        outputVector_size                       ,
    #endif
        setOutputVectorSize                     ,

        ) 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.GHashTable as B.GHT
    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.Coerce as Coerce
    import qualified Data.Text as T
    import qualified Data.Kind as DK
    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 GHC.Records as R
    import qualified Data.Word as DW
    import qualified Data.Int as DI
    import qualified System.Posix.Types as SPT
    import qualified Foreign.C.Types as FCT

    -- Workaround for https://gitlab.haskell.org/ghc/ghc/-/issues/23392
    #if MIN_VERSION_base(4,18,0)

    #else

    #endif

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

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

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

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

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

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

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

    -- | Set the value of the “@buffer@” field to `Nothing`.
    -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
    --
    -- @
    -- 'Data.GI.Base.Attributes.clear' #buffer
    -- @
    clearOutputVectorBuffer :: MonadIO m => OutputVector -> m ()
    clearOutputVectorBuffer :: forall (m :: * -> *). MonadIO m => OutputVector -> m ()
    clearOutputVectorBuffer OutputVector
    s = IO () -> m ()
    forall a. IO a -> m a
    forall (m :: * -> *) a. MonadIO m => IO a -> m a
    liftIO (IO () -> m ()) -> IO () -> m ()
    forall a b. (a -> b) -> a -> b
    $ OutputVector -> (Ptr OutputVector -> IO ()) -> IO ()
    forall a c.
    (HasCallStack, ManagedPtrNewtype a) =>
    a -> (Ptr a -> IO c) -> IO c
    withManagedPtr OutputVector
    s ((Ptr OutputVector -> IO ()) -> IO ())
    -> (Ptr OutputVector -> IO ()) -> IO ()
    forall a b. (a -> b) -> a -> b
    $ \Ptr OutputVector
    ptr -> do
        Ptr (Ptr ()) -> Ptr () -> IO ()
    forall a. Storable a => Ptr a -> a -> IO ()
    poke (Ptr OutputVector
    ptr Ptr OutputVector -> Int -> Ptr (Ptr ())
    forall a b. Ptr a -> Int -> Ptr b
    `plusPtr` Int
    0) (Ptr ()
    forall a. Ptr a
    FP.nullPtr :: Ptr ())

    #if defined(ENABLE_OVERLOADING)
    data OutputVectorBufferFieldInfo
    instance AttrInfo OutputVectorBufferFieldInfo where
        type AttrBaseTypeConstraint OutputVectorBufferFieldInfo = (~) OutputVector
        type AttrAllowedOps OutputVectorBufferFieldInfo = '[ 'AttrSet, 'AttrGet, 'AttrClear]
        type AttrSetTypeConstraint OutputVectorBufferFieldInfo = (~) (Ptr ())
        type AttrTransferTypeConstraint OutputVectorBufferFieldInfo = (~)(Ptr ())
        type AttrTransferType OutputVectorBufferFieldInfo = (Ptr ())
        type AttrGetType OutputVectorBufferFieldInfo = Ptr ()
        type AttrLabel OutputVectorBufferFieldInfo = "buffer"
        type AttrOrigin OutputVectorBufferFieldInfo = OutputVector
        attrGet = getOutputVectorBuffer
        attrSet = setOutputVectorBuffer
        attrConstruct = undefined
        attrClear = clearOutputVectorBuffer
        attrTransfer _ v = do
            return v
        dbgAttrInfo = P.Just (O.ResolvedSymbolInfo {
            O.resolvedSymbolName = "GI.Gio.Structs.OutputVector.buffer"
            , O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.38/docs/GI-Gio-Structs-OutputVector.html#g:attr:buffer"
            })

    outputVector_buffer :: AttrLabelProxy "buffer"
    outputVector_buffer = AttrLabelProxy

    #endif

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

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

    #if defined(ENABLE_OVERLOADING)
    data OutputVectorSizeFieldInfo
    instance AttrInfo OutputVectorSizeFieldInfo where
        type AttrBaseTypeConstraint OutputVectorSizeFieldInfo = (~) OutputVector
        type AttrAllowedOps OutputVectorSizeFieldInfo = '[ 'AttrSet, 'AttrGet]
        type AttrSetTypeConstraint OutputVectorSizeFieldInfo = (~) FCT.CSize
        type AttrTransferTypeConstraint OutputVectorSizeFieldInfo = (~)FCT.CSize
        type AttrTransferType OutputVectorSizeFieldInfo = FCT.CSize
        type AttrGetType OutputVectorSizeFieldInfo = FCT.CSize
        type AttrLabel OutputVectorSizeFieldInfo = "size"
        type AttrOrigin OutputVectorSizeFieldInfo = OutputVector
        attrGet = getOutputVectorSize
        attrSet = setOutputVectorSize
        attrConstruct = undefined
        attrClear = undefined
        attrTransfer _ v = do
            return v
        dbgAttrInfo = P.Just (O.ResolvedSymbolInfo {
            O.resolvedSymbolName = "GI.Gio.Structs.OutputVector.size"
            , O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.38/docs/GI-Gio-Structs-OutputVector.html#g:attr:size"
            })

    outputVector_size :: AttrLabelProxy "size"
    outputVector_size = AttrLabelProxy

    #endif

    #if defined(ENABLE_OVERLOADING)
    instance O.HasAttributeList OutputVector
    type instance O.AttributeList OutputVector = OutputVectorAttributeList
    type OutputVectorAttributeList = ('[ '("buffer", OutputVectorBufferFieldInfo), '("size", OutputVectorSizeFieldInfo)] :: [(Symbol, DK.Type)])
    #endif

    #if defined(ENABLE_OVERLOADING)
    type family ResolveOutputVectorMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
        ResolveOutputVectorMethod l o = O.MethodResolutionFailed l o

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

    #if MIN_VERSION_base(4,13,0)
    instance (info ~ ResolveOutputVectorMethod t OutputVector, O.OverloadedMethod info OutputVector p, R.HasField t OutputVector p) => R.HasField t OutputVector p where
        getField = O.overloadedMethod @info

    #endif

    instance (info ~ ResolveOutputVectorMethod t OutputVector, O.OverloadedMethodInfo info OutputVector) => OL.IsLabel t (O.MethodProxy info OutputVector) where
    #if MIN_VERSION_base(4,10,0)
        fromLabel = O.MethodProxy
    #else
        fromLabel _ = O.MethodProxy
    #endif

    #endif