plugins/rb-module.c

   1 /*
   2  * heavily based on code from Gedit, which is based on code from Ephiphany
   3  *
   4  * Copyright (C) 2003 Marco Pesenti Gritti
   5  * Copyright (C) 2003, 2004 Christian Persch
   6  * Copyright (C) 2005 - Paolo Maggi
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301  USA.
  22  */
  23
  24 #include "config.h"
  25
  26 #include "rb-module.h"
  27 #include "rb-debug.h"
  28
  29 #include <gmodule.h>
  30
  31 typedef struct _RBModuleClass RBModuleClass;
  32
  33 struct _RBModuleClass
  34 {
  35         GTypeModuleClass parent_class;
  36 };
  37
  38 struct _RBModule
  39 {
  40         GTypeModule parent_instance;
  41
  42         GModule *library;
  43
  44         gchar *path;
  45         gchar *name;
  46         GType type;
  47 };
  48
  49 typedef GType (*RBModuleRegisterFunc) (GTypeModule *);
  50
  51 static void rb_module_init              (RBModule *action);
  52 static void rb_module_class_init        (RBModuleClass *class);
  53
  54 static GObjectClass *parent_class = NULL;
  55
  56 G_DEFINE_TYPE (RBModule, rb_module, G_TYPE_TYPE_MODULE)
  57
  58 static gboolean
  59 rb_module_load (GTypeModule *gmodule)
  60 {
  61         RBModule *module = RB_MODULE (gmodule);
  62         RBModuleRegisterFunc register_func;
  63
  64         rb_debug ("Loading %s", module->path);
  65
  66         module->library = g_module_open (module->path, 0);
  67
  68         if (module->library == NULL) {
  69                 g_warning (g_module_error());
  70
  71                 return FALSE;
  72         }
  73
  74         /* extract symbols from the lib */
  75         if (!g_module_symbol (module->library, "register_rb_plugin", (void *)&register_func)) {
  76                 g_warning (g_module_error ());
  77                 g_module_close (module->library);
  78                 return FALSE;
  79         }
  80
  81         g_assert (register_func);
  82
  83         module->type = register_func (gmodule);
  84         if (module->type == 0) {
  85                 g_warning ("Invalid rb plugin contained by module %s", module->path);
  86                 return FALSE;
  87         }
  88
  89         return TRUE;
  90 }
  91
  92 static void
  93 rb_module_unload (GTypeModule *gmodule)
  94 {
  95         RBModule *module = RB_MODULE (gmodule);
  96
  97         rb_debug ("Unloading %s", module->path);
  98
  99         g_module_close (module->library);
 100
 101         module->library = NULL;
 102         module->type = 0;
 103 }
 104
 105 const gchar *
 106 rb_module_get_path (RBModule *module)
 107 {
 108         g_return_val_if_fail (RB_IS_MODULE (module), NULL);
 109
 110         return module->path;
 111 }
 112
 113 GObject *
 114 rb_module_new_object (RBModule *module)
 115 {
 116         GObject *obj;
 117         rb_debug ("Creating object of type %s", g_type_name (module->type));
 118
 119         if (module->type == 0) {
 120                 return NULL;
 121         }
 122
 123         obj = g_object_new (module->type,
 124                             "name", module->name,
 125                             NULL);
 126         return obj;
 127 }
 128
 129 static void
 130 rb_module_init (RBModule *module)
 131 {
 132         rb_debug ("RBModule %p initialising", module);
 133 }
 134
 135 static void
 136 rb_module_finalize (GObject *object)
 137 {
 138         RBModule *module = RB_MODULE (object);
 139
 140         rb_debug ("GeditModule %p finalising", module);
 141
 142         g_free (module->path);
 143
 144         G_OBJECT_CLASS (parent_class)->finalize (object);
 145 }
 146
 147 static void
 148 rb_module_class_init (RBModuleClass *class)
 149 {
 150         GObjectClass *object_class = G_OBJECT_CLASS (class);
 151         GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
 152
 153         parent_class = (GObjectClass *) g_type_class_peek_parent (class);
 154
 155         object_class->finalize = rb_module_finalize;
 156
 157         module_class->load = rb_module_load;
 158         module_class->unload = rb_module_unload;
 159 }
 160
 161 RBModule *
 162 rb_module_new (const gchar *path, const char *module)
 163 {
 164         RBModule *result;
 165
 166         if (path == NULL || path[0] == '\0') {
 167                 return NULL;
 168         }
 169
 170         result = g_object_new (RB_TYPE_MODULE, NULL);
 171
 172         g_type_module_set_name (G_TYPE_MODULE (result), path);
 173         result->path = g_strdup (path);
 174         result->name = g_strdup (module);
 175
 176         return result;
 177 }