{-# 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.Gst.Objects.ValueArray
    ( 

-- * Exported types
    ValueArray(..)                          ,
    IsValueArray                            ,
    toValueArray                            ,


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

#if defined(ENABLE_OVERLOADING)
    ResolveValueArrayMethod                 ,
#endif


-- ** appendAndTakeValue #method:appendAndTakeValue#

    valueArrayAppendAndTakeValue            ,


-- ** appendValue #method:appendValue#

    valueArrayAppendValue                   ,


-- ** getSize #method:getSize#

    valueArrayGetSize                       ,


-- ** getValue #method:getValue#

    valueArrayGetValue                      ,


-- ** prependValue #method:prependValue#

    valueArrayPrependValue                  ,




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

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

foreign import ccall "gst_value_array_get_type"
    c_gst_value_array_get_type :: IO B.Types.GType

instance B.Types.TypedObject ValueArray where
    glibType :: IO GType
glibType = IO GType
c_gst_value_array_get_type

-- | Type class for types which can be safely cast to `ValueArray`, for instance with `toValueArray`.
class (SP.BoxedPtr o, SP.TypedObject o, O.IsDescendantOf ValueArray o) => IsValueArray o
instance (SP.BoxedPtr o, SP.TypedObject o, O.IsDescendantOf ValueArray o) => IsValueArray o

instance O.HasParentTypes ValueArray
type instance O.ParentTypes ValueArray = '[]

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

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

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

#endif

-- XXX Wrapping a foreign struct/union with no known destructor or size, leak?
instance BoxedPtr ValueArray where
    boxedPtrCopy :: ValueArray -> IO ValueArray
boxedPtrCopy = ValueArray -> IO ValueArray
forall (m :: * -> *) a. Monad m => a -> m a
return
    boxedPtrFree :: ValueArray -> IO ()
boxedPtrFree = \ValueArray
_x -> () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()


-- method ValueArray::append_and_take_value
-- method type : MemberFunction
-- Args: [ Arg
--           { argCName = "value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GValue of type #GST_TYPE_ARRAY"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "append_value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the value to append"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferEverything
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "gst_value_array_append_and_take_value" gst_value_array_append_and_take_value :: 
    Ptr GValue ->                           -- value : TGValue
    Ptr GValue ->                           -- append_value : TGValue
    IO ()

-- | Appends /@appendValue@/ to the GstValueArray in /@value@/.
-- 
-- /Since: 1.2/
valueArrayAppendAndTakeValue ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    GValue
    -- ^ /@value@/: a t'GI.GObject.Structs.Value.Value' of type @/GST_TYPE_ARRAY/@
    -> GValue
    -- ^ /@appendValue@/: the value to append
    -> m ()
valueArrayAppendAndTakeValue :: GValue -> GValue -> m ()
valueArrayAppendAndTakeValue GValue
value GValue
appendValue = 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 GValue
value' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
value
    Ptr GValue
appendValue' <- GValue -> IO (Ptr GValue)
B.GValue.disownGValue GValue
appendValue
    Ptr GValue -> Ptr GValue -> IO ()
gst_value_array_append_and_take_value Ptr GValue
value' Ptr GValue
appendValue'
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
value
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
appendValue
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
value'
    () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
#endif

-- method ValueArray::append_value
-- method type : MemberFunction
-- Args: [ Arg
--           { argCName = "value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GValue of type #GST_TYPE_ARRAY"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "append_value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the value to append"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "gst_value_array_append_value" gst_value_array_append_value :: 
    Ptr GValue ->                           -- value : TGValue
    Ptr GValue ->                           -- append_value : TGValue
    IO ()

-- | Appends /@appendValue@/ to the GstValueArray in /@value@/.
valueArrayAppendValue ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    GValue
    -- ^ /@value@/: a t'GI.GObject.Structs.Value.Value' of type @/GST_TYPE_ARRAY/@
    -> GValue
    -- ^ /@appendValue@/: the value to append
    -> m ()
valueArrayAppendValue :: GValue -> GValue -> m ()
valueArrayAppendValue GValue
value GValue
appendValue = 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 GValue
value' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
value
    Ptr GValue
appendValue' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
appendValue
    Ptr GValue -> Ptr GValue -> IO ()
gst_value_array_append_value Ptr GValue
value' Ptr GValue
appendValue'
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
value
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
appendValue
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
value'
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
appendValue'
    () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
#endif

-- method ValueArray::get_size
-- method type : MemberFunction
-- Args: [ Arg
--           { argCName = "value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GValue of type #GST_TYPE_ARRAY"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUInt)
-- throws : False
-- Skip return : False

foreign import ccall "gst_value_array_get_size" gst_value_array_get_size :: 
    Ptr GValue ->                           -- value : TGValue
    IO Word32

-- | Gets the number of values contained in /@value@/.
valueArrayGetSize ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    GValue
    -- ^ /@value@/: a t'GI.GObject.Structs.Value.Value' of type @/GST_TYPE_ARRAY/@
    -> m Word32
    -- ^ __Returns:__ the number of values
valueArrayGetSize :: GValue -> m Word32
valueArrayGetSize GValue
value = IO Word32 -> m Word32
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Word32 -> m Word32) -> IO Word32 -> m Word32
forall a b. (a -> b) -> a -> b
$ do
    Ptr GValue
value' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
value
    Word32
result <- Ptr GValue -> IO Word32
gst_value_array_get_size Ptr GValue
value'
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
value
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
value'
    Word32 -> IO Word32
forall (m :: * -> *) a. Monad m => a -> m a
return Word32
result

#if defined(ENABLE_OVERLOADING)
#endif

-- method ValueArray::get_value
-- method type : MemberFunction
-- Args: [ Arg
--           { argCName = "value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GValue of type #GST_TYPE_ARRAY"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "index"
--           , argType = TBasicType TUInt
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "index of value to get from the array"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just TGValue
-- throws : False
-- Skip return : False

foreign import ccall "gst_value_array_get_value" gst_value_array_get_value :: 
    Ptr GValue ->                           -- value : TGValue
    Word32 ->                               -- index : TBasicType TUInt
    IO (Ptr GValue)

-- | Gets the value that is a member of the array contained in /@value@/ and
-- has the index /@index@/.
valueArrayGetValue ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    GValue
    -- ^ /@value@/: a t'GI.GObject.Structs.Value.Value' of type @/GST_TYPE_ARRAY/@
    -> Word32
    -- ^ /@index@/: index of value to get from the array
    -> m GValue
    -- ^ __Returns:__ the value at the given index
valueArrayGetValue :: GValue -> Word32 -> m GValue
valueArrayGetValue GValue
value Word32
index = IO GValue -> m GValue
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO GValue -> m GValue) -> IO GValue -> m GValue
forall a b. (a -> b) -> a -> b
$ do
    Ptr GValue
value' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
value
    Ptr GValue
result <- Ptr GValue -> Word32 -> IO (Ptr GValue)
gst_value_array_get_value Ptr GValue
value' Word32
index
    Text -> Ptr GValue -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"valueArrayGetValue" Ptr GValue
result
    GValue
result' <- Ptr GValue -> IO GValue
B.GValue.newGValueFromPtr Ptr GValue
result
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
value
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
value'
    GValue -> IO GValue
forall (m :: * -> *) a. Monad m => a -> m a
return GValue
result'

#if defined(ENABLE_OVERLOADING)
#endif

-- method ValueArray::prepend_value
-- method type : MemberFunction
-- Args: [ Arg
--           { argCName = "value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GValue of type #GST_TYPE_ARRAY"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "prepend_value"
--           , argType = TGValue
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the value to prepend"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "gst_value_array_prepend_value" gst_value_array_prepend_value :: 
    Ptr GValue ->                           -- value : TGValue
    Ptr GValue ->                           -- prepend_value : TGValue
    IO ()

-- | Prepends /@prependValue@/ to the GstValueArray in /@value@/.
valueArrayPrependValue ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    GValue
    -- ^ /@value@/: a t'GI.GObject.Structs.Value.Value' of type @/GST_TYPE_ARRAY/@
    -> GValue
    -- ^ /@prependValue@/: the value to prepend
    -> m ()
valueArrayPrependValue :: GValue -> GValue -> m ()
valueArrayPrependValue GValue
value GValue
prependValue = 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 GValue
value' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
value
    Ptr GValue
prependValue' <- GValue -> IO (Ptr GValue)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr GValue
prependValue
    Ptr GValue -> Ptr GValue -> IO ()
gst_value_array_prepend_value Ptr GValue
value' Ptr GValue
prependValue'
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
value
    GValue -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr GValue
prependValue
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
value'
    Ptr GValue -> IO ()
B.GValue.unsetGValue Ptr GValue
prependValue'
    () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
#endif