TypeModule.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)

'GI.GObject.Objects.TypeModule.TypeModule' provides a simple implementation of the 'GI.GObject.Interfaces.TypePlugin.TypePlugin'
interface. The model of 'GI.GObject.Objects.TypeModule.TypeModule' is a dynamically loaded module
which implements some number of types and interface implementations.
When the module is loaded, it registers its types and interfaces
using 'GI.GObject.Objects.TypeModule.typeModuleRegisterType' and 'GI.GObject.Objects.TypeModule.typeModuleAddInterface'.
As long as any instances of these types and interface implementations
are in use, the module is kept loaded. When the types and interfaces
are gone, the module may be unloaded. If the types and interfaces
become used again, the module will be reloaded. Note that the last
unref cannot happen in module code, since that would lead to the
caller\'s code being unloaded before 'GI.GObject.Objects.Object.objectUnref' returns to it.

Keeping track of whether the module should be loaded or not is done by
using a use count - it starts at zero, and whenever it is greater than
zero, the module is loaded. The use count is maintained internally by
the type system, but also can be explicitly controlled by
'GI.GObject.Objects.TypeModule.typeModuleUse' and 'GI.GObject.Objects.TypeModule.typeModuleUnuse'. Typically, when loading
a module for the first type, 'GI.GObject.Objects.TypeModule.typeModuleUse' will be used to load
it so that it can initialize its types. At some later point, when the
module no longer needs to be loaded except for the type
implementations it contains, 'GI.GObject.Objects.TypeModule.typeModuleUnuse' is called.

'GI.GObject.Objects.TypeModule.TypeModule' does not actually provide any implementation of module
loading and unloading. To create a particular module type you must
derive from 'GI.GObject.Objects.TypeModule.TypeModule' and implement the load and unload functions
in 'GI.GObject.Structs.TypeModuleClass.TypeModuleClass'.
-}

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

module GI.GObject.Objects.TypeModule
    ( 

-- * Exported types
    TypeModule(..)                          ,
    IsTypeModule                            ,
    toTypeModule                            ,
    noTypeModule                            ,


 -- * Methods
-- ** addInterface #method:addInterface#

#if ENABLE_OVERLOADING
    TypeModuleAddInterfaceMethodInfo        ,
#endif
    typeModuleAddInterface                  ,


-- ** registerEnum #method:registerEnum#

#if ENABLE_OVERLOADING
    TypeModuleRegisterEnumMethodInfo        ,
#endif
    typeModuleRegisterEnum                  ,


-- ** registerFlags #method:registerFlags#

#if ENABLE_OVERLOADING
    TypeModuleRegisterFlagsMethodInfo       ,
#endif
    typeModuleRegisterFlags                 ,


-- ** registerType #method:registerType#

#if ENABLE_OVERLOADING
    TypeModuleRegisterTypeMethodInfo        ,
#endif
    typeModuleRegisterType                  ,


-- ** setName #method:setName#

#if ENABLE_OVERLOADING
    TypeModuleSetNameMethodInfo             ,
#endif
    typeModuleSetName                       ,


-- ** unuse #method:unuse#

#if ENABLE_OVERLOADING
    TypeModuleUnuseMethodInfo               ,
#endif
    typeModuleUnuse                         ,


-- ** use #method:use#

#if ENABLE_OVERLOADING
    TypeModuleUseMethodInfo                 ,
#endif
    typeModuleUse                           ,




    ) 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

import {-# SOURCE #-} qualified GI.GObject.Flags as GObject.Flags
import {-# SOURCE #-} qualified GI.GObject.Interfaces.TypePlugin as GObject.TypePlugin
import {-# SOURCE #-} qualified GI.GObject.Objects.Object as GObject.Object
import {-# SOURCE #-} qualified GI.GObject.Structs.EnumValue as GObject.EnumValue
import {-# SOURCE #-} qualified GI.GObject.Structs.FlagsValue as GObject.FlagsValue
import {-# SOURCE #-} qualified GI.GObject.Structs.InterfaceInfo as GObject.InterfaceInfo
import {-# SOURCE #-} qualified GI.GObject.Structs.TypeInfo as GObject.TypeInfo

-- | Memory-managed wrapper type.
newtype TypeModule = TypeModule (ManagedPtr TypeModule)
foreign import ccall "g_type_module_get_type"
    c_g_type_module_get_type :: IO GType

instance GObject TypeModule where
    gobjectType = c_g_type_module_get_type
    

-- | Type class for types which can be safely cast to `TypeModule`, for instance with `toTypeModule`.
class (GObject o, O.IsDescendantOf TypeModule o) => IsTypeModule o
instance (GObject o, O.IsDescendantOf TypeModule o) => IsTypeModule o

instance O.HasParentTypes TypeModule
type instance O.ParentTypes TypeModule = '[GObject.Object.Object, GObject.TypePlugin.TypePlugin]

-- | Cast to `TypeModule`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toTypeModule :: (MonadIO m, IsTypeModule o) => o -> m TypeModule
toTypeModule = liftIO . unsafeCastTo TypeModule

-- | A convenience alias for `Nothing` :: `Maybe` `TypeModule`.
noTypeModule :: Maybe TypeModule
noTypeModule = Nothing

#if ENABLE_OVERLOADING
type family ResolveTypeModuleMethod (t :: Symbol) (o :: *) :: * where
    ResolveTypeModuleMethod "addInterface" o = TypeModuleAddInterfaceMethodInfo
    ResolveTypeModuleMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
    ResolveTypeModuleMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
    ResolveTypeModuleMethod "completeInterfaceInfo" o = GObject.TypePlugin.TypePluginCompleteInterfaceInfoMethodInfo
    ResolveTypeModuleMethod "completeTypeInfo" o = GObject.TypePlugin.TypePluginCompleteTypeInfoMethodInfo
    ResolveTypeModuleMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
    ResolveTypeModuleMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
    ResolveTypeModuleMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
    ResolveTypeModuleMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
    ResolveTypeModuleMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
    ResolveTypeModuleMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
    ResolveTypeModuleMethod "ref" o = GObject.Object.ObjectRefMethodInfo
    ResolveTypeModuleMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
    ResolveTypeModuleMethod "registerEnum" o = TypeModuleRegisterEnumMethodInfo
    ResolveTypeModuleMethod "registerFlags" o = TypeModuleRegisterFlagsMethodInfo
    ResolveTypeModuleMethod "registerType" o = TypeModuleRegisterTypeMethodInfo
    ResolveTypeModuleMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
    ResolveTypeModuleMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
    ResolveTypeModuleMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
    ResolveTypeModuleMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
    ResolveTypeModuleMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
    ResolveTypeModuleMethod "unuse" o = TypeModuleUnuseMethodInfo
    ResolveTypeModuleMethod "use" o = TypeModuleUseMethodInfo
    ResolveTypeModuleMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
    ResolveTypeModuleMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
    ResolveTypeModuleMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
    ResolveTypeModuleMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
    ResolveTypeModuleMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
    ResolveTypeModuleMethod "setDataFull" o = GObject.Object.ObjectSetDataFullMethodInfo
    ResolveTypeModuleMethod "setName" o = TypeModuleSetNameMethodInfo
    ResolveTypeModuleMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
    ResolveTypeModuleMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveTypeModuleMethod t TypeModule, O.MethodInfo info TypeModule p) => OL.IsLabel t (TypeModule -> 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

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

#if ENABLE_OVERLOADING
#endif

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

#endif

-- method TypeModule::add_interface
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "instance_type", argType = TBasicType TGType, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "type to which to add the interface.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interface_type", argType = TBasicType TGType, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "interface type to add", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "interface_info", argType = TInterface (Name {namespace = "GObject", name = "InterfaceInfo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "type information structure", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_add_interface" g_type_module_add_interface :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    CGType ->                               -- instance_type : TBasicType TGType
    CGType ->                               -- interface_type : TBasicType TGType
    Ptr GObject.InterfaceInfo.InterfaceInfo -> -- interface_info : TInterface (Name {namespace = "GObject", name = "InterfaceInfo"})
    IO ()

{- |
Registers an additional interface for a type, whose interface lives
in the given type plugin. If the interface was already registered
for the type in this plugin, nothing will be done.

As long as any instances of the type exist, the type plugin will
not be unloaded.

Since 2.56 if /@module@/ is 'Nothing' this will call 'GI.GObject.Functions.typeAddInterfaceStatic'
instead. This can be used when making a static build of the module.
-}
typeModuleAddInterface ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule' -}
    -> GType
    {- ^ /@instanceType@/: type to which to add the interface. -}
    -> GType
    {- ^ /@interfaceType@/: interface type to add -}
    -> GObject.InterfaceInfo.InterfaceInfo
    {- ^ /@interfaceInfo@/: type information structure -}
    -> m ()
typeModuleAddInterface module_ instanceType interfaceType interfaceInfo = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    let instanceType' = gtypeToCGType instanceType
    let interfaceType' = gtypeToCGType interfaceType
    interfaceInfo' <- unsafeManagedPtrGetPtr interfaceInfo
    g_type_module_add_interface module_' instanceType' interfaceType' interfaceInfo'
    touchManagedPtr module_
    touchManagedPtr interfaceInfo
    return ()

#if ENABLE_OVERLOADING
data TypeModuleAddInterfaceMethodInfo
instance (signature ~ (GType -> GType -> GObject.InterfaceInfo.InterfaceInfo -> m ()), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleAddInterfaceMethodInfo a signature where
    overloadedMethod _ = typeModuleAddInterface

#endif

-- method TypeModule::register_enum
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name for the type", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "const_static_values", argType = TInterface (Name {namespace = "GObject", name = "EnumValue"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "an array of #GEnumValue structs for the\n                      possible enumeration values. The array is\n                      terminated by a struct with all members being\n                      0.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TGType)
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_register_enum" g_type_module_register_enum :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    CString ->                              -- name : TBasicType TUTF8
    Ptr GObject.EnumValue.EnumValue ->      -- const_static_values : TInterface (Name {namespace = "GObject", name = "EnumValue"})
    IO CGType

{- |
Looks up or registers an enumeration that is implemented with a particular
type plugin. If a type with name /@typeName@/ was previously registered,
the 'GType' identifier for the type is returned, otherwise the type
is newly registered, and the resulting 'GType' identifier returned.

As long as any instances of the type exist, the type plugin will
not be unloaded.

Since 2.56 if /@module@/ is 'Nothing' this will call 'GI.GObject.Functions.typeRegisterStatic'
instead. This can be used when making a static build of the module.

/Since: 2.6/
-}
typeModuleRegisterEnum ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule' -}
    -> T.Text
    {- ^ /@name@/: name for the type -}
    -> GObject.EnumValue.EnumValue
    {- ^ /@constStaticValues@/: an array of 'GI.GObject.Structs.EnumValue.EnumValue' structs for the
                      possible enumeration values. The array is
                      terminated by a struct with all members being
                      0. -}
    -> m GType
    {- ^ __Returns:__ the new or existing type ID -}
typeModuleRegisterEnum module_ name constStaticValues = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    name' <- textToCString name
    constStaticValues' <- unsafeManagedPtrGetPtr constStaticValues
    result <- g_type_module_register_enum module_' name' constStaticValues'
    let result' = GType result
    touchManagedPtr module_
    touchManagedPtr constStaticValues
    freeMem name'
    return result'

#if ENABLE_OVERLOADING
data TypeModuleRegisterEnumMethodInfo
instance (signature ~ (T.Text -> GObject.EnumValue.EnumValue -> m GType), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleRegisterEnumMethodInfo a signature where
    overloadedMethod _ = typeModuleRegisterEnum

#endif

-- method TypeModule::register_flags
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name for the type", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "const_static_values", argType = TInterface (Name {namespace = "GObject", name = "FlagsValue"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "an array of #GFlagsValue structs for the\n                      possible flags values. The array is\n                      terminated by a struct with all members being\n                      0.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TGType)
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_register_flags" g_type_module_register_flags :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    CString ->                              -- name : TBasicType TUTF8
    Ptr GObject.FlagsValue.FlagsValue ->    -- const_static_values : TInterface (Name {namespace = "GObject", name = "FlagsValue"})
    IO CGType

{- |
Looks up or registers a flags type that is implemented with a particular
type plugin. If a type with name /@typeName@/ was previously registered,
the 'GType' identifier for the type is returned, otherwise the type
is newly registered, and the resulting 'GType' identifier returned.

As long as any instances of the type exist, the type plugin will
not be unloaded.

Since 2.56 if /@module@/ is 'Nothing' this will call 'GI.GObject.Functions.typeRegisterStatic'
instead. This can be used when making a static build of the module.

/Since: 2.6/
-}
typeModuleRegisterFlags ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule' -}
    -> T.Text
    {- ^ /@name@/: name for the type -}
    -> GObject.FlagsValue.FlagsValue
    {- ^ /@constStaticValues@/: an array of 'GI.GObject.Structs.FlagsValue.FlagsValue' structs for the
                      possible flags values. The array is
                      terminated by a struct with all members being
                      0. -}
    -> m GType
    {- ^ __Returns:__ the new or existing type ID -}
typeModuleRegisterFlags module_ name constStaticValues = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    name' <- textToCString name
    constStaticValues' <- unsafeManagedPtrGetPtr constStaticValues
    result <- g_type_module_register_flags module_' name' constStaticValues'
    let result' = GType result
    touchManagedPtr module_
    touchManagedPtr constStaticValues
    freeMem name'
    return result'

#if ENABLE_OVERLOADING
data TypeModuleRegisterFlagsMethodInfo
instance (signature ~ (T.Text -> GObject.FlagsValue.FlagsValue -> m GType), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleRegisterFlagsMethodInfo a signature where
    overloadedMethod _ = typeModuleRegisterFlags

#endif

-- method TypeModule::register_type
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "parent_type", argType = TBasicType TGType, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the type for the parent class", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type_name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name for the type", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type_info", argType = TInterface (Name {namespace = "GObject", name = "TypeInfo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "type information structure", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "flags", argType = TInterface (Name {namespace = "GObject", name = "TypeFlags"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "flags field providing details about the type", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TGType)
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_register_type" g_type_module_register_type :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    CGType ->                               -- parent_type : TBasicType TGType
    CString ->                              -- type_name : TBasicType TUTF8
    Ptr GObject.TypeInfo.TypeInfo ->        -- type_info : TInterface (Name {namespace = "GObject", name = "TypeInfo"})
    CUInt ->                                -- flags : TInterface (Name {namespace = "GObject", name = "TypeFlags"})
    IO CGType

{- |
Looks up or registers a type that is implemented with a particular
type plugin. If a type with name /@typeName@/ was previously registered,
the 'GType' identifier for the type is returned, otherwise the type
is newly registered, and the resulting 'GType' identifier returned.

When reregistering a type (typically because a module is unloaded
then reloaded, and reinitialized), /@module@/ and /@parentType@/ must
be the same as they were previously.

As long as any instances of the type exist, the type plugin will
not be unloaded.

Since 2.56 if /@module@/ is 'Nothing' this will call 'GI.GObject.Functions.typeRegisterStatic'
instead. This can be used when making a static build of the module.
-}
typeModuleRegisterType ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule' -}
    -> GType
    {- ^ /@parentType@/: the type for the parent class -}
    -> T.Text
    {- ^ /@typeName@/: name for the type -}
    -> GObject.TypeInfo.TypeInfo
    {- ^ /@typeInfo@/: type information structure -}
    -> [GObject.Flags.TypeFlags]
    {- ^ /@flags@/: flags field providing details about the type -}
    -> m GType
    {- ^ __Returns:__ the new or existing type ID -}
typeModuleRegisterType module_ parentType typeName typeInfo flags = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    let parentType' = gtypeToCGType parentType
    typeName' <- textToCString typeName
    typeInfo' <- unsafeManagedPtrGetPtr typeInfo
    let flags' = gflagsToWord flags
    result <- g_type_module_register_type module_' parentType' typeName' typeInfo' flags'
    let result' = GType result
    touchManagedPtr module_
    touchManagedPtr typeInfo
    freeMem typeName'
    return result'

#if ENABLE_OVERLOADING
data TypeModuleRegisterTypeMethodInfo
instance (signature ~ (GType -> T.Text -> GObject.TypeInfo.TypeInfo -> [GObject.Flags.TypeFlags] -> m GType), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleRegisterTypeMethodInfo a signature where
    overloadedMethod _ = typeModuleRegisterType

#endif

-- method TypeModule::set_name
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a human-readable name to use in error messages.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_set_name" g_type_module_set_name :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    CString ->                              -- name : TBasicType TUTF8
    IO ()

{- |
Sets the name for a 'GI.GObject.Objects.TypeModule.TypeModule'
-}
typeModuleSetName ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule'. -}
    -> T.Text
    {- ^ /@name@/: a human-readable name to use in error messages. -}
    -> m ()
typeModuleSetName module_ name = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    name' <- textToCString name
    g_type_module_set_name module_' name'
    touchManagedPtr module_
    freeMem name'
    return ()

#if ENABLE_OVERLOADING
data TypeModuleSetNameMethodInfo
instance (signature ~ (T.Text -> m ()), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleSetNameMethodInfo a signature where
    overloadedMethod _ = typeModuleSetName

#endif

-- method TypeModule::unuse
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_unuse" g_type_module_unuse :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    IO ()

{- |
Decreases the use count of a 'GI.GObject.Objects.TypeModule.TypeModule' by one. If the
result is zero, the module will be unloaded. (However, the
'GI.GObject.Objects.TypeModule.TypeModule' will not be freed, and types associated with the
'GI.GObject.Objects.TypeModule.TypeModule' are not unregistered. Once a 'GI.GObject.Objects.TypeModule.TypeModule' is
initialized, it must exist forever.)
-}
typeModuleUnuse ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule' -}
    -> m ()
typeModuleUnuse module_ = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    g_type_module_unuse module_'
    touchManagedPtr module_
    return ()

#if ENABLE_OVERLOADING
data TypeModuleUnuseMethodInfo
instance (signature ~ (m ()), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleUnuseMethodInfo a signature where
    overloadedMethod _ = typeModuleUnuse

#endif

-- method TypeModule::use
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "module", argType = TInterface (Name {namespace = "GObject", name = "TypeModule"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GTypeModule", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False

foreign import ccall "g_type_module_use" g_type_module_use :: 
    Ptr TypeModule ->                       -- module : TInterface (Name {namespace = "GObject", name = "TypeModule"})
    IO CInt

{- |
Increases the use count of a 'GI.GObject.Objects.TypeModule.TypeModule' by one. If the
use count was zero before, the plugin will be loaded.
If loading the plugin fails, the use count is reset to
its prior value.
-}
typeModuleUse ::
    (B.CallStack.HasCallStack, MonadIO m, IsTypeModule a) =>
    a
    {- ^ /@module@/: a 'GI.GObject.Objects.TypeModule.TypeModule' -}
    -> m Bool
    {- ^ __Returns:__ 'False' if the plugin needed to be loaded and
 loading the plugin failed. -}
typeModuleUse module_ = liftIO $ do
    module_' <- unsafeManagedPtrCastPtr module_
    result <- g_type_module_use module_'
    let result' = (/= 0) result
    touchManagedPtr module_
    return result'

#if ENABLE_OVERLOADING
data TypeModuleUseMethodInfo
instance (signature ~ (m Bool), MonadIO m, IsTypeModule a) => O.MethodInfo TypeModuleUseMethodInfo a signature where
    overloadedMethod _ = typeModuleUse

#endif