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 #include <glib-object.h>
31 #define G_IO_TYPE_MODULE (g_io_module_get_type ())
32 #define G_IO_MODULE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_IO_TYPE_MODULE, GIOModule))
33 #define G_IO_MODULE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_IO_TYPE_MODULE, GIOModuleClass))
34 #define G_IO_IS_MODULE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_IO_TYPE_MODULE))
35 #define G_IO_IS_MODULE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_IO_TYPE_MODULE))
36 #define G_IO_MODULE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_IO_TYPE_MODULE, GIOModuleClass))
41 * Opaque module base class for extending GIO.
43 typedef struct _GIOModule GIOModule;
44 typedef struct _GIOModuleClass GIOModuleClass;
46 GType g_io_module_get_type (void) G_GNUC_CONST;
47 GIOModule *g_io_module_new (const gchar *filename);
49 void g_io_modules_ensure_loaded (const char *directory);
51 /* API for the modules to implement */
54 * @module: a #GIOModule.
56 * Required API for GIO modules to implement. This function is ran after the module
57 * has been loaded into GIO, to initialize the module.
59 void g_io_module_load (GIOModule *module);
63 * @module: a #GIOModule.
65 * Required API for GIO modules to implement. This function is ran when the module
66 * is being unloaded from GIO, to finalize the module.
68 void g_io_module_unload (GIOModule *module);
72 #endif /* __G_IO_MODULE_H__ */