diff options
Diffstat (limited to 'gir/GModule-2.0.gir')
| -rw-r--r-- | gir/GModule-2.0.gir | 276 |
1 files changed, 276 insertions, 0 deletions
diff --git a/gir/GModule-2.0.gir b/gir/GModule-2.0.gir new file mode 100644 index 00000000..56e8bdb3 --- /dev/null +++ b/gir/GModule-2.0.gir @@ -0,0 +1,276 @@ +<?xml version="1.0"?> +<!-- This file was automatically generated from C sources - DO NOT EDIT! +To affect the contents of this file, edit the original C definitions, +and/or use gtk-doc annotations. --> +<repository version="1.2" + xmlns="http://www.gtk.org/introspection/core/1.0" + xmlns:c="http://www.gtk.org/introspection/c/1.0" + xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + <include name="GLib" version="2.0"/> + <package name="gmodule-2.0"/> + <c:include name="gmodule.h"/> + <namespace name="GModule" + version="2.0" + shared-library="libgmodule-2.0.so.0" + c:identifier-prefixes="G" + c:symbol-prefixes="g"> + <record name="Module" c:type="GModule" disguised="1"> + <doc xml:space="preserve">The #GModule struct is an opaque data structure to represent a +[dynamically-loaded module][glib-Dynamic-Loading-of-Modules]. +It should only be accessed via the following functions.</doc> + <method name="close" c:identifier="g_module_close"> + <doc xml:space="preserve">Closes a module.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE on success</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="module" transfer-ownership="none"> + <doc xml:space="preserve">a #GModule to close</doc> + <type name="Module" c:type="GModule*"/> + </instance-parameter> + </parameters> + </method> + <method name="make_resident" c:identifier="g_module_make_resident"> + <doc xml:space="preserve">Ensures that a module will never be unloaded. +Any future g_module_close() calls on the module will be ignored.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="module" transfer-ownership="none"> + <doc xml:space="preserve">a #GModule to make permanently resident</doc> + <type name="Module" c:type="GModule*"/> + </instance-parameter> + </parameters> + </method> + <method name="name" c:identifier="g_module_name"> + <doc xml:space="preserve">Returns the filename that the module was opened with. + +If @module refers to the application itself, "main" is returned.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">the filename of the module</doc> + <type name="utf8" c:type="const gchar*"/> + </return-value> + <parameters> + <instance-parameter name="module" transfer-ownership="none"> + <doc xml:space="preserve">a #GModule</doc> + <type name="Module" c:type="GModule*"/> + </instance-parameter> + </parameters> + </method> + <method name="symbol" c:identifier="g_module_symbol"> + <doc xml:space="preserve">Gets a symbol pointer from a module, such as one exported +by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE on success</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="module" transfer-ownership="none"> + <doc xml:space="preserve">a #GModule</doc> + <type name="Module" c:type="GModule*"/> + </instance-parameter> + <parameter name="symbol_name" transfer-ownership="none"> + <doc xml:space="preserve">the name of the symbol to find</doc> + <type name="utf8" c:type="const gchar*"/> + </parameter> + <parameter name="symbol" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve">returns the pointer to the symbol value</doc> + <type name="gpointer" c:type="gpointer*"/> + </parameter> + </parameters> + </method> + <function name="build_path" c:identifier="g_module_build_path"> + <doc xml:space="preserve">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`.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">the complete path of the module, including the standard library + prefix and suffix. This should be freed when no longer needed</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <parameter name="directory" + transfer-ownership="none" + nullable="1" + allow-none="1"> + <doc xml:space="preserve">the directory where the module is. This can be + %NULL or the empty string to indicate that the standard platform-specific + directories will be used, though that is not recommended</doc> + <type name="utf8" c:type="const gchar*"/> + </parameter> + <parameter name="module_name" transfer-ownership="none"> + <doc xml:space="preserve">the name of the module</doc> + <type name="utf8" c:type="const gchar*"/> + </parameter> + </parameters> + </function> + <function name="error" c:identifier="g_module_error"> + <doc xml:space="preserve">Gets a string describing the last module error.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">a string describing the last module error</doc> + <type name="utf8" c:type="const gchar*"/> + </return-value> + </function> + <function name="open" c:identifier="g_module_open" introspectable="0"> + <doc xml:space="preserve">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.</doc> + <return-value> + <doc xml:space="preserve">a #GModule on success, or %NULL on failure</doc> + <type name="Module" c:type="GModule*"/> + </return-value> + <parameters> + <parameter name="file_name" + transfer-ownership="none" + nullable="1" + allow-none="1"> + <doc xml:space="preserve">the name of the file containing the module, or %NULL + to obtain a #GModule representing the main program itself</doc> + <type name="utf8" c:type="const gchar*"/> + </parameter> + <parameter name="flags" transfer-ownership="none"> + <doc xml:space="preserve">the flags used for opening the module. This can be the + logical OR of any of the #GModuleFlags</doc> + <type name="ModuleFlags" c:type="GModuleFlags"/> + </parameter> + </parameters> + </function> + <function name="supported" c:identifier="g_module_supported"> + <doc xml:space="preserve">Checks if modules are supported on the current platform.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if modules are supported</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + </function> + </record> + <callback name="ModuleCheckInit" c:type="GModuleCheckInit"> + <doc xml:space="preserve">Specifies the type of the module initialization function. +If a module contains a function named g_module_check_init() it is called +automatically when the module is loaded. It is passed the #GModule structure +and should return %NULL on success or a string describing the initialization +error.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%NULL on success, or a string describing the initialization error</doc> + <type name="utf8" c:type="const gchar*"/> + </return-value> + <parameters> + <parameter name="module" transfer-ownership="none"> + <doc xml:space="preserve">the #GModule corresponding to the module which has just been loaded</doc> + <type name="Module" c:type="GModule*"/> + </parameter> + </parameters> + </callback> + <bitfield name="ModuleFlags" c:type="GModuleFlags"> + <doc xml:space="preserve">Flags passed to g_module_open(). +Note that these flags are not supported on all platforms.</doc> + <member name="lazy" value="1" c:identifier="G_MODULE_BIND_LAZY"> + <doc xml:space="preserve">specifies that symbols are only resolved when + needed. The default action is to bind all symbols when the module + is loaded.</doc> + </member> + <member name="local" value="2" c:identifier="G_MODULE_BIND_LOCAL"> + <doc xml:space="preserve">specifies that symbols in the module should + not be added to the global name space. The default action on most + platforms is to place symbols in the module in the global name space, + which may cause conflicts with existing symbols.</doc> + </member> + <member name="mask" value="3" c:identifier="G_MODULE_BIND_MASK"> + <doc xml:space="preserve">mask for all flags.</doc> + </member> + </bitfield> + <callback name="ModuleUnload" c:type="GModuleUnload"> + <doc xml:space="preserve">Specifies the type of the module function called when it is unloaded. +If a module contains a function named g_module_unload() it is called +automatically when the module is unloaded. +It is passed the #GModule structure.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <parameter name="module" transfer-ownership="none"> + <doc xml:space="preserve">the #GModule about to be unloaded</doc> + <type name="Module" c:type="GModule*"/> + </parameter> + </parameters> + </callback> + <function name="module_build_path" + c:identifier="g_module_build_path" + moved-to="Module.build_path"> + <doc xml:space="preserve">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`.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">the complete path of the module, including the standard library + prefix and suffix. This should be freed when no longer needed</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <parameter name="directory" + transfer-ownership="none" + nullable="1" + allow-none="1"> + <doc xml:space="preserve">the directory where the module is. This can be + %NULL or the empty string to indicate that the standard platform-specific + directories will be used, though that is not recommended</doc> + <type name="utf8" c:type="const gchar*"/> + </parameter> + <parameter name="module_name" transfer-ownership="none"> + <doc xml:space="preserve">the name of the module</doc> + <type name="utf8" c:type="const gchar*"/> + </parameter> + </parameters> + </function> + <function name="module_error" + c:identifier="g_module_error" + moved-to="Module.error"> + <doc xml:space="preserve">Gets a string describing the last module error.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">a string describing the last module error</doc> + <type name="utf8" c:type="const gchar*"/> + </return-value> + </function> + <function name="module_supported" + c:identifier="g_module_supported" + moved-to="Module.supported"> + <doc xml:space="preserve">Checks if modules are supported on the current platform.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if modules are supported</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + </function> + </namespace> +</repository> |