mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer-rs.git
synced 2024-11-26 19:41:09 +00:00
b273c4e8bf
Rerunning it on existing files doesn't perform all whitespace cleanup when nodes are not modified.
325 lines
16 KiB
XML
325 lines
16 KiB
XML
<?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 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" version="1.2">
|
|
<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" nullable="1">
|
|
<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 opened. 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>
|
|
<docsection name="modules">
|
|
<doc xml:space="preserve">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 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().
|
|
|
|
Example: Calling a function defined in a GModule
|
|
|[<!-- language="C" -->
|
|
// the function signature for 'say_hello'
|
|
typedef void (* SayHelloFunc) (const char *message);
|
|
|
|
gboolean
|
|
just_say_hello (const char *filename, GError **error)
|
|
{
|
|
SayHelloFunc say_hello;
|
|
GModule *module;
|
|
|
|
module = g_module_open (filename, G_MODULE_BIND_LAZY);
|
|
if (!module)
|
|
{
|
|
g_set_error (error, FOO_ERROR, FOO_ERROR_BLAH,
|
|
"%s", g_module_error ());
|
|
return FALSE;
|
|
}
|
|
|
|
if (!g_module_symbol (module, "say_hello", (gpointer *)&say_hello))
|
|
{
|
|
g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
|
|
"%s: %s", filename, g_module_error ());
|
|
if (!g_module_close (module))
|
|
g_warning ("%s: %s", filename, g_module_error ());
|
|
return FALSE;
|
|
}
|
|
|
|
if (say_hello == NULL)
|
|
{
|
|
g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
|
|
"symbol say_hello is NULL");
|
|
if (!g_module_close (module))
|
|
g_warning ("%s: %s", filename, g_module_error ());
|
|
return FALSE;
|
|
}
|
|
|
|
// call our function in the module
|
|
say_hello ("Hello world!");
|
|
|
|
if (!g_module_close (module))
|
|
g_warning ("%s: %s", filename, g_module_error ());
|
|
return TRUE;
|
|
}
|
|
]|</doc>
|
|
</docsection>
|
|
</namespace>
|
|
</repository>
|