1 /* GMODULE - GLIB wrapper code for dynamic module loading
2 * Copyright (C) 1998 Tim Janik
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
30 extern const char *g_log_domain_gmodule;
35 #endif /* __cplusplus */
37 /* exporting and importing functions, this is special cased
38 * to feature Windows dll stubs.
40 #define G_MODULE_IMPORT extern
41 #if defined (G_OS_WIN32)
42 # define G_MODULE_EXPORT __declspec(dllexport)
43 #else /* !G_OS_WIN32 */
44 # define G_MODULE_EXPORT
45 #endif /* !G_OS_WIN32 */
49 G_MODULE_BIND_LAZY = 1 << 0,
50 G_MODULE_BIND_MASK = 0x01
53 typedef struct _GModule GModule;
54 typedef const gchar* (*GModuleCheckInit) (GModule *module);
55 typedef void (*GModuleUnload) (GModule *module);
57 /* return TRUE if dynamic module loading is supported */
58 gboolean g_module_supported (void) G_GNUC_CONST;
60 /* open a module `file_name' and return handle, which is NULL on error */
61 GModule* g_module_open (const gchar *file_name,
64 /* close a previously opened module, returns TRUE on success */
65 gboolean g_module_close (GModule *module);
67 /* make a module resident so g_module_close on it will be ignored */
68 void g_module_make_resident (GModule *module);
70 /* query the last module error as a string */
71 gchar* g_module_error (void);
73 /* retrive a symbol pointer from `module', returns TRUE on success */
74 gboolean g_module_symbol (GModule *module,
75 const gchar *symbol_name,
78 /* retrive the file name from an existing module */
79 gchar* g_module_name (GModule *module);
82 /* Build the actual file name containing a module. `directory' is the
83 * directory where the module file is supposed to be, or NULL or empty
84 * in which case it should either be in the current directory or, on
85 * some operating systems, in some standard place, for instance on the
86 * PATH. Hence, to be absoultely sure to get the correct module,
87 * always pass in a directory. The file name consists of the directory,
88 * if supplied, and `module_name' suitably decorated accoring to
89 * the operating system's conventions (for instance lib*.so or *.dll).
91 * No checks are made that the file exists, or is of correct type.
93 gchar* g_module_build_path (const gchar *directory,
94 const gchar *module_name);
98 #endif /* __cplusplus */
101 #endif /* __GMODULE_H__ */