Module

Description These functions provide a portable way to dynamically load object files (commonly known as 'plug-ins'). The current implementation supports all systems that provide an implementation of dlopen() (e.g. Linux/Sun), as well as HP-UX via its shl_load() mechanism, and Windows platforms via DLLs. A program which wants to use these functions must be linked to the libraries output by the command pkg-config --libs gmodule-2.0. To use them you must first determine whether dynamic loading is supported on the platform by calling g_module_supported(). If it is, you can open a module with g_module_open(), find the module's symbols (e.g. function names) with g_module_symbol(), and later close the module with g_module_close(). g_module_name() will return the file name of a currently opened module. If any of the above functions fail, the error status can be found with g_module_error(). The GModule implementation features reference counting for opened modules, and supports hook functions within a module which are called when the module is loaded and unloaded (see GModuleCheckInit and GModuleUnload). If your module introduces static data to common subsystems in the running program, e.g. through calling g_quark_from_static_string ("my-module-stuff"), it must ensure that it is never unloaded, by calling g_module_make_resident().

class Module {

protected

GModule* gModule;

GModule* getModuleStruct();

void* getStruct();

this(GModule* gModule);

static Module open(string fileName, GModuleFlags flags);

static int supported();

static string buildPath(string directory, string moduleName);

int symbol(string symbolName, void** symbol);

void makeResident();

int close();

static string error();

}

Constructors

this this(GModule* gModule): Sets our main struct and passes it to the parent class

Members

Functions

close int close(): Closes a module.
getModuleStruct GModule* getModuleStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
makeResident void makeResident(): Ensures that a module will never be unloaded. Any future g_module_close() calls on the module will be ignored.
symbol
int symbol(string symbolName, void** symbol): Gets a symbol pointer from a module, such as one exported by G_MODULE_EXPORT. Note that a valid symbol can be NULL.

Static functions

buildPath string buildPath(string directory, string moduleName): A portable way to build the filename of a module. The platform-specific prefix and suffix are added to the filename, if needed, and the result is added to the directory, using the correct separator character. The directory should specify the directory where the module can be found. It can be NULL or an empty string to indicate that the module is in a standard platform-specific directory, though this is not recommended since the wrong module may be found. For example, calling g_module_build_path() on a Linux system with a directory of /lib and a module_name of "mylibrary" will return /lib/libmylibrary.so. On a Windows system, using \Windows as the directory it will return \Windows\mylibrary.dll.
error string error(): Gets a string describing the last module error.
open Module open(string fileName, GModuleFlags flags): Opens a module. If the module has already been opened, its reference count is incremented. First of all g_module_open() tries to open file_name as a module. If that fails and file_name has the ".la"-suffix (and is a libtool archive) it tries to open the corresponding module. If that fails and it doesn't have the proper module suffix for the platform (G_MODULE_SUFFIX), this suffix will be appended and the corresponding module will be opended. If that fails and file_name doesn't have the ".la"-suffix, this suffix is appended and g_module_open() tries to open the corresponding module. If eventually that fails as well, NULL is returned.
supported int supported(): Checks if modules are supported on the current platform.

Variables

gModule GModule* gModule;: the main Gtk struct