1 /* GMODULE - GLIB wrapper code for dynamic module loading 2 * Copyright (C) 1998 Tim Janik 3 * 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. 8 * 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. 13 * 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. 18 */ 19 20 /* 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/. 25 */ 26 27 #ifndef __GMODULE_H__ 28 #define __GMODULE_H__ 29 30 #include <glib.h> 31 32 G_BEGIN_DECLS 33 34 /* exporting and importing functions, this is special cased 35 * to feature Windows dll stubs. 36 */ 37 #define G_MODULE_IMPORT extern 38 #ifdef G_PLATFORM_WIN32 39 # define G_MODULE_EXPORT __declspec(dllexport) 40 #else /* !G_PLATFORM_WIN32 */ 41 # define G_MODULE_EXPORT 42 #endif /* !G_PLATFORM_WIN32 */ 43 44 typedef enum 45 { 46 G_MODULE_BIND_LAZY = 1 << 0, 47 G_MODULE_BIND_LOCAL = 1 << 1, 48 G_MODULE_BIND_MASK = 0x03 49 } GModuleFlags; 50 51 typedef struct _GModule GModule; 52 typedef const gchar* (*GModuleCheckInit) (GModule *module); 53 typedef void (*GModuleUnload) (GModule *module); 54 55 #ifdef G_OS_WIN32 56 #define g_module_open g_module_open_utf8 57 #define g_module_name g_module_name_utf8 58 #endif 59 60 /* return TRUE if dynamic module loading is supported */ 61 gboolean g_module_supported (void) G_GNUC_CONST; 62 63 /* open a module `file_name' and return handle, which is NULL on error */ 64 GModule* g_module_open (const gchar *file_name, 65 GModuleFlags flags); 66 67 /* close a previously opened module, returns TRUE on success */ 68 gboolean g_module_close (GModule *module); 69 70 /* make a module resident so g_module_close on it will be ignored */ 71 void g_module_make_resident (GModule *module); 72 73 /* query the last module error as a string */ 74 G_CONST_RETURN gchar* g_module_error (void); 75 76 /* retrieve a symbol pointer from `module', returns TRUE on success */ 77 gboolean g_module_symbol (GModule *module, 78 const gchar *symbol_name, 79 gpointer *symbol); 80 81 /* retrieve the file name from an existing module */ 82 G_CONST_RETURN gchar* g_module_name (GModule *module); 83 84 /* Build the actual file name containing a module. `directory' is the 85 * directory where the module file is supposed to be, or NULL or empty 86 * in which case it should either be in the current directory or, on 87 * some operating systems, in some standard place, for instance on the 88 * PATH. Hence, to be absoultely sure to get the correct module, 89 * always pass in a directory. The file name consists of the directory, 90 * if supplied, and `module_name' suitably decorated accoring to 91 * the operating system's conventions (for instance lib*.so or *.dll). 92 * 93 * No checks are made that the file exists, or is of correct type. 94 */ 95 gchar* g_module_build_path (const gchar *directory, 96 const gchar *module_name); 97 98 99 G_END_DECLS 100 101 #endif /* __GMODULE_H__ */ 102