gio/giomodule.h

   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
  23 #ifndef __G_IO_MODULE_H__
  24 #define __G_IO_MODULE_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31 #include <gmodule.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct _GIOModuleScope GIOModuleScope;
  36
  37 GIO_AVAILABLE_IN_2_30
  38 GIOModuleScope *   g_io_module_scope_new     (GIOModuleScopeFlags  flags);
  39 GIO_AVAILABLE_IN_2_30
  40 void               g_io_module_scope_free    (GIOModuleScope      *scope);
  41 GIO_AVAILABLE_IN_2_30
  42 void               g_io_module_scope_block   (GIOModuleScope      *scope,
  43                                               const gchar         *basename);
  44
  45 #define G_IO_TYPE_MODULE         (g_io_module_get_type ())
  46 #define G_IO_MODULE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_IO_TYPE_MODULE, GIOModule))
  47 #define G_IO_MODULE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_IO_TYPE_MODULE, GIOModuleClass))
  48 #define G_IO_IS_MODULE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_IO_TYPE_MODULE))
  49 #define G_IO_IS_MODULE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_IO_TYPE_MODULE))
  50 #define G_IO_MODULE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_IO_TYPE_MODULE, GIOModuleClass))
  51
  52 /**
  53  * GIOModule:
  54  *
  55  * Opaque module base class for extending GIO.
  56  **/
  57 typedef struct _GIOModuleClass GIOModuleClass;
  58
  59 GIO_AVAILABLE_IN_ALL
  60 GType              g_io_module_get_type                       (void) G_GNUC_CONST;
  61 GIO_AVAILABLE_IN_ALL
  62 GIOModule         *g_io_module_new                            (const gchar       *filename);
  63
  64 GIO_AVAILABLE_IN_ALL
  65 void               g_io_modules_scan_all_in_directory         (const char        *dirname);
  66 GIO_AVAILABLE_IN_ALL
  67 GList             *g_io_modules_load_all_in_directory         (const gchar       *dirname);
  68
  69 GIO_AVAILABLE_IN_2_30
  70 void               g_io_modules_scan_all_in_directory_with_scope   (const gchar       *dirname,
  71                                                                     GIOModuleScope    *scope);
  72 GIO_AVAILABLE_IN_2_30
  73 GList             *g_io_modules_load_all_in_directory_with_scope   (const gchar       *dirname,
  74                                                                     GIOModuleScope    *scope);
  75
  76 GIO_AVAILABLE_IN_ALL
  77 GIOExtensionPoint *g_io_extension_point_register              (const char        *name);
  78 GIO_AVAILABLE_IN_ALL
  79 GIOExtensionPoint *g_io_extension_point_lookup                (const char        *name);
  80 GIO_AVAILABLE_IN_ALL
  81 void               g_io_extension_point_set_required_type     (GIOExtensionPoint *extension_point,
  82                                                                GType              type);
  83 GIO_AVAILABLE_IN_ALL
  84 GType              g_io_extension_point_get_required_type     (GIOExtensionPoint *extension_point);
  85 GIO_AVAILABLE_IN_ALL
  86 GList             *g_io_extension_point_get_extensions        (GIOExtensionPoint *extension_point);
  87 GIO_AVAILABLE_IN_ALL
  88 GIOExtension *     g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
  89                                                                const char        *name);
  90 GIO_AVAILABLE_IN_ALL
  91 GIOExtension *     g_io_extension_point_implement             (const char        *extension_point_name,
  92                                                                GType              type,
  93                                                                const char        *extension_name,
  94                                                                gint               priority);
  95
  96 GIO_AVAILABLE_IN_ALL
  97 GType              g_io_extension_get_type                    (GIOExtension      *extension);
  98 GIO_AVAILABLE_IN_ALL
  99 const char *       g_io_extension_get_name                    (GIOExtension      *extension);
 100 GIO_AVAILABLE_IN_ALL
 101 gint               g_io_extension_get_priority                (GIOExtension      *extension);
 102 GIO_AVAILABLE_IN_ALL
 103 GTypeClass*        g_io_extension_ref_class                   (GIOExtension      *extension);
 104
 105
 106 /* API for the modules to implement.
 107  * Note that those functions are not implemented by libgio, they are declared
 108  * here to be implemented in modules, that's why it uses G_MODULE_EXPORT
 109  * instead of GIO_AVAILABLE_IN_ALL.
 110  */
 111
 112 /**
 113  * g_io_module_load: (skip)
 114  * @module: a #GIOModule.
 115  *
 116  * Required API for GIO modules to implement.
 117  *
 118  * This function is run after the module has been loaded into GIO,
 119  * to initialize the module. Typically, this function will call
 120  * g_io_extension_point_implement().
 121  *
 122  * Since 2.56, this function should be named `g_io_<modulename>_load`, where
 123  * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
 124  * everything after the first dot removed, and with `-` replaced with `_`
 125  * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
 126  * Using the new symbol names avoids name clashes when building modules
 127  * statically. The old symbol names continue to be supported, but cannot be used
 128  * for static builds.
 129  **/
 130 G_MODULE_EXPORT
 131 void   g_io_module_load   (GIOModule *module);
 132
 133 /**
 134  * g_io_module_unload: (skip)
 135  * @module: a #GIOModule.
 136  *
 137  * Required API for GIO modules to implement.
 138  *
 139  * This function is run when the module is being unloaded from GIO,
 140  * to finalize the module.
 141  *
 142  * Since 2.56, this function should be named `g_io_<modulename>_unload`, where
 143  * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
 144  * everything after the first dot removed, and with `-` replaced with `_`
 145  * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
 146  * Using the new symbol names avoids name clashes when building modules
 147  * statically. The old symbol names continue to be supported, but cannot be used
 148  * for static builds.
 149  **/
 150 G_MODULE_EXPORT
 151 void   g_io_module_unload (GIOModule *module);
 152
 153 /**
 154  * g_io_module_query:
 155  *
 156  * Optional API for GIO modules to implement.
 157  *
 158  * Should return a list of all the extension points that may be
 159  * implemented in this module.
 160  *
 161  * This method will not be called in normal use, however it may be
 162  * called when probing existing modules and recording which extension
 163  * points that this model is used for. This means we won't have to
 164  * load and initialize this module unless its needed.
 165  *
 166  * If this function is not implemented by the module the module will
 167  * always be loaded, initialized and then unloaded on application
 168  * startup so that it can register its extension points during init.
 169  *
 170  * Note that a module need not actually implement all the extension
 171  * points that g_io_module_query() returns, since the exact list of
 172  * extension may depend on runtime issues. However all extension
 173  * points actually implemented must be returned by g_io_module_query()
 174  * (if defined).
 175  *
 176  * When installing a module that implements g_io_module_query() you must
 177  * run gio-querymodules in order to build the cache files required for
 178  * lazy loading.
 179  *
 180  * Since 2.56, this function should be named `g_io_<modulename>_query`, where
 181  * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
 182  * everything after the first dot removed, and with `-` replaced with `_`
 183  * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
 184  * Using the new symbol names avoids name clashes when building modules
 185  * statically. The old symbol names continue to be supported, but cannot be used
 186  * for static builds.
 187  *
 188  * Returns: (transfer full): A %NULL-terminated array of strings,
 189  *     listing the supported extension points of the module. The array
 190  *     must be suitable for freeing with g_strfreev().
 191  *
 192  * Since: 2.24
 193  **/
 194 G_MODULE_EXPORT
 195 char **g_io_module_query (void);
 196
 197 G_END_DECLS
 198
 199 #endif /* __G_IO_MODULE_H__ */