giomodule.h 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2006-2007 Red Hat, Inc.
  4. *
  5. * SPDX-License-Identifier: LGPL-2.1-or-later
  6. *
  7. * This library is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * This library is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General
  18. * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19. *
  20. * Author: Alexander Larsson <alexl@redhat.com>
  21. */
  22. #ifndef __G_IO_MODULE_H__
  23. #define __G_IO_MODULE_H__
  24. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25. #error "Only <gio/gio.h> can be included directly."
  26. #endif
  27. #include <gio/giotypes.h>
  28. #include <gmodule.h>
  29. G_BEGIN_DECLS
  30. typedef struct _GIOModuleScope GIOModuleScope;
  31. GIO_AVAILABLE_IN_2_30
  32. GIOModuleScope * g_io_module_scope_new (GIOModuleScopeFlags flags);
  33. GIO_AVAILABLE_IN_2_30
  34. void g_io_module_scope_free (GIOModuleScope *scope);
  35. GIO_AVAILABLE_IN_2_30
  36. void g_io_module_scope_block (GIOModuleScope *scope,
  37. const gchar *basename);
  38. #define G_IO_TYPE_MODULE (g_io_module_get_type ())
  39. #define G_IO_MODULE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_IO_TYPE_MODULE, GIOModule))
  40. #define G_IO_MODULE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_IO_TYPE_MODULE, GIOModuleClass))
  41. #define G_IO_IS_MODULE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_IO_TYPE_MODULE))
  42. #define G_IO_IS_MODULE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_IO_TYPE_MODULE))
  43. #define G_IO_MODULE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_IO_TYPE_MODULE, GIOModuleClass))
  44. typedef struct _GIOModuleClass GIOModuleClass;
  45. GIO_AVAILABLE_IN_ALL
  46. GType g_io_module_get_type (void) G_GNUC_CONST;
  47. GIO_AVAILABLE_IN_ALL
  48. GIOModule *g_io_module_new (const gchar *filename);
  49. GIO_AVAILABLE_IN_ALL
  50. void g_io_modules_scan_all_in_directory (const char *dirname);
  51. GIO_AVAILABLE_IN_ALL
  52. GList *g_io_modules_load_all_in_directory (const gchar *dirname);
  53. GIO_AVAILABLE_IN_2_30
  54. void g_io_modules_scan_all_in_directory_with_scope (const gchar *dirname,
  55. GIOModuleScope *scope);
  56. GIO_AVAILABLE_IN_2_30
  57. GList *g_io_modules_load_all_in_directory_with_scope (const gchar *dirname,
  58. GIOModuleScope *scope);
  59. GIO_AVAILABLE_IN_ALL
  60. GIOExtensionPoint *g_io_extension_point_register (const char *name);
  61. GIO_AVAILABLE_IN_ALL
  62. GIOExtensionPoint *g_io_extension_point_lookup (const char *name);
  63. GIO_AVAILABLE_IN_ALL
  64. void g_io_extension_point_set_required_type (GIOExtensionPoint *extension_point,
  65. GType type);
  66. GIO_AVAILABLE_IN_ALL
  67. GType g_io_extension_point_get_required_type (GIOExtensionPoint *extension_point);
  68. GIO_AVAILABLE_IN_ALL
  69. GList *g_io_extension_point_get_extensions (GIOExtensionPoint *extension_point);
  70. GIO_AVAILABLE_IN_ALL
  71. GIOExtension * g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
  72. const char *name);
  73. GIO_AVAILABLE_IN_ALL
  74. GIOExtension * g_io_extension_point_implement (const char *extension_point_name,
  75. GType type,
  76. const char *extension_name,
  77. gint priority);
  78. GIO_AVAILABLE_IN_ALL
  79. GType g_io_extension_get_type (GIOExtension *extension);
  80. GIO_AVAILABLE_IN_ALL
  81. const char * g_io_extension_get_name (GIOExtension *extension);
  82. GIO_AVAILABLE_IN_ALL
  83. gint g_io_extension_get_priority (GIOExtension *extension);
  84. GIO_AVAILABLE_IN_ALL
  85. GTypeClass* g_io_extension_ref_class (GIOExtension *extension);
  86. /* API for the modules to implement.
  87. * Note that those functions are not implemented by libgio, they are declared
  88. * here to be implemented in modules, that's why it uses G_MODULE_EXPORT
  89. * instead of GIO_AVAILABLE_IN_ALL.
  90. */
  91. /**
  92. * g_io_module_load: (skip)
  93. * @module: a #GIOModule.
  94. *
  95. * Required API for GIO modules to implement.
  96. *
  97. * This function is run after the module has been loaded into GIO,
  98. * to initialize the module. Typically, this function will call
  99. * g_io_extension_point_implement().
  100. *
  101. * Since 2.56, this function should be named `g_io_<modulename>_load`, where
  102. * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
  103. * everything after the first dot removed, and with `-` replaced with `_`
  104. * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
  105. * Using the new symbol names avoids name clashes when building modules
  106. * statically. The old symbol names continue to be supported, but cannot be used
  107. * for static builds.
  108. **/
  109. G_MODULE_EXPORT
  110. void g_io_module_load (GIOModule *module);
  111. /**
  112. * g_io_module_unload: (skip)
  113. * @module: a #GIOModule.
  114. *
  115. * Required API for GIO modules to implement.
  116. *
  117. * This function is run when the module is being unloaded from GIO,
  118. * to finalize the module.
  119. *
  120. * Since 2.56, this function should be named `g_io_<modulename>_unload`, where
  121. * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
  122. * everything after the first dot removed, and with `-` replaced with `_`
  123. * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
  124. * Using the new symbol names avoids name clashes when building modules
  125. * statically. The old symbol names continue to be supported, but cannot be used
  126. * for static builds.
  127. **/
  128. G_MODULE_EXPORT
  129. void g_io_module_unload (GIOModule *module);
  130. /**
  131. * g_io_module_query:
  132. *
  133. * Optional API for GIO modules to implement.
  134. *
  135. * Should return a list of all the extension points that may be
  136. * implemented in this module.
  137. *
  138. * This method will not be called in normal use, however it may be
  139. * called when probing existing modules and recording which extension
  140. * points that this model is used for. This means we won't have to
  141. * load and initialize this module unless its needed.
  142. *
  143. * If this function is not implemented by the module the module will
  144. * always be loaded, initialized and then unloaded on application
  145. * startup so that it can register its extension points during init.
  146. *
  147. * Note that a module need not actually implement all the extension
  148. * points that g_io_module_query() returns, since the exact list of
  149. * extension may depend on runtime issues. However all extension
  150. * points actually implemented must be returned by g_io_module_query()
  151. * (if defined).
  152. *
  153. * When installing a module that implements g_io_module_query() you must
  154. * run gio-querymodules in order to build the cache files required for
  155. * lazy loading.
  156. *
  157. * Since 2.56, this function should be named `g_io_<modulename>_query`, where
  158. * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
  159. * everything after the first dot removed, and with `-` replaced with `_`
  160. * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
  161. * Using the new symbol names avoids name clashes when building modules
  162. * statically. The old symbol names continue to be supported, but cannot be used
  163. * for static builds.
  164. *
  165. * Returns: (transfer full): A %NULL-terminated array of strings,
  166. * listing the supported extension points of the module. The array
  167. * must be suitable for freeing with g_strfreev().
  168. *
  169. * Since: 2.24
  170. **/
  171. G_MODULE_EXPORT
  172. char **g_io_module_query (void);
  173. G_END_DECLS
  174. #endif /* __G_IO_MODULE_H__ */