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