gio/giomodule.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  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 GLIB_AVAILABLE_IN_2_30
  38 GIOModuleScope *   g_io_module_scope_new     (GIOModuleScopeFlags  flags);
  39 GLIB_AVAILABLE_IN_2_30
  40 void               g_io_module_scope_free    (GIOModuleScope      *scope);
  41 GLIB_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 GLIB_AVAILABLE_IN_ALL
  60 GType              g_io_module_get_type                       (void) G_GNUC_CONST;
  61 GLIB_AVAILABLE_IN_ALL
  62 GIOModule         *g_io_module_new                            (const gchar       *filename);
  63
  64 GLIB_AVAILABLE_IN_ALL
  65 void               g_io_modules_scan_all_in_directory         (const char        *dirname);
  66 GLIB_AVAILABLE_IN_ALL
  67 GList             *g_io_modules_load_all_in_directory         (const gchar       *dirname);
  68
  69 GLIB_AVAILABLE_IN_2_30
  70 void               g_io_modules_scan_all_in_directory_with_scope   (const gchar       *dirname,
  71                                                                     GIOModuleScope    *scope);
  72 GLIB_AVAILABLE_IN_2_30
  73 GList             *g_io_modules_load_all_in_directory_with_scope   (const gchar       *dirname,
  74                                                                     GIOModuleScope    *scope);
  75
  76 GLIB_AVAILABLE_IN_ALL
  77 GIOExtensionPoint *g_io_extension_point_register              (const char        *name);
  78 GLIB_AVAILABLE_IN_ALL
  79 GIOExtensionPoint *g_io_extension_point_lookup                (const char        *name);
  80 GLIB_AVAILABLE_IN_ALL
  81 void               g_io_extension_point_set_required_type     (GIOExtensionPoint *extension_point,
  82                                                                GType              type);
  83 GLIB_AVAILABLE_IN_ALL
  84 GType              g_io_extension_point_get_required_type     (GIOExtensionPoint *extension_point);
  85 GLIB_AVAILABLE_IN_ALL
  86 GList             *g_io_extension_point_get_extensions        (GIOExtensionPoint *extension_point);
  87 GLIB_AVAILABLE_IN_ALL
  88 GIOExtension *     g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
  89                                                                const char        *name);
  90 GLIB_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 GLIB_AVAILABLE_IN_ALL
  97 GType              g_io_extension_get_type                    (GIOExtension      *extension);
  98 GLIB_AVAILABLE_IN_ALL
  99 const char *       g_io_extension_get_name                    (GIOExtension      *extension);
 100 GLIB_AVAILABLE_IN_ALL
 101 gint               g_io_extension_get_priority                (GIOExtension      *extension);
 102 GLIB_AVAILABLE_IN_ALL
 103 GTypeClass*        g_io_extension_ref_class                   (GIOExtension      *extension);
 104
 105
 106 /* API for the modules to implement */
 107
 108 /**
 109  * g_io_module_load:
 110  * @module: a #GIOModule.
 111  *
 112  * Required API for GIO modules to implement.
 113  *
 114  * This function is run after the module has been loaded into GIO,
 115  * to initialize the module. Typically, this function will call
 116  * g_io_extension_point_implement().
 117  **/
 118 GLIB_AVAILABLE_IN_ALL
 119 void   g_io_module_load   (GIOModule *module);
 120
 121 /**
 122  * g_io_module_unload:
 123  * @module: a #GIOModule.
 124  *
 125  * Required API for GIO modules to implement.
 126  *
 127  * This function is run when the module is being unloaded from GIO,
 128  * to finalize the module.
 129  **/
 130 GLIB_AVAILABLE_IN_ALL
 131 void   g_io_module_unload (GIOModule *module);
 132
 133 /**
 134  * g_io_module_query:
 135  *
 136  * Optional API for GIO modules to implement.
 137  *
 138  * Should return a list of all the extension points that may be
 139  * implemented in this module.
 140  *
 141  * This method will not be called in normal use, however it may be
 142  * called when probing existing modules and recording which extension
 143  * points that this model is used for. This means we won't have to
 144  * load and initialize this module unless its needed.
 145  *
 146  * If this function is not implemented by the module the module will
 147  * always be loaded, initialized and then unloaded on application
 148  * startup so that it can register its extension points during init.
 149  *
 150  * Note that a module need not actually implement all the extension
 151  * points that g_io_module_query() returns, since the exact list of
 152  * extension may depend on runtime issues. However all extension
 153  * points actually implemented must be returned by g_io_module_query()
 154  * (if defined).
 155  *
 156  * When installing a module that implements g_io_module_query() you must
 157  * run gio-querymodules in order to build the cache files required for
 158  * lazy loading.
 159  *
 160  * Returns: (transfer full): A %NULL-terminated array of strings,
 161  *     listing the supported extension points of the module. The array
 162  *     must be suitable for freeing with g_strfreev().
 163  *
 164  * Since: 2.24
 165  **/
 166 GLIB_AVAILABLE_IN_ALL
 167 char **g_io_module_query (void);
 168
 169 G_END_DECLS
 170
 171 #endif /* __G_IO_MODULE_H__ */