1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #ifndef __G_IO_MODULE_H__
24 #define __G_IO_MODULE_H__
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
30 #include <gio/giotypes.h>
35 typedef struct _GIOModuleScope GIOModuleScope;
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);
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))
55 * Opaque module base class for extending GIO.
57 typedef struct _GIOModuleClass GIOModuleClass;
59 GType g_io_module_get_type (void) G_GNUC_CONST;
60 GIOModule *g_io_module_new (const gchar *filename);
62 void g_io_modules_scan_all_in_directory (const char *dirname);
63 GList *g_io_modules_load_all_in_directory (const gchar *dirname);
65 GLIB_AVAILABLE_IN_2_30
66 void g_io_modules_scan_all_in_directory_with_scope (const gchar *dirname,
67 GIOModuleScope *scope);
68 GLIB_AVAILABLE_IN_2_30
69 GList *g_io_modules_load_all_in_directory_with_scope (const gchar *dirname,
70 GIOModuleScope *scope);
72 GIOExtensionPoint *g_io_extension_point_register (const char *name);
73 GIOExtensionPoint *g_io_extension_point_lookup (const char *name);
74 void g_io_extension_point_set_required_type (GIOExtensionPoint *extension_point,
76 GType g_io_extension_point_get_required_type (GIOExtensionPoint *extension_point);
77 GList *g_io_extension_point_get_extensions (GIOExtensionPoint *extension_point);
78 GIOExtension * g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
80 GIOExtension * g_io_extension_point_implement (const char *extension_point_name,
82 const char *extension_name,
85 GType g_io_extension_get_type (GIOExtension *extension);
86 const char * g_io_extension_get_name (GIOExtension *extension);
87 gint g_io_extension_get_priority (GIOExtension *extension);
88 GTypeClass* g_io_extension_ref_class (GIOExtension *extension);
91 /* API for the modules to implement */
95 * @module: a #GIOModule.
97 * Required API for GIO modules to implement.
98 * This function is ran after the module has been loaded into GIO,
99 * to initialize the module.
101 void g_io_module_load (GIOModule *module);
104 * g_io_module_unload:
105 * @module: a #GIOModule.
107 * Required API for GIO modules to implement.
108 * This function is ran when the module is being unloaded from GIO,
109 * to finalize the module.
111 void g_io_module_unload (GIOModule *module);
116 * Optional API for GIO modules to implement.
118 * Should return a list of all the extension points that may be
119 * implemented in this module.
121 * This method will not be called in normal use, however it may be
122 * called when probing existing modules and recording which extension
123 * points that this model is used for. This means we won't have to
124 * load and initialze this module unless its needed.
126 * If this function is not implemented by the module the module will
127 * always be loaded, initialized and then unloaded on application startup
128 * so that it can register its extension points during init.
130 * Note that a module need not actually implement all the extension points
131 * that g_io_module_query returns, since the exact list of extension may
132 * depend on runtime issues. However all extension points actually implemented
133 * must be returned by g_io_module_query() (if defined).
135 * When installing a module that implements g_io_module_query you must
136 * run gio-querymodules in order to build the cache files required for
139 * Returns: (transfer full): A %NULL-terminated array of strings, listing the supported
140 * extension points of the module. The array must be suitable for
141 * freeing with g_strfreev().
145 char **g_io_module_query (void);
149 #endif /* __G_IO_MODULE_H__ */