Package ch.bailu.gtk.gobject

Class TypeModule

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gobject.TypeModule

All Implemented Interfaces:

PointerInterface

Direct Known Subclasses:

IOModule

public class TypeModule
extends Object

#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.

https://docs.gtk.org/gobject/class.TypeModule.html

Nested Class Summary

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
TypeModule(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
void	addInterface(long instance_type, long interface_type, InterfaceInfo interface_info)	Registers an additional interface for a type, whose interface lives in the given type plugin.
TypePlugin	asTypePlugin()	Implements interface TypePlugin.
static ClassHandler	getClassHandler()
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
long	registerEnum(Str name, EnumValue const_static_values)	Looks up or registers an enumeration that is implemented with a particular type plugin.
long	registerEnum(String name, EnumValue const_static_values)	Looks up or registers an enumeration that is implemented with a particular type plugin.
long	registerFlags(Str name, FlagsValue const_static_values)	Looks up or registers a flags type that is implemented with a particular type plugin.
long	registerFlags(String name, FlagsValue const_static_values)	Looks up or registers a flags type that is implemented with a particular type plugin.
long	registerType(long parent_type, Str type_name, TypeInfo type_info, int flags)	Looks up or registers a type that is implemented with a particular type plugin.
long	registerType(long parent_type, String type_name, TypeInfo type_info, int flags)	Looks up or registers a type that is implemented with a particular type plugin.
void	setName(Str name)	Sets the name for a #GTypeModule
void	setName(String name)	Sets the name for a #GTypeModule
void	unuse()	Decreases the use count of a #GTypeModule by one.
boolean	use()	Increases the use count of a #GTypeModule by one.

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

TypeModule

public TypeModule(PointerContainer pointer)

Method Details

getClassHandler

public static ClassHandler getClassHandler()

addInterface

public void addInterface(long instance_type,
 long interface_type,
 @Nonnull
 InterfaceInfo interface_info)

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 %NULL this will call g_type_add_interface_static()
instead. This can be used when making a static build of the module.

Parameters:

instance_type - type to which to add the interface.

interface_type - interface type to add

interface_info - type information structure

registerEnum

public long registerEnum(@Nonnull
 Str name,
 @Nonnull
 EnumValue const_static_values)

Looks up or registers an enumeration that is implemented with a particular
type plugin. If a type with name @type_name 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 %NULL this will call g_type_register_static()
instead. This can be used when making a static build of the module.

Parameters:

name - name for the type

const_static_values - an array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

registerEnum

public long registerEnum(String name,
 @Nonnull
 EnumValue const_static_values)

Looks up or registers an enumeration that is implemented with a particular
type plugin. If a type with name @type_name 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 %NULL this will call g_type_register_static()
instead. This can be used when making a static build of the module.

Parameters:

name - name for the type

const_static_values - an array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

registerFlags

public long registerFlags(@Nonnull
 Str name,
 @Nonnull
 FlagsValue const_static_values)

Looks up or registers a flags type that is implemented with a particular
type plugin. If a type with name @type_name 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 %NULL this will call g_type_register_static()
instead. This can be used when making a static build of the module.

Parameters:

name - name for the type

const_static_values - an array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

registerFlags

public long registerFlags(String name,
 @Nonnull
 FlagsValue const_static_values)

Looks up or registers a flags type that is implemented with a particular
type plugin. If a type with name @type_name 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 %NULL this will call g_type_register_static()
instead. This can be used when making a static build of the module.

Parameters:

name - name for the type

const_static_values - an array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

registerType

public long registerType(long parent_type,
 @Nonnull
 Str type_name,
 @Nonnull
 TypeInfo type_info,
 int flags)

Looks up or registers a type that is implemented with a particular
type plugin. If a type with name @type_name 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 @parent_type 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 %NULL this will call g_type_register_static()
instead. This can be used when making a static build of the module.

Parameters:

parent_type - the type for the parent class

type_name - name for the type

type_info - type information structure

flags - flags field providing details about the type

Returns:

the new or existing type ID

registerType

public long registerType(long parent_type,
 String type_name,
 @Nonnull
 TypeInfo type_info,
 int flags)

Looks up or registers a type that is implemented with a particular
type plugin. If a type with name @type_name 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 @parent_type 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 %NULL this will call g_type_register_static()
instead. This can be used when making a static build of the module.

Parameters:

parent_type - the type for the parent class

type_name - name for the type

type_info - type information structure

flags - flags field providing details about the type

Returns:

the new or existing type ID

setName

public void setName(@Nonnull
 Str name)

Sets the name for a #GTypeModule

Parameters:

name - a human-readable name to use in error messages.

setName

public void setName(String name)

Sets the name for a #GTypeModule

Parameters:

name - a human-readable name to use in error messages.

unuse

public void unuse()

Decreases the use count of a #GTypeModule by one. If the
result is zero, the module will be unloaded. (However, the
#GTypeModule will not be freed, and types associated with the
#GTypeModule are not unregistered. Once a #GTypeModule is
initialized, it must exist forever.)

use

public boolean use()

Increases the use count of a #GTypeModule 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.

Returns:

%FALSE if the plugin needed to be loaded and loading the plugin failed.

asTypePlugin

public TypePlugin asTypePlugin()

Implements interface TypePlugin. Call this to get access to interface functions.

Returns:

TypePlugin

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()