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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_IO_MODULE_H__
  28 #define __G_IO_MODULE_H__
  29
  30 #include <gio/giotypes.h>
  31 #include <gmodule.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct _GIOModuleScope GIOModuleScope;
  36
  37 GIOModuleScope *   g_io_module_scope_new     (GIOModuleScopeFlags  flags);
  38 void               g_io_module_scope_free    (GIOModuleScope      *scope);
  39 void               g_io_module_scope_block   (GIOModuleScope      *scope,
  40                                               const gchar         *basename);
  41
  42 #define G_IO_TYPE_MODULE         (g_io_module_get_type ())
  43 #define G_IO_MODULE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_IO_TYPE_MODULE, GIOModule))
  44 #define G_IO_MODULE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_IO_TYPE_MODULE, GIOModuleClass))
  45 #define G_IO_IS_MODULE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_IO_TYPE_MODULE))
  46 #define G_IO_IS_MODULE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_IO_TYPE_MODULE))
  47 #define G_IO_MODULE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_IO_TYPE_MODULE, GIOModuleClass))
  48
  49 /**
  50  * GIOModule:
  51  *
  52  * Opaque module base class for extending GIO.
  53  **/
  54 typedef struct _GIOModuleClass GIOModuleClass;
  55
  56 GType              g_io_module_get_type                       (void) G_GNUC_CONST;
  57 GIOModule         *g_io_module_new                            (const gchar       *filename);
  58
  59 void               g_io_modules_scan_all_in_directory         (const char        *dirname);
  60 GList             *g_io_modules_load_all_in_directory         (const gchar       *dirname);
  61
  62 void               g_io_modules_scan_all_in_directory_with_scope   (const gchar       *dirname,
  63                                                                     GIOModuleScope    *scope);
  64 GList             *g_io_modules_load_all_in_directory_with_scope   (const gchar       *dirname,
  65                                                                     GIOModuleScope    *scope);
  66
  67 GIOExtensionPoint *g_io_extension_point_register              (const char        *name);
  68 GIOExtensionPoint *g_io_extension_point_lookup                (const char        *name);
  69 void               g_io_extension_point_set_required_type     (GIOExtensionPoint *extension_point,
  70                                                                GType              type);
  71 GType              g_io_extension_point_get_required_type     (GIOExtensionPoint *extension_point);
  72 GList             *g_io_extension_point_get_extensions        (GIOExtensionPoint *extension_point);
  73 GIOExtension *     g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
  74                                                                const char        *name);
  75 GIOExtension *     g_io_extension_point_implement             (const char        *extension_point_name,
  76                                                                GType              type,
  77                                                                const char        *extension_name,
  78                                                                gint               priority);
  79
  80 GType              g_io_extension_get_type                    (GIOExtension      *extension);
  81 const char *       g_io_extension_get_name                    (GIOExtension      *extension);
  82 gint               g_io_extension_get_priority                (GIOExtension      *extension);
  83 GTypeClass*        g_io_extension_ref_class                   (GIOExtension      *extension);
  84
  85
  86 /* API for the modules to implement */
  87
  88 /**
  89  * g_io_module_load:
  90  * @module: a #GIOModule.
  91  *
  92  * Required API for GIO modules to implement.
  93  * This function is ran after the module has been loaded into GIO,
  94  * to initialize the module.
  95  **/
  96 void   g_io_module_load   (GIOModule *module);
  97
  98 /**
  99  * g_io_module_unload:
 100  * @module: a #GIOModule.
 101  *
 102  * Required API for GIO modules to implement.
 103  * This function is ran when the module is being unloaded from GIO,
 104  * to finalize the module.
 105  **/
 106 void   g_io_module_unload (GIOModule *module);
 107
 108 /**
 109  * g_io_module_query:
 110  *
 111  * Optional API for GIO modules to implement.
 112  *
 113  * Should return a list of all the extension points that may be
 114  * implemented in this module.
 115  *
 116  * This method will not be called in normal use, however it may be
 117  * called when probing existing modules and recording which extension
 118  * points that this model is used for. This means we won't have to
 119  * load and initialze this module unless its needed.
 120  *
 121  * If this function is not implemented by the module the module will
 122  * always be loaded, initialized and then unloaded on application startup
 123  * so that it can register its extension points during init.
 124  *
 125  * Note that a module need not actually implement all the extension points
 126  * that g_io_module_query returns, since the exact list of extension may
 127  * depend on runtime issues. However all extension points actually implemented
 128  * must be returned by g_io_module_query() (if defined).
 129  *
 130  * When installing a module that implements g_io_module_query you must
 131  * run gio-querymodules in order to build the cache files required for
 132  * lazy loading.
 133  *
 134  * Returns: (transfer full): A %NULL-terminated array of strings, listing the supported
 135  *     extension points of the module. The array must be suitable for
 136  *     freeing with g_strfreev().
 137  *
 138  * Since: 2.24
 139  **/
 140 char **g_io_module_query (void);
 141
 142 G_END_DECLS
 143
 144 #endif /* __G_IO_MODULE_H__ */