gmodule/gmodule.h

   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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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-1999.  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
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35 extern const char      *g_log_domain_gmodule;
  36 #include <glib.h>
  37
  38
  39 /* exporting and importing functions, this is special cased
  40  * to feature Windows dll stubs.
  41  */
  42 #define G_MODULE_IMPORT         extern
  43 #if defined (G_OS_WIN32) && defined (__GNUC__)
  44 #  define       G_MODULE_EXPORT         __declspec(dllexport)
  45 #else /* !G_OS_WIN32 */
  46 #  define       G_MODULE_EXPORT
  47 #endif /* !G_OS_WIN32 */
  48
  49 typedef enum
  50 {
  51   G_MODULE_BIND_LAZY    = 1 << 0,
  52   G_MODULE_BIND_MASK    = 0x01
  53 } GModuleFlags;
  54
  55 typedef struct _GModule                  GModule;
  56 typedef const gchar* (*GModuleCheckInit) (GModule       *module);
  57 typedef void         (*GModuleUnload)    (GModule       *module);
  58
  59 /* return TRUE if dynamic module loading is supported */
  60 gboolean        g_module_supported         (void);
  61
  62 /* open a module `file_name' and return handle, which is NULL on error */
  63 GModule*        g_module_open              (const gchar         *file_name,
  64                                             GModuleFlags         flags);
  65
  66 /* close a previously opened module, returns TRUE on success */
  67 gboolean        g_module_close             (GModule             *module);
  68
  69 /* make a module resident so g_module_close on it will be ignored */
  70 void            g_module_make_resident     (GModule             *module);
  71
  72 /* query the last module error as a string */
  73 gchar*          g_module_error             (void);
  74
  75 /* retrive a symbol pointer from `module', returns TRUE on success */
  76 gboolean        g_module_symbol            (GModule             *module,
  77                                             const gchar         *symbol_name,
  78                                             gpointer            *symbol);
  79
  80 /* retrive the file name from an existing module */
  81 gchar*          g_module_name              (GModule             *module);
  82
  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 #ifdef __cplusplus
  99 }
 100 #endif /* __cplusplus */
 101
 102
 103 #endif /* __GMODULE_H__ */