gmodule.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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.1 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, see <http://www.gnu.org/licenses/>.
  16. */
  17. /*
  18. * Modified by the GLib Team and others 1997-2000. See the AUTHORS
  19. * file for a list of people on the GLib Team. See the ChangeLog
  20. * files for a list of changes. These files are distributed with
  21. * GLib at ftp://ftp.gtk.org/pub/gtk/.
  22. */
  23. #ifndef __GMODULE_H__
  24. #define __GMODULE_H__
  25. #include <glib.h>
  26. G_BEGIN_DECLS
  27. /* exporting and importing functions, this is special cased
  28. * to feature Windows dll stubs.
  29. */
  30. #define G_MODULE_IMPORT extern
  31. #ifdef G_PLATFORM_WIN32
  32. # define G_MODULE_EXPORT __declspec(dllexport)
  33. #elif __GNUC__ >= 4
  34. # define G_MODULE_EXPORT __attribute__((visibility("default")))
  35. #else /* !G_PLATFORM_WIN32 && __GNUC__ < 4 */
  36. # define G_MODULE_EXPORT
  37. #endif /* !G_PLATFORM_WIN32 */
  38. /**
  39. * GModuleFlags:
  40. * @G_MODULE_BIND_LAZY: specifies that symbols are only resolved when
  41. * needed. The default action is to bind all symbols when the module
  42. * is loaded.
  43. * @G_MODULE_BIND_LOCAL: specifies that symbols in the module should
  44. * not be added to the global name space. The default action on most
  45. * platforms is to place symbols in the module in the global name space,
  46. * which may cause conflicts with existing symbols.
  47. * @G_MODULE_BIND_MASK: mask for all flags.
  48. *
  49. * Flags passed to g_module_open().
  50. * Note that these flags are not supported on all platforms.
  51. */
  52. typedef enum
  53. {
  54. G_MODULE_BIND_LAZY = 1 << 0,
  55. G_MODULE_BIND_LOCAL = 1 << 1,
  56. G_MODULE_BIND_MASK = 0x03
  57. } GModuleFlags;
  58. typedef struct _GModule GModule;
  59. typedef const gchar* (*GModuleCheckInit) (GModule *module);
  60. typedef void (*GModuleUnload) (GModule *module);
  61. /* return TRUE if dynamic module loading is supported */
  62. GLIB_AVAILABLE_IN_ALL
  63. gboolean g_module_supported (void) G_GNUC_CONST;
  64. /* open a module 'file_name' and return handle, which is NULL on error */
  65. GLIB_AVAILABLE_IN_ALL
  66. GModule* g_module_open (const gchar *file_name,
  67. GModuleFlags flags);
  68. /* close a previously opened module, returns TRUE on success */
  69. GLIB_AVAILABLE_IN_ALL
  70. gboolean g_module_close (GModule *module);
  71. /* make a module resident so g_module_close on it will be ignored */
  72. GLIB_AVAILABLE_IN_ALL
  73. void g_module_make_resident (GModule *module);
  74. /* query the last module error as a string */
  75. GLIB_AVAILABLE_IN_ALL
  76. const gchar * g_module_error (void);
  77. /* retrieve a symbol pointer from 'module', returns TRUE on success */
  78. GLIB_AVAILABLE_IN_ALL
  79. gboolean g_module_symbol (GModule *module,
  80. const gchar *symbol_name,
  81. gpointer *symbol);
  82. /* retrieve the file name from an existing module */
  83. GLIB_AVAILABLE_IN_ALL
  84. const 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 according to
  92. * the operating system's conventions (for instance lib*.so or *.dll).
  93. *
  94. * No checks are made that the file exists, or is of correct type.
  95. */
  96. GLIB_AVAILABLE_IN_ALL
  97. gchar* g_module_build_path (const gchar *directory,
  98. const gchar *module_name);
  99. G_END_DECLS
  100. #endif /* __GMODULE_H__ */