gio/giomodule.h

   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 <glib-object.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 _GIOModule GIOModule;
  48 typedef struct _GIOModuleClass GIOModuleClass;
  49
  50 GType      g_io_module_get_type (void) G_GNUC_CONST;
  51 GIOModule *g_io_module_new      (const gchar *filename);
  52
  53 GList *    g_io_modules_load_all_in_directory (const char *dirname);
  54
  55 /* API for the modules to implement */
  56 /**
  57  * g_io_module_load:
  58  * @module: a #GIOModule.
  59  *
  60  * Required API for GIO modules to implement. This function is ran after the module
  61  * has been loaded into GIO, to initialize the module.
  62  **/
  63 void        g_io_module_load     (GIOModule   *module);
  64
  65 /**
  66  * g_io_module_unload:
  67  * @module: a #GIOModule.
  68  *
  69  * Required API for GIO modules to implement. This function is ran when the module
  70  * is being unloaded from GIO, to finalize the module.
  71  **/
  72 void        g_io_module_unload   (GIOModule   *module);
  73
  74 G_END_DECLS
  75
  76 #endif /* __G_IO_MODULE_H__ */