Moved all relevant typedefs into these files.
[platform/upstream/glib.git] / gio / giomodule.h
index 44ed052..0d8c5ab 100644 (file)
  * Author: Alexander Larsson <alexl@redhat.com>
  */
 
+#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
+#error "Only <gio/gio.h> can be included directly."
+#endif
+
 #ifndef __G_IO_MODULE_H__
 #define __G_IO_MODULE_H__
 
-#include <glib-object.h>
+#include <gio/giotypes.h>
 #include <gmodule.h>
 
 G_BEGIN_DECLS
@@ -35,16 +39,55 @@ G_BEGIN_DECLS
 #define G_IO_IS_MODULE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_IO_TYPE_MODULE))
 #define G_IO_MODULE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_IO_TYPE_MODULE, GIOModuleClass))
 
-typedef struct _GIOModule GIOModule;
+/**
+ * GIOModule:
+ * 
+ * Opaque module base class for extending GIO.
+ **/
 typedef struct _GIOModuleClass GIOModuleClass;
 
 GType      g_io_module_get_type (void) G_GNUC_CONST;
 GIOModule *g_io_module_new      (const gchar *filename);
 
-void       g_io_modules_ensure_loaded (const char *directory);
+GList *g_io_modules_load_all_in_directory            (const char *dirname);
+
+GIOExtensionPoint *g_io_extension_point_register              (const char        *name);
+GIOExtensionPoint *g_io_extension_point_lookup                (const char        *name);
+void               g_io_extension_point_set_required_type     (GIOExtensionPoint *extension_point,
+                                                              GType              type);
+GType              g_io_extension_point_get_required_type     (GIOExtensionPoint *extension_point);
+GList             *g_io_extension_point_get_extensions        (GIOExtensionPoint *extension_point);
+GIOExtension *     g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
+                                                              const char        *name);
+GIOExtension *     g_io_extension_point_implement             (const char        *extension_point_name,
+                                                              GType              type,
+                                                              const char        *extension_name,
+                                                              gint               priority);
+
+GType                   g_io_extension_get_type     (GIOExtension *extension);
+const char *            g_io_extension_get_name     (GIOExtension *extension);
+gint                    g_io_extension_get_priority (GIOExtension *extension);
+GTypeClass*             g_io_extension_ref_class    (GIOExtension *extension);
 
 /* API for the modules to implement */
+/**
+ * g_io_module_load:
+ * @module: a #GIOModule.
+ * 
+ * Required API for GIO modules to implement. 
+ * This function is ran after the module has been loaded into GIO, 
+ * to initialize the module.
+ **/
 void        g_io_module_load     (GIOModule   *module);
+
+/**
+ * g_io_module_unload:
+ * @module: a #GIOModule.
+ * 
+ * Required API for GIO modules to implement. 
+ * This function is ran when the module is being unloaded from GIO, 
+ * to finalize the module.
+ **/
 void        g_io_module_unload   (GIOModule   *module);
 
 G_END_DECLS