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