344 lines
8.7 KiB
C
344 lines
8.7 KiB
C
/*
|
|
* xed-object-module.c
|
|
* This file is part of xed
|
|
*
|
|
* Copyright (C) 2005 - Paolo Maggi
|
|
* Copyright (C) 2008 - Jesse van den Kieboom
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin St, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
/* This is a modified version of ephy-module.c from Epiphany source code.
|
|
* Here the original copyright assignment:
|
|
*
|
|
* Copyright (C) 2003 Marco Pesenti Gritti
|
|
* Copyright (C) 2003, 2004 Christian Persch
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* Modified by the xed Team, 2005. See the AUTHORS file for a
|
|
* list of people on the xed Team.
|
|
* See the ChangeLog files for a list of changes.
|
|
*
|
|
* $Id: xed-module.c 6314 2008-06-05 12:57:53Z pborelli $
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include "xed-object-module.h"
|
|
#include "xed-debug.h"
|
|
|
|
typedef GType (*XedObjectModuleRegisterFunc) (GTypeModule *);
|
|
|
|
enum {
|
|
PROP_0,
|
|
PROP_MODULE_NAME,
|
|
PROP_PATH,
|
|
PROP_TYPE_REGISTRATION,
|
|
PROP_RESIDENT
|
|
};
|
|
|
|
struct _XedObjectModulePrivate
|
|
{
|
|
GModule *library;
|
|
|
|
GType type;
|
|
gchar *path;
|
|
gchar *module_name;
|
|
gchar *type_registration;
|
|
|
|
gboolean resident;
|
|
};
|
|
|
|
G_DEFINE_TYPE (XedObjectModule, xed_object_module, G_TYPE_TYPE_MODULE);
|
|
|
|
static gboolean
|
|
xed_object_module_load (GTypeModule *gmodule)
|
|
{
|
|
XedObjectModule *module = XED_OBJECT_MODULE (gmodule);
|
|
XedObjectModuleRegisterFunc register_func;
|
|
gchar *path;
|
|
|
|
xed_debug_message (DEBUG_PLUGINS, "Loading %s module from %s",
|
|
module->priv->module_name, module->priv->path);
|
|
|
|
path = g_module_build_path (module->priv->path, module->priv->module_name);
|
|
g_return_val_if_fail (path != NULL, FALSE);
|
|
xed_debug_message (DEBUG_PLUGINS, "Module filename: %s", path);
|
|
|
|
module->priv->library = g_module_open (path,
|
|
G_MODULE_BIND_LAZY);
|
|
g_free (path);
|
|
|
|
if (module->priv->library == NULL)
|
|
{
|
|
g_warning ("%s: %s", module->priv->module_name, g_module_error());
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
/* extract symbols from the lib */
|
|
if (!g_module_symbol (module->priv->library, module->priv->type_registration,
|
|
(void *) ®ister_func))
|
|
{
|
|
g_warning ("%s: %s", module->priv->module_name, g_module_error());
|
|
g_module_close (module->priv->library);
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
/* symbol can still be NULL even though g_module_symbol
|
|
* returned TRUE */
|
|
if (register_func == NULL)
|
|
{
|
|
g_warning ("Symbol '%s' should not be NULL", module->priv->type_registration);
|
|
g_module_close (module->priv->library);
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
module->priv->type = register_func (gmodule);
|
|
|
|
if (module->priv->type == 0)
|
|
{
|
|
g_warning ("Invalid object contained by module %s", module->priv->module_name);
|
|
return FALSE;
|
|
}
|
|
|
|
if (module->priv->resident)
|
|
{
|
|
g_module_make_resident (module->priv->library);
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static void
|
|
xed_object_module_unload (GTypeModule *gmodule)
|
|
{
|
|
XedObjectModule *module = XED_OBJECT_MODULE (gmodule);
|
|
|
|
xed_debug_message (DEBUG_PLUGINS, "Unloading %s", module->priv->path);
|
|
|
|
g_module_close (module->priv->library);
|
|
|
|
module->priv->library = NULL;
|
|
module->priv->type = 0;
|
|
}
|
|
|
|
static void
|
|
xed_object_module_init (XedObjectModule *module)
|
|
{
|
|
xed_debug_message (DEBUG_PLUGINS, "XedObjectModule %p initialising", module);
|
|
|
|
module->priv = G_TYPE_INSTANCE_GET_PRIVATE (module,
|
|
XED_TYPE_OBJECT_MODULE,
|
|
XedObjectModulePrivate);
|
|
}
|
|
|
|
static void
|
|
xed_object_module_finalize (GObject *object)
|
|
{
|
|
XedObjectModule *module = XED_OBJECT_MODULE (object);
|
|
|
|
xed_debug_message (DEBUG_PLUGINS, "XedObjectModule %p finalising", module);
|
|
|
|
g_free (module->priv->path);
|
|
g_free (module->priv->module_name);
|
|
g_free (module->priv->type_registration);
|
|
|
|
G_OBJECT_CLASS (xed_object_module_parent_class)->finalize (object);
|
|
}
|
|
|
|
static void
|
|
xed_object_module_get_property (GObject *object,
|
|
guint prop_id,
|
|
GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
XedObjectModule *module = XED_OBJECT_MODULE (object);
|
|
|
|
switch (prop_id)
|
|
{
|
|
case PROP_MODULE_NAME:
|
|
g_value_set_string (value, module->priv->module_name);
|
|
break;
|
|
case PROP_PATH:
|
|
g_value_set_string (value, module->priv->path);
|
|
break;
|
|
case PROP_TYPE_REGISTRATION:
|
|
g_value_set_string (value, module->priv->type_registration);
|
|
break;
|
|
case PROP_RESIDENT:
|
|
g_value_set_boolean (value, module->priv->resident);
|
|
break;
|
|
default:
|
|
g_return_if_reached ();
|
|
}
|
|
}
|
|
|
|
static void
|
|
xed_object_module_set_property (GObject *object,
|
|
guint prop_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
XedObjectModule *module = XED_OBJECT_MODULE (object);
|
|
|
|
switch (prop_id)
|
|
{
|
|
case PROP_MODULE_NAME:
|
|
module->priv->module_name = g_value_dup_string (value);
|
|
g_type_module_set_name (G_TYPE_MODULE (object),
|
|
module->priv->module_name);
|
|
break;
|
|
case PROP_PATH:
|
|
module->priv->path = g_value_dup_string (value);
|
|
break;
|
|
case PROP_TYPE_REGISTRATION:
|
|
module->priv->type_registration = g_value_dup_string (value);
|
|
break;
|
|
case PROP_RESIDENT:
|
|
module->priv->resident = g_value_get_boolean (value);
|
|
break;
|
|
default:
|
|
g_return_if_reached ();
|
|
}
|
|
}
|
|
|
|
static void
|
|
xed_object_module_class_init (XedObjectModuleClass *klass)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (klass);
|
|
GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (klass);
|
|
|
|
object_class->set_property = xed_object_module_set_property;
|
|
object_class->get_property = xed_object_module_get_property;
|
|
object_class->finalize = xed_object_module_finalize;
|
|
|
|
module_class->load = xed_object_module_load;
|
|
module_class->unload = xed_object_module_unload;
|
|
|
|
g_object_class_install_property (object_class,
|
|
PROP_MODULE_NAME,
|
|
g_param_spec_string ("module-name",
|
|
"Module Name",
|
|
"The module to load for this object",
|
|
NULL,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT_ONLY));
|
|
|
|
g_object_class_install_property (object_class,
|
|
PROP_PATH,
|
|
g_param_spec_string ("path",
|
|
"Path",
|
|
"The path to use when loading this module",
|
|
NULL,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT_ONLY));
|
|
|
|
g_object_class_install_property (object_class,
|
|
PROP_TYPE_REGISTRATION,
|
|
g_param_spec_string ("type-registration",
|
|
"Type Registration",
|
|
"The name of the type registration function",
|
|
NULL,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT_ONLY));
|
|
|
|
g_object_class_install_property (object_class,
|
|
PROP_RESIDENT,
|
|
g_param_spec_boolean ("resident",
|
|
"Resident",
|
|
"Whether the module is resident",
|
|
FALSE,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT_ONLY));
|
|
|
|
g_type_class_add_private (klass, sizeof (XedObjectModulePrivate));
|
|
}
|
|
|
|
XedObjectModule *
|
|
xed_object_module_new (const gchar *module_name,
|
|
const gchar *path,
|
|
const gchar *type_registration,
|
|
gboolean resident)
|
|
{
|
|
return (XedObjectModule *)g_object_new (XED_TYPE_OBJECT_MODULE,
|
|
"module-name",
|
|
module_name,
|
|
"path",
|
|
path,
|
|
"type-registration",
|
|
type_registration,
|
|
"resident",
|
|
resident,
|
|
NULL);
|
|
}
|
|
|
|
GObject *
|
|
xed_object_module_new_object (XedObjectModule *module,
|
|
const gchar *first_property_name,
|
|
...)
|
|
{
|
|
va_list var_args;
|
|
GObject *result;
|
|
|
|
g_return_val_if_fail (module->priv->type != 0, NULL);
|
|
|
|
xed_debug_message (DEBUG_PLUGINS, "Creating object of type %s",
|
|
g_type_name (module->priv->type));
|
|
|
|
va_start (var_args, first_property_name);
|
|
result = g_object_new_valist (module->priv->type, first_property_name, var_args);
|
|
va_end (var_args);
|
|
|
|
return result;
|
|
}
|
|
|
|
const gchar *
|
|
xed_object_module_get_path (XedObjectModule *module)
|
|
{
|
|
g_return_val_if_fail (XED_IS_OBJECT_MODULE (module), NULL);
|
|
|
|
return module->priv->path;
|
|
}
|
|
|
|
const gchar *
|
|
xed_object_module_get_module_name (XedObjectModule *module)
|
|
{
|
|
g_return_val_if_fail (XED_IS_OBJECT_MODULE (module), NULL);
|
|
|
|
return module->priv->module_name;
|
|
}
|
|
|
|
const gchar *
|
|
xed_object_module_get_type_registration (XedObjectModule *module)
|
|
{
|
|
g_return_val_if_fail (XED_IS_OBJECT_MODULE (module), NULL);
|
|
|
|
return module->priv->type_registration;
|
|
}
|
|
|
|
GType
|
|
xed_object_module_get_object_type (XedObjectModule *module)
|
|
{
|
|
g_return_val_if_fail (XED_IS_OBJECT_MODULE (module), 0);
|
|
|
|
return module->priv->type;
|
|
}
|