TypeModule
open class TypeModule : Object, TypeModuleProtocol
GTypeModule
provides a simple implementation of the GTypePlugin
interface.
The model of GTypeModule
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 g_type_module_register_type()
and g_type_module_add_interface()
.
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
reference cannot be released from within the module code, since that
would lead to the caller’s code being unloaded before g_object_unref()
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
g_type_module_use()
and g_type_module_unuse()
. Typically, when loading
a module for the first type, g_type_module_use()
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, g_type_module_unuse()
is called.
GTypeModule
does not actually provide any implementation of module
loading and unloading. To create a particular module type you must
derive from GTypeModule
and implement the load and unload functions
in GTypeModuleClass
.
The TypeModule
type acts as a reference-counted owner of an underlying GTypeModule
instance.
It provides the methods that can operate on this data type through TypeModuleProtocol
conformance.
Use TypeModule
as a strong reference or owner of a GTypeModule
instance.
-
Designated initialiser from the underlying `C` data type.
This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the
TypeModule
instance.Declaration
Swift
@inlinable public init(_ op: UnsafeMutablePointer<GTypeModule>)
Parameters
op
pointer to the underlying object
-
Designated initialiser from a constant pointer to the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theTypeModule
instance.Declaration
Swift
@inlinable public init(_ op: UnsafePointer<GTypeModule>)
Parameters
op
pointer to the underlying object
-
Optional initialiser from a non-mutating
gpointer
to the underlyingC
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theTypeModule
instance.Declaration
Swift
@inlinable override public init!(gpointer op: gpointer?)
Parameters
op
gpointer to the underlying object
-
Optional initialiser from a non-mutating
gconstpointer
to the underlyingC
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theTypeModule
instance.Declaration
Swift
@inlinable override public init!(gconstpointer op: gconstpointer?)
Parameters
op
pointer to the underlying object
-
Optional initialiser from a constant pointer to the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theTypeModule
instance.Declaration
Swift
@inlinable public init!(_ op: UnsafePointer<GTypeModule>?)
Parameters
op
pointer to the underlying object
-
Optional initialiser from the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theTypeModule
instance.Declaration
Swift
@inlinable public init!(_ op: UnsafeMutablePointer<GTypeModule>?)
Parameters
op
pointer to the underlying object
-
Designated initialiser from the underlying
C
data type. Will retainGTypeModule
. i.e., ownership is transferred to theTypeModule
instance.Declaration
Swift
@inlinable public init(retaining op: UnsafeMutablePointer<GTypeModule>)
Parameters
op
pointer to the underlying object
-
Reference intialiser for a related type that implements
TypeModuleProtocol
Will retainGTypeModule
.Declaration
Swift
@inlinable public init<T>(typeModule other: T) where T : TypeModuleProtocol
Parameters
other
an instance of a related type that implements
TypeModuleProtocol
-
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable override public init<T>(cPointer p: UnsafeMutablePointer<T>)
Parameters
cPointer
pointer to the underlying object
-
Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)
Parameters
cPointer
pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable override public init(raw p: UnsafeRawPointer)
Parameters
p
raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable override public init(retainingRaw raw: UnsafeRawPointer)
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable public required init(raw p: UnsafeMutableRawPointer)
Parameters
p
mutable raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable required public init(retainingRaw raw: UnsafeMutableRawPointer)
Parameters
raw
mutable raw pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable override public init(opaquePointer p: OpaquePointer)
Parameters
p
opaque pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
TypeModuleProtocol
.Declaration
Swift
@inlinable override public init(retainingOpaquePointer p: OpaquePointer)
Parameters
p
opaque pointer to the underlying object