• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 GList             *g_io_modules_load_all_in_directory         (const gchar       *dirname);
53 
54 GIOExtensionPoint *g_io_extension_point_register              (const char        *name);
55 GIOExtensionPoint *g_io_extension_point_lookup                (const char        *name);
56 void               g_io_extension_point_set_required_type     (GIOExtensionPoint *extension_point,
57 							       GType              type);
58 GType              g_io_extension_point_get_required_type     (GIOExtensionPoint *extension_point);
59 GList             *g_io_extension_point_get_extensions        (GIOExtensionPoint *extension_point);
60 GIOExtension *     g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
61 							       const char        *name);
62 GIOExtension *     g_io_extension_point_implement             (const char        *extension_point_name,
63 							       GType              type,
64 							       const char        *extension_name,
65 							       gint               priority);
66 
67 GType              g_io_extension_get_type                    (GIOExtension      *extension);
68 const char *       g_io_extension_get_name                    (GIOExtension      *extension);
69 gint               g_io_extension_get_priority                (GIOExtension      *extension);
70 GTypeClass*        g_io_extension_ref_class                   (GIOExtension      *extension);
71 
72 
73 /* API for the modules to implement */
74 
75 /**
76  * g_io_module_load:
77  * @module: a #GIOModule.
78  *
79  * Required API for GIO modules to implement.
80  * This function is ran after the module has been loaded into GIO,
81  * to initialize the module.
82  **/
83 void   g_io_module_load   (GIOModule *module);
84 
85 /**
86  * g_io_module_unload:
87  * @module: a #GIOModule.
88  *
89  * Required API for GIO modules to implement.
90  * This function is ran when the module is being unloaded from GIO,
91  * to finalize the module.
92  **/
93 void   g_io_module_unload (GIOModule *module);
94 
95 G_END_DECLS
96 
97 #endif /* __G_IO_MODULE_H__ */
98