Very simple plugin framework, unused for now. We will start making

2003-07-12  Marco Pesenti Gritti  <marco@it.gnome.org>

	* configure.in:
	* plugins/.cvsignore:
	* plugins/Makefile.am:
	* plugins/sample/.cvsignore:
	* plugins/sample/Makefile.am:
	* plugins/sample/sample.c: (bmks_changed), (plugin_init),
	(plugin_exit):
	* src/Makefile.am:
	* src/ephy-plugin.c: (ephy_plugin_get_type), (ephy_plugin_new),
	(ephy_plugin_load), (ephy_plugin_unload), (ephy_plugin_class_init),
	(ephy_plugin_init), (ephy_plugin_finalize):
	* src/ephy-plugin.h:
	* src/ephy-shell.c: (ephy_shell_load_plugins), (ephy_shell_init),
	(ephy_shell_finalize):

	Very simple plugin framework, unused for now.
	We will start making something useful with it only post 1.0

4 files changed, 261 insertions, 0 deletions

diff --git a/src/Makefile.am b/src/Makefile.am
index d8041ce11..53cb7c4c7 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -10,6 +10,7 @@ INCLUDES = \
 	$(WARN_CFLAGS)			\
 	$(EPIPHANY_DEPENDENCY_CFLAGS) 	\
 	-DSHARE_DIR=\"$(pkgdatadir)\" 	\
+	-DPLUGINS_DIR=\""$(libdir)/epiphany/plugins"\" 	\
 	-DDATADIR=\""$(datadir)"\" 	\
 	-DPIXMAP_DIR=\""$(datadir)/pixmaps"\" 		\
 	-DGNOMELOCALEDIR=\""$(datadir)/locale"\"	\
@@ -62,6 +63,8 @@ epiphany_bin_SOURCES = 				    	\
 	ephy-navigation-action.h			\
 	ephy-notebook.c					\
 	ephy-notebook.h					\
+	ephy-plugin.c					\
+	ephy-plugin.h					\
 	ephy-shell.c					\
 	ephy-shell.h					\
 	ephy-spinner-action.c				\
diff --git a/src/ephy-plugin.c b/src/ephy-plugin.c
new file mode 100644
index 000000000..df4abc675
--- /dev/null
+++ b/src/ephy-plugin.c
@@ -0,0 +1,179 @@
+/*
+ *  Copyright (C) 2003 Marco Pesenti Gritti
+ *
+ *  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, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include "ephy-plugin.h"
+#include "ephy-file-helpers.h"
+
+#include <gmodule.h>
+
+typedef struct _EphyPluginClass EphyPluginClass;
+
+struct _EphyPluginClass
+{
+	GTypeModuleClass parent_class;
+};
+
+struct _EphyPlugin
+{
+	GTypeModule parent_instance;
+
+	GModule *library;
+
+	void (*init) (GTypeModule *);
+	void (*exit) (void);
+
+	char *name;
+};
+
+static void ephy_plugin_init       (EphyPlugin *action);
+static void ephy_plugin_class_init (EphyPluginClass *class);
+static void ephy_plugin_finalize   (GObject *object);
+
+static GObjectClass *parent_class = NULL;
+
+GType
+ephy_plugin_get_type (void)
+{
+	static GType type = 0;
+
+	if (!type)
+	{
+		static const GTypeInfo type_info =
+		{
+			sizeof (EphyPluginClass),
+			(GBaseInitFunc) NULL,
+			(GBaseFinalizeFunc) NULL,
+			(GClassInitFunc) ephy_plugin_class_init,
+			(GClassFinalizeFunc) NULL,
+			NULL,
+			sizeof (EphyPlugin),
+			0, /* n_preallocs */
+			(GInstanceInitFunc) ephy_plugin_init,
+		};
+
+		type = g_type_register_static (G_TYPE_TYPE_MODULE,
+					       "EphyPlugin",
+					       &type_info, 0);
+	}
+	return type;
+}
+
+EphyPlugin *
+ephy_plugin_new (const char *name)
+{
+	EphyPlugin *result;
+
+	result = g_object_new (EPHY_TYPE_PLUGIN, NULL);
+
+	g_type_module_set_name (G_TYPE_MODULE (result), name);
+	result->name = g_strdup (name);
+
+	if (!g_type_module_use (G_TYPE_MODULE (result)))
+	{
+		return NULL;
+	}
+
+	return result;
+}
+
+static gboolean
+ephy_plugin_load (GTypeModule *module)
+{
+	EphyPlugin *plugin = EPHY_PLUGIN (module);
+	char *module_path;
+
+	module_path = g_strdup (plugin->name);
+
+	if (!module_path)
+	{
+		g_warning ("Unable to locate theme engine in module_path: \"%s\",",
+			   plugin->name);
+		return FALSE;
+	}
+
+	plugin->library = g_module_open (module_path, 0);
+	g_free (module_path);
+
+	if (!plugin->library)
+	{
+		g_warning (g_module_error());
+		return FALSE;
+	}
+
+	/* extract symbols from the lib */
+	if (!g_module_symbol (plugin->library, "plugin_init",
+	    (gpointer *)&plugin->init) ||
+            !g_module_symbol (plugin->library, "plugin_exit",
+	    (gpointer *)&plugin->exit))
+	{
+		g_warning (g_module_error());
+		g_module_close (plugin->library);
+
+		return FALSE;
+	}
+
+	plugin->init (module);
+
+	return TRUE;
+}
+
+static void
+ephy_plugin_unload (GTypeModule *module)
+{
+	EphyPlugin *plugin = EPHY_PLUGIN (module);
+
+	plugin->exit();
+
+	g_module_close (plugin->library);
+
+	plugin->library = NULL;
+	plugin->init = NULL;
+	plugin->exit = NULL;
+}
+
+static void
+ephy_plugin_class_init (EphyPluginClass *class)
+{
+	GTypeModuleClass *plugin_class;
+	GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+	object_class->finalize = ephy_plugin_finalize;
+
+	parent_class = g_type_class_peek_parent (class);
+	plugin_class = G_TYPE_MODULE_CLASS (class);
+
+	plugin_class->load = ephy_plugin_load;
+	plugin_class->unload = ephy_plugin_unload;
+}
+
+static void
+ephy_plugin_init (EphyPlugin *action)
+{
+}
+
+static void
+ephy_plugin_finalize (GObject *object)
+{
+	g_return_if_fail (EPHY_IS_PLUGIN (object));
+
+	G_OBJECT_CLASS (parent_class)->finalize (object);
+}
diff --git a/src/ephy-plugin.h b/src/ephy-plugin.h
new file mode 100644
index 000000000..243cfdb6a
--- /dev/null
+++ b/src/ephy-plugin.h
@@ -0,0 +1,37 @@
+/*
+ *  Copyright (C) 2003 Marco Pesenti Gritti
+ *
+ *  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, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#ifndef EPHY_PLUGIN_H
+#define EPHY_PLUGIN_H
+
+#include <glib-object.h>
+
+#define EPHY_TYPE_PLUGIN            (ephy_plugin_get_type ())
+#define EPHY_PLUGIN(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), EPHY_TYPE_PLUGIN, EphyPlugin))
+#define EPHY_PLUGIN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), EPHY_TYPE_PLUGIN, EphyPluginClass))
+#define EPHY_IS_PLUGIN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EPHY_TYPE_PLUGIN))
+#define EPHY_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), EPHY_TYPE_PLUGIN))
+#define EPHY_PLUGIN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), EPHY_TYPE_PLUGIN, EphyPluginClass))
+
+typedef struct _EphyPlugin      EphyPlugin;
+
+GType       ephy_plugin_get_type   (void);
+
+EphyPlugin *ephy_plugin_new        (const char *name);
+
+#endif
diff --git a/src/ephy-shell.c b/src/ephy-shell.c
index ab53ae065..3a0d43b0e 100644
--- a/src/ephy-shell.c
+++ b/src/ephy-shell.c
@@ -34,6 +34,7 @@
 #include "ephy-bookmarks-editor.h"
 #include "ephy-history-window.h"
 #include "ephy-debug.h"
+#include "ephy-plugin.h"
 #include "toolbar.h"
 
 #include <string.h>
@@ -43,6 +44,7 @@
 #include <gtk/gtksignal.h>
 #include <gtk/gtkmain.h>
 #include <gtk/gtkmessagedialog.h>
+#include <dirent.h>
 
 #ifdef ENABLE_NAUTILUS_VIEW
 
@@ -61,6 +63,7 @@ struct EphyShellPrivate
 	EphyToolbarsModel *toolbars_model;
 	GtkWidget *bme;
 	GtkWidget *history_window;
+	GList *plugins;
 };
 
 static void
@@ -146,6 +149,39 @@ ephy_shell_new_window_cb (EphyEmbedShell *shell,
 }
 
 static void
+ephy_shell_load_plugins (EphyShell *es)
+{
+	DIR *d;
+	struct dirent *e;
+
+	d = opendir (PLUGINS_DIR);
+
+	if (d == NULL)
+	{
+		return;
+	}
+
+	while ((e = readdir (d)) != NULL)
+	{
+		char *plugin;
+
+		plugin = g_strconcat (PLUGINS_DIR"/", e->d_name, NULL);
+
+		if (g_str_has_suffix (plugin, ".so"))
+		{
+			EphyPlugin *obj;
+
+			obj = ephy_plugin_new (plugin);
+			es->priv->plugins = g_list_append
+				(es->priv->plugins, obj);
+		}
+
+		g_free (plugin);
+	}
+	closedir (d);
+}
+
+static void
 ephy_shell_init (EphyShell *gs)
 {
 	EphyEmbedSingle *single;
@@ -157,6 +193,7 @@ ephy_shell_init (EphyShell *gs)
 	gs->priv->bme = NULL;
 	gs->priv->history_window = NULL;
 	gs->priv->toolbars_model = NULL;
+	gs->priv->plugins = NULL;
 
 	ephy_shell = gs;
 	g_object_add_weak_pointer (G_OBJECT(ephy_shell),
@@ -195,6 +232,8 @@ ephy_shell_init (EphyShell *gs)
 
 		exit (0);
 	}
+
+	ephy_shell_load_plugins (gs);
 }
 
 static void
@@ -211,6 +250,9 @@ ephy_shell_finalize (GObject *object)
 
 	g_assert (ephy_shell == NULL);
 
+	g_list_foreach (gs->priv->plugins, (GFunc)g_type_module_unuse, NULL);
+	g_list_free (gs->priv->plugins);
+
 	LOG ("Unref toolbars model")
 	if (gs->priv->toolbars_model)
 	{