{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A fundamental type that describes a 64-bit bitmask

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

module GI.Gst.Objects.Bitmask
    ( 

-- * Exported types
    Bitmask(..)                             ,
    IsBitmask                               ,
    toBitmask                               ,


 -- * Methods

#if defined(ENABLE_OVERLOADING)
    ResolveBitmaskMethod                    ,
#endif



    ) 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.Coerce as Coerce
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 GHC.Records as R


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

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

foreign import ccall "gst_bitmask_get_type"
    c_gst_bitmask_get_type :: IO B.Types.GType

instance B.Types.TypedObject Bitmask where
    glibType :: IO GType
glibType = IO GType
c_gst_bitmask_get_type

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

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

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

--- XXX Missing getter and/or setter, so no GValue instance could be generated.
#if defined(ENABLE_OVERLOADING)
type family ResolveBitmaskMethod (t :: Symbol) (o :: *) :: * where
    ResolveBitmaskMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveBitmaskMethod t Bitmask, O.OverloadedMethod info Bitmask p) => OL.IsLabel t (Bitmask -> 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 ~ ResolveBitmaskMethod t Bitmask, O.OverloadedMethod info Bitmask p, R.HasField t Bitmask p) => R.HasField t Bitmask p where
    getField = O.overloadedMethod @info

#endif

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

#endif

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