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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __G_IO_MODULE_H__
28 #define __G_IO_MODULE_H__
30 #include <glib-object.h>
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))
45 * Opaque module base class for extending GIO.
47 typedef struct _GIOModule GIOModule
;
48 typedef struct _GIOModuleClass GIOModuleClass
;
50 typedef struct _GIOExtensionPoint GIOExtensionPoint
;
51 typedef struct _GIOExtension GIOExtension
;
53 GType
g_io_module_get_type (void) G_GNUC_CONST
;
54 GIOModule
*g_io_module_new (const gchar
*filename
);
56 GList
*g_io_modules_load_all_in_directory (const char *dirname
);
58 GIOExtensionPoint
*g_io_extension_point_register (const char *name
);
59 GIOExtensionPoint
*g_io_extension_point_lookup (const char *name
);
60 void g_io_extension_point_set_required_type (GIOExtensionPoint
*extension_point
,
62 GType
g_io_extension_point_get_required_type (GIOExtensionPoint
*extension_point
);
63 GList
*g_io_extension_point_get_extensions (GIOExtensionPoint
*extension_point
);
64 GIOExtension
* g_io_extension_point_get_extension_by_name (GIOExtensionPoint
*extension_point
,
66 GIOExtension
* g_io_extension_point_implement (const char *extension_point_name
,
68 const char *extension_name
,
71 GType
g_io_extension_get_type (GIOExtension
*extension
);
72 const char * g_io_extension_get_name (GIOExtension
*extension
);
73 gint
g_io_extension_get_priority (GIOExtension
*extension
);
74 GTypeClass
* g_io_extension_ref_class (GIOExtension
*extension
);
76 /* API for the modules to implement */
79 * @module: a #GIOModule.
81 * Required API for GIO modules to implement.
82 * This function is ran after the module has been loaded into GIO,
83 * to initialize the module.
85 void g_io_module_load (GIOModule
*module
);
89 * @module: a #GIOModule.
91 * Required API for GIO modules to implement.
92 * This function is ran when the module is being unloaded from GIO,
93 * to finalize the module.
95 void g_io_module_unload (GIOModule
*module
);
99 #endif /* __G_IO_MODULE_H__ */