gi-gobject-2.0.18: GI/GObject/Structs/TypeInstance.hs

{- |
Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License    : LGPL-2.1
Maintainer : Iñaki García Etxebarria (inaki@blueleaf.cc)

An opaque structure used as the base of all type instances.
-}

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

module GI.GObject.Structs.TypeInstance
    ( 

-- * Exported types
    TypeInstance(..)                        ,
    newZeroTypeInstance                     ,
    noTypeInstance                          ,


 -- * Methods
-- ** getPrivate #method:getPrivate#

#if ENABLE_OVERLOADING
    TypeInstanceGetPrivateMethodInfo        ,
#endif
    typeInstanceGetPrivate                  ,




    ) 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.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.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 TypeInstance = TypeInstance (ManagedPtr TypeInstance)
instance WrappedPtr TypeInstance where
    wrappedPtrCalloc = callocBytes 8
    wrappedPtrCopy = \p -> withManagedPtr p (copyBytes 8 >=> wrapPtr TypeInstance)
    wrappedPtrFree = Just ptr_to_g_free

-- | Construct a `TypeInstance` struct initialized to zero.
newZeroTypeInstance :: MonadIO m => m TypeInstance
newZeroTypeInstance = liftIO $ wrappedPtrCalloc >>= wrapPtr TypeInstance

instance tag ~ 'AttrSet => Constructible TypeInstance tag where
    new _ attrs = do
        o <- newZeroTypeInstance
        GI.Attributes.set o attrs
        return o


-- | A convenience alias for `Nothing` :: `Maybe` `TypeInstance`.
noTypeInstance :: Maybe TypeInstance
noTypeInstance = Nothing


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

-- method TypeInstance::get_private
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "instance", argType = TInterface (Name {namespace = "GObject", name = "TypeInstance"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Nothing, sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "private_type", argType = TBasicType TGType, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Nothing, sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TPtr)
-- throws : False
-- Skip return : False

foreign import ccall "g_type_instance_get_private" g_type_instance_get_private :: 
    Ptr TypeInstance ->                     -- instance : TInterface (Name {namespace = "GObject", name = "TypeInstance"})
    CGType ->                               -- private_type : TBasicType TGType
    IO (Ptr ())

{- |
/No description available in the introspection data./
-}
typeInstanceGetPrivate ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    TypeInstance
    -> GType
    -> m (Ptr ())
typeInstanceGetPrivate instance_ privateType = liftIO $ do
    instance_' <- unsafeManagedPtrGetPtr instance_
    let privateType' = gtypeToCGType privateType
    result <- g_type_instance_get_private instance_' privateType'
    touchManagedPtr instance_
    return result

#if ENABLE_OVERLOADING
data TypeInstanceGetPrivateMethodInfo
instance (signature ~ (GType -> m (Ptr ())), MonadIO m) => O.MethodInfo TypeInstanceGetPrivateMethodInfo TypeInstance signature where
    overloadedMethod _ = typeInstanceGetPrivate

#endif

#if ENABLE_OVERLOADING
type family ResolveTypeInstanceMethod (t :: Symbol) (o :: *) :: * where
    ResolveTypeInstanceMethod "getPrivate" o = TypeInstanceGetPrivateMethodInfo
    ResolveTypeInstanceMethod l o = O.MethodResolutionFailed l o

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

#endif