glib2.0_2.20.1
[mer:glib2_0.git] / docs / reference / glib / xml / modules.xml
1 <refentry id="glib-Dynamic-Loading-of-Modules">
2 <refmeta>
3 <refentrytitle role="top_of_page" id="glib-Dynamic-Loading-of-Modules.top_of_page">Dynamic Loading of Modules</refentrytitle>
4 <manvolnum>3</manvolnum>
5 <refmiscinfo>GLIB Library</refmiscinfo>
6 </refmeta>
7
8 <refnamediv>
9 <refname>Dynamic Loading of Modules</refname>
10 <refpurpose>portable method for dynamically loading 'plug-ins'</refpurpose>
11 </refnamediv>
12
13 <refsynopsisdiv id="glib-Dynamic-Loading-of-Modules.synopsis" role="synopsis">
14 <title role="synopsis.title">Synopsis</title>
15
16 <synopsis>
17
18 #include &lt;gmodule.h&gt;
19
20                     <link linkend="GModule">GModule</link>;
21 <link linkend="gboolean">gboolean</link>            <link linkend="g-module-supported">g_module_supported</link>                  (void);
22 <link linkend="gchar">gchar</link>*              <link linkend="g-module-build-path">g_module_build_path</link>                 (const <link linkend="gchar">gchar</link> *directory,
23                                                          const <link linkend="gchar">gchar</link> *module_name);
24 <link linkend="GModule">GModule</link>*            <link linkend="g-module-open">g_module_open</link>                       (const <link linkend="gchar">gchar</link> *file_name,
25                                                          <link linkend="GModuleFlags">GModuleFlags</link> flags);
26 enum                <link linkend="GModuleFlags">GModuleFlags</link>;
27 <link linkend="gboolean">gboolean</link>            <link linkend="g-module-symbol">g_module_symbol</link>                     (<link linkend="GModule">GModule</link> *module,
28                                                          const <link linkend="gchar">gchar</link> *symbol_name,
29                                                          <link linkend="gpointer">gpointer</link> *symbol);
30 const <link linkend="gchar">gchar</link>*        <link linkend="g-module-name">g_module_name</link>                       (<link linkend="GModule">GModule</link> *module);
31 <link linkend="void">void</link>                <link linkend="g-module-make-resident">g_module_make_resident</link>              (<link linkend="GModule">GModule</link> *module);
32 <link linkend="gboolean">gboolean</link>            <link linkend="g-module-close">g_module_close</link>                      (<link linkend="GModule">GModule</link> *module);
33 const <link linkend="gchar">gchar</link>*        <link linkend="g-module-error">g_module_error</link>                      (void);
34
35 const <link linkend="gchar">gchar</link> *       (<link linkend="GModuleCheckInit">*GModuleCheckInit</link>)                 (<link linkend="GModule">GModule</link> *module);
36 <link linkend="void">void</link>                (<link linkend="GModuleUnload">*GModuleUnload</link>)                    (<link linkend="GModule">GModule</link> *module);
37 #define             <link linkend="G-MODULE-SUFFIX--CAPS">G_MODULE_SUFFIX</link>
38 #define             <link linkend="G-MODULE-EXPORT--CAPS">G_MODULE_EXPORT</link>
39 #define             <link linkend="G-MODULE-IMPORT--CAPS">G_MODULE_IMPORT</link>
40 </synopsis>
41 </refsynopsisdiv>
42
43
44
45
46
47
48
49
50
51 <refsect1 id="glib-Dynamic-Loading-of-Modules.description" role="desc">
52 <title role="desc.title">Description</title>
53 <para>
54 These functions provide a portable way to dynamically load object files
55 (commonly known as 'plug-ins').
56 The current implementation supports all systems that provide
57 an implementation of <link linkend="dlopen"><function>dlopen()</function></link> (e.g. Linux/Sun), as well as HP-UX via its
58 <link linkend="shl-load"><function>shl_load()</function></link> mechanism, and Windows platforms via DLLs.
59 </para>
60 <para>
61 A program which wants to use these functions must be linked to the
62 libraries output by the command <command>pkg-config --libs gmodule-2.0</command>.
63 </para>
64 <para>
65 To use them you must first determine whether dynamic loading
66 is supported on the platform by calling <link linkend="g-module-supported"><function>g_module_supported()</function></link>.
67 If it is, you can open a module with <link linkend="g-module-open"><function>g_module_open()</function></link>,
68 find the module's symbols (e.g. function names) with <link linkend="g-module-symbol"><function>g_module_symbol()</function></link>,
69 and later close the module with <link linkend="g-module-close"><function>g_module_close()</function></link>.
70 <link linkend="g-module-name"><function>g_module_name()</function></link> will return the file name of a currently opened module.
71 </para>
72 <para>
73 If any of the above functions fail, the error status can be found with
74 <link linkend="g-module-error"><function>g_module_error()</function></link>.
75 </para>
76 <para>
77 The <link linkend="GModule"><type>GModule</type></link> implementation features reference counting for opened modules,
78 and supports hook functions within a module which are called when the
79 module is loaded and unloaded (see <link linkend="GModuleCheckInit"><type>GModuleCheckInit</type></link> and <link linkend="GModuleUnload"><type>GModuleUnload</type></link>).
80 </para>
81 <para>
82 If your module introduces static data to common subsystems in the running
83 program, e.g. through calling <literal>g_quark_from_static_string ("my-module-stuff")</literal>,
84 it must ensure that it is never unloaded, by calling <link linkend="g-module-make-resident"><function>g_module_make_resident()</function></link>.
85 </para>
86 <para>
87 <example>
88 <title>Calling a function defined in a <structname>GModule</structname></title>
89 <programlisting>
90 /* the function signature for 'say_hello' */
91 typedef void (* SayHelloFunc) (const char *message);
92 gboolean
93 just_say_hello (const char *filename, GError **error)
94 {
95   SayHelloFunc  say_hello;
96   GModule      *module;
97   module = g_module_open (filename, G_MODULE_BIND_LAZY);
98   if (!module)
99     {
100       g_set_error (error, FOO_ERROR, FOO_ERROR_BLAH,
101                    "&percnt;s", g_module_error (<!-- -->));
102       return FALSE;
103     }
104   if (!g_module_symbol (module, "say_hello", (gpointer *)&amp;say_hello))
105     {
106       g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
107                    "&percnt;s: &percnt;s", filename, g_module_error (<!-- -->));
108       if (!g_module_close (module))
109         g_warning ("&percnt;s: &percnt;s", filename, g_module_error (<!-- -->));
110       return FALSE;
111     }
112   if (say_hello == NULL)
113     {
114       g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN, "symbol say_hello is NULL");
115       if (!g_module_close (module))
116         g_warning ("&percnt;s: &percnt;s", filename, g_module_error (<!-- -->));
117       return FALSE;
118     }
119   /* call our function in the module */
120   say_hello ("Hello world!");
121   if (!g_module_close (module))
122     g_warning ("&percnt;s: &percnt;s", filename, g_module_error (<!-- -->));
123   return TRUE;
124 }
125 </programlisting>
126 </example>
127 </para>
128 </refsect1>
129
130 <refsect1 id="glib-Dynamic-Loading-of-Modules.details" role="details">
131 <title role="details.title">Details</title>
132 <refsect2 id="GModule" role="struct">
133 <title>GModule</title>
134 <indexterm zone="GModule"><primary sortas="Module">GModule</primary></indexterm><programlisting>typedef struct _GModule GModule;</programlisting>
135 <para>
136 The <link linkend="GModule"><type>GModule</type></link> struct is an opaque data structure to represent a
137 <link linkend="glib-Dynamic-Loading-of-Modules">Dynamically-Loaded Module</link>.
138 It should only be accessed via the following functions.
139 </para></refsect2>
140 <refsect2 id="g-module-supported" role="function">
141 <title>g_module_supported ()</title>
142 <indexterm zone="g-module-supported"><primary sortas="module_supported">g_module_supported</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_module_supported                  (void);</programlisting>
143 <para>
144 Checks if modules are supported on the current platform.
145 </para><variablelist role="params">
146 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>%TRUE if modules are supported.
147 </simpara></listitem></varlistentry>
148 </variablelist></refsect2>
149 <refsect2 id="g-module-build-path" role="function">
150 <title>g_module_build_path ()</title>
151 <indexterm zone="g-module-build-path"><primary sortas="module_build_path">g_module_build_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              g_module_build_path                 (const <link linkend="gchar">gchar</link> *directory,
152                                                          const <link linkend="gchar">gchar</link> *module_name);</programlisting>
153 <para>
154 A portable way to build the filename of a module. The platform-specific
155 prefix and suffix are added to the filename, if needed, and the result is
156 added to the directory, using the correct separator character.
157 </para>
158 <para>
159 The directory should specify the directory where the module can be found.
160 It can be <link linkend="NULL--CAPS"><literal>NULL</literal></link> or an empty string to indicate that the module is in a standard
161 platform-specific directory, though this is not recommended since the
162 wrong module may be found.
163 </para>
164 <para>
165 For example, calling <link linkend="g-module-build-path"><function>g_module_build_path()</function></link> on a Linux system with a <parameter>directory</parameter>
166 of <filename>/lib</filename> and a <parameter>module_name</parameter> of "mylibrary" will return
167 <filename>/lib/libmylibrary.so</filename>. On a Windows system, using
168 <filename>\Windows</filename> as the directory it will return
169 <filename>\Windows\mylibrary.dll</filename>.
170 </para><variablelist role="params">
171 <varlistentry><term><parameter>directory</parameter>&#160;:</term>
172 <listitem><simpara>the directory where the module is. This can be <link linkend="NULL--CAPS"><literal>NULL</literal></link> or the empty
173 string to indicate that the standard platform-specific directories will be
174 used, though that is not recommended.
175 </simpara></listitem></varlistentry>
176 <varlistentry><term><parameter>module_name</parameter>&#160;:</term>
177 <listitem><simpara>the name of the module.
178 </simpara></listitem></varlistentry>
179 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the complete path of the module, including the standard library
180 prefix and suffix. This should be freed when no longer needed.
181 </simpara></listitem></varlistentry>
182 </variablelist></refsect2>
183 <refsect2 id="g-module-open" role="function">
184 <title>g_module_open ()</title>
185 <indexterm zone="g-module-open"><primary sortas="module_open">g_module_open</primary></indexterm><programlisting><link linkend="GModule">GModule</link>*            g_module_open                       (const <link linkend="gchar">gchar</link> *file_name,
186                                                          <link linkend="GModuleFlags">GModuleFlags</link> flags);</programlisting>
187 <para>
188 Opens a module. If the module has already been opened, its reference
189 count is incremented.
190 </para>
191 <para>
192 First of all <link linkend="g-module-open"><function>g_module_open()</function></link> tries to open <parameter>file_name</parameter> as a module. If
193 that fails and <parameter>file_name</parameter> has the ".la"-suffix (and is a libtool archive)
194 it tries to open the corresponding module. If that fails and it doesn't
195 have the proper module suffix for the platform (<link linkend="G-MODULE-SUFFIX--CAPS"><type>G_MODULE_SUFFIX</type></link>), this
196 suffix will be appended and the corresponding module will be opended. If
197 that fails and <parameter>file_name</parameter> doesn't have the ".la"-suffix, this suffix is
198 appended and <link linkend="g-module-open"><function>g_module_open()</function></link> tries to open the corresponding module. If
199 eventually that fails as well, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned.
200 </para><variablelist role="params">
201 <varlistentry><term><parameter>file_name</parameter>&#160;:</term>
202 <listitem><simpara>the name of the file containing the module, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to obtain
203   a <link linkend="GModule"><type>GModule</type></link> representing the main program itself.
204 </simpara></listitem></varlistentry>
205 <varlistentry><term><parameter>flags</parameter>&#160;:</term>
206 <listitem><simpara>the flags used for opening the module. This can be the logical
207 OR of any of the <link linkend="GModuleFlags"><type>GModuleFlags</type></link>.
208 </simpara></listitem></varlistentry>
209 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a <link linkend="GModule"><type>GModule</type></link> on success, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on failure.
210 </simpara></listitem></varlistentry>
211 </variablelist></refsect2>
212 <refsect2 id="GModuleFlags" role="enum">
213 <title>enum GModuleFlags</title>
214 <indexterm zone="GModuleFlags"><primary sortas="ModuleFlags">GModuleFlags</primary></indexterm><programlisting>typedef enum
215 {
216   G_MODULE_BIND_LAZY    = 1 &lt;&lt; 0,
217   G_MODULE_BIND_LOCAL   = 1 &lt;&lt; 1,
218   G_MODULE_BIND_MASK    = 0x03
219 } GModuleFlags;
220 </programlisting>
221 <para>
222 Flags passed to <link linkend="g-module-open"><function>g_module_open()</function></link>. Note that these flags are
223 not supported on all platforms.
224 </para><variablelist role="enum">
225 <varlistentry id="G-MODULE-BIND-LAZY--CAPS" role="constant">
226 <term><literal>G_MODULE_BIND_LAZY</literal></term>
227 <listitem><simpara>specifies that symbols are only resolved when needed.
228   The default action is to bind all symbols when the module is loaded.
229 </simpara></listitem>
230 </varlistentry>
231 <varlistentry id="G-MODULE-BIND-LOCAL--CAPS" role="constant">
232 <term><literal>G_MODULE_BIND_LOCAL</literal></term>
233 <listitem><simpara>specifies that symbols in the module should
234   not be added to the global name space.  The default action on most
235   platforms is to place symbols in the module in the global name space,
236   which may cause conflicts with existing symbols.
237 </simpara></listitem>
238 </varlistentry>
239 <varlistentry id="G-MODULE-BIND-MASK--CAPS" role="constant">
240 <term><literal>G_MODULE_BIND_MASK</literal></term>
241 <listitem><simpara>mask for all flags.
242 </simpara></listitem>
243 </varlistentry>
244 </variablelist></refsect2>
245 <refsect2 id="g-module-symbol" role="function">
246 <title>g_module_symbol ()</title>
247 <indexterm zone="g-module-symbol"><primary sortas="module_symbol">g_module_symbol</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_module_symbol                     (<link linkend="GModule">GModule</link> *module,
248                                                          const <link linkend="gchar">gchar</link> *symbol_name,
249                                                          <link linkend="gpointer">gpointer</link> *symbol);</programlisting>
250 <para>
251 Gets a symbol pointer from a module, such as one exported by <link linkend="G-MODULE-EXPORT--CAPS"><type>G_MODULE_EXPORT</type></link>.
252 </para>
253 <para>
254 Note that a valid symbol can be <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
255 </para><variablelist role="params">
256 <varlistentry><term><parameter>module</parameter>&#160;:</term>
257 <listitem><simpara>a <link linkend="GModule"><type>GModule</type></link>.
258 </simpara></listitem></varlistentry>
259 <varlistentry><term><parameter>symbol_name</parameter>&#160;:</term>
260 <listitem><simpara>the name of the symbol to find.
261 </simpara></listitem></varlistentry>
262 <varlistentry><term><parameter>symbol</parameter>&#160;:</term>
263 <listitem><simpara>returns the pointer to the symbol value.
264 </simpara></listitem></varlistentry>
265 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>%TRUE on success.
266 </simpara></listitem></varlistentry>
267 </variablelist></refsect2>
268 <refsect2 id="g-module-name" role="function">
269 <title>g_module_name ()</title>
270 <indexterm zone="g-module-name"><primary sortas="module_name">g_module_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        g_module_name                       (<link linkend="GModule">GModule</link> *module);</programlisting>
271 <para>
272 Gets the filename from a <link linkend="GModule"><type>GModule</type></link>.
273 </para><variablelist role="params">
274 <varlistentry><term><parameter>module</parameter>&#160;:</term>
275 <listitem><simpara>a <link linkend="GModule"><type>GModule</type></link>.
276 </simpara></listitem></varlistentry>
277 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the filename of the module, or "main" if the module is the main
278 program itself.
279 </simpara></listitem></varlistentry>
280 </variablelist></refsect2>
281 <refsect2 id="g-module-make-resident" role="function">
282 <title>g_module_make_resident ()</title>
283 <indexterm zone="g-module-make-resident"><primary sortas="module_make_resident">g_module_make_resident</primary></indexterm><programlisting><link linkend="void">void</link>                g_module_make_resident              (<link linkend="GModule">GModule</link> *module);</programlisting>
284 <para>
285 Ensures that a module will never be unloaded.
286 Any future <link linkend="g-module-close"><function>g_module_close()</function></link> calls on the module will be ignored.
287 </para><variablelist role="params">
288 <varlistentry><term><parameter>module</parameter>&#160;:</term>
289 <listitem><simpara>a <link linkend="GModule"><type>GModule</type></link> to make permanently resident.
290 </simpara></listitem></varlistentry>
291 </variablelist></refsect2>
292 <refsect2 id="g-module-close" role="function">
293 <title>g_module_close ()</title>
294 <indexterm zone="g-module-close"><primary sortas="module_close">g_module_close</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_module_close                      (<link linkend="GModule">GModule</link> *module);</programlisting>
295 <para>
296 Closes a module.
297 </para><variablelist role="params">
298 <varlistentry><term><parameter>module</parameter>&#160;:</term>
299 <listitem><simpara>a <link linkend="GModule"><type>GModule</type></link> to close.
300 </simpara></listitem></varlistentry>
301 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>%TRUE on success.
302 </simpara></listitem></varlistentry>
303 </variablelist></refsect2>
304 <refsect2 id="g-module-error" role="function">
305 <title>g_module_error ()</title>
306 <indexterm zone="g-module-error"><primary sortas="module_error">g_module_error</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        g_module_error                      (void);</programlisting>
307 <para>
308 Gets a string describing the last module error.
309 </para><variablelist role="params">
310 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a string describing the last module error.
311 </simpara></listitem></varlistentry>
312 </variablelist></refsect2>
313 <refsect2 id="GModuleCheckInit" role="function">
314 <title>GModuleCheckInit ()</title>
315 <indexterm zone="GModuleCheckInit"><primary sortas="ModuleCheckInit">GModuleCheckInit</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       (*GModuleCheckInit)                 (<link linkend="GModule">GModule</link> *module);</programlisting>
316 <para>
317 Specifies the type of the module initialization function.
318 <indexterm zone="g-module-check-init"><primary>g_module_check_init</primary></indexterm>
319 If a module contains a function named <link linkend="g-module-check-init"><function>g_module_check_init()</function></link> it is called
320 automatically when the module is loaded. It is passed the <link linkend="GModule"><type>GModule</type></link> structure
321 and should return <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success or a string describing the initialization
322 error.
323 </para><variablelist role="params">
324 <varlistentry><term><parameter>module</parameter>&#160;:</term>
325 <listitem><simpara>the <link linkend="GModule"><type>GModule</type></link> corresponding to the module which has just been loaded.
326 </simpara></listitem></varlistentry>
327 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>%NULL on success, or a string describing the initialization error.
328 </simpara></listitem></varlistentry>
329 </variablelist></refsect2>
330 <refsect2 id="GModuleUnload" role="function">
331 <title>GModuleUnload ()</title>
332 <indexterm zone="GModuleUnload"><primary sortas="ModuleUnload">GModuleUnload</primary></indexterm><programlisting><link linkend="void">void</link>                (*GModuleUnload)                    (<link linkend="GModule">GModule</link> *module);</programlisting>
333 <para>
334 <indexterm zone="g-module-unload"><primary>g_module_unload</primary></indexterm>
335 Specifies the type of the module function called when it is unloaded.
336 If a module contains a function named <link linkend="g-module-unload"><function>g_module_unload()</function></link> it is called
337 automatically when the module is unloaded.
338 It is passed the <link linkend="GModule"><type>GModule</type></link> structure.
339 </para><variablelist role="params">
340 <varlistentry><term><parameter>module</parameter>&#160;:</term>
341 <listitem><simpara>the <link linkend="GModule"><type>GModule</type></link> about to be unloaded.
342 </simpara></listitem></varlistentry>
343 </variablelist></refsect2>
344 <refsect2 id="G-MODULE-SUFFIX--CAPS" role="macro">
345 <title>G_MODULE_SUFFIX</title>
346 <indexterm zone="G-MODULE-SUFFIX--CAPS"><primary sortas="MODULE_SUFFIX">G_MODULE_SUFFIX</primary></indexterm><programlisting>#define G_MODULE_SUFFIX "so"
347 </programlisting>
348 <para>
349 Expands to the proper shared library suffix for the current platform
350 without the leading dot. For the most Unices and Linux this is "so",
351 for some HP-UX versions this is "sl" and for Windows this is "dll".
352 </para></refsect2>
353 <refsect2 id="G-MODULE-EXPORT--CAPS" role="macro">
354 <title>G_MODULE_EXPORT</title>
355 <indexterm zone="G-MODULE-EXPORT--CAPS"><primary sortas="MODULE_EXPORT">G_MODULE_EXPORT</primary></indexterm><programlisting>#define             G_MODULE_EXPORT</programlisting>
356 <para>
357 Used to declare functions exported by modules. This is a no-op on Linux and
358 Unices, but when compiling for Windows, it marks a symbol to be exported from
359 the library or executable being built.
360 </para></refsect2>
361 <refsect2 id="G-MODULE-IMPORT--CAPS" role="macro">
362 <title>G_MODULE_IMPORT</title>
363 <indexterm zone="G-MODULE-IMPORT--CAPS"><primary sortas="MODULE_IMPORT">G_MODULE_IMPORT</primary></indexterm><programlisting>#define    G_MODULE_IMPORT         extern
364 </programlisting>
365 <para>
366 Used to declare functions imported from modules.
367 </para></refsect2>
368
369 </refsect1>
370
371
372
373
374 </refentry>