* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * SECTION:gis-plugin
+ * @short_description: Plugin support
+ *
+ * A plugin in libgis is a GObject which implements the GisPlugin interface. Additionally, each
+ * plugin is compiled to a separate shared object and loaded conditionally at runtime when the
+ * plugin is enabled. Each such shared object should define a GisPluginConstructor() function named
+ * gis_plugin_NAME_new which will be called when loading the plugin.
+ *
+ * Almost all libgis functionality is provided by a set of plugins. Each plugin can how however much
+ * it likes. The interface between plugins and the rest of libgis is intentionally very thin. Since
+ * libgis is the library, plugins must manually do everything. For instance, to draw something in
+ * the world, the plugin must add an object to the viewer. Likewise, plugins need to register
+ * callbacks on the viewer in order to receive updates, very little happens automagically.
+ *
+ * That being said, one thing that plugins do do automagically, is provide a configuration area.
+ * Since the plugin doesn't know what application is is being loaded form, it is better for the
+ * application to ask the plugin for it's confirmation area, not the other way around.
+ */
+
#include <glib.h>
#include <gmodule.h>
+#include <string.h>
+
#include "gis-plugin.h"
/********************
return type;
}
-const gchar *gis_plugin_get_name(GisPlugin *self)
+/**
+ * gis_plugin_get_name:
+ * @plugin: the plugin
+ *
+ * Get a short human readable name for a plugin, this is not necessarily the
+ * same as the name of the shared object.
+ *
+ * Returns: a short name for the plugin
+ */
+const gchar *gis_plugin_get_name(GisPlugin *plugin)
{
- if (!GIS_IS_PLUGIN(self))
+ if (!GIS_IS_PLUGIN(plugin))
return NULL;
- return GIS_PLUGIN_GET_INTERFACE(self)->name;
+ return GIS_PLUGIN_GET_INTERFACE(plugin)->name;
}
-const gchar *gis_plugin_get_description(GisPlugin *self)
+/**
+ * gis_plugin_get_description:
+ * @plugin: the plugin
+ *
+ * Get a description of a plugin
+ *
+ * Returns: a description of the plugin
+ */
+const gchar *gis_plugin_get_description(GisPlugin *plugin)
{
- if (!GIS_IS_PLUGIN(self))
+ if (!GIS_IS_PLUGIN(plugin))
return NULL;
- return GIS_PLUGIN_GET_INTERFACE(self)->description;
+ return GIS_PLUGIN_GET_INTERFACE(plugin)->description;
}
-GtkWidget *gis_plugin_get_config(GisPlugin *self)
+/**
+ * gis_plugin_get_config:
+ * @plugin: the plugin
+ *
+ * Each plugin can provide a configuration area. Applications using libgis
+ * should display this configuration area to the user so they can modify the
+ * behavior of the plugin.
+ *
+ * Returns: a configuration widget for the plugin
+ */
+GtkWidget *gis_plugin_get_config(GisPlugin *plugin)
{
- if (!GIS_IS_PLUGIN(self))
+ if (!GIS_IS_PLUGIN(plugin))
return NULL;
- GisPluginInterface *iface = GIS_PLUGIN_GET_INTERFACE(self);
- return iface->get_config ? iface->get_config(self) : NULL;
+ GisPluginInterface *iface = GIS_PLUGIN_GET_INTERFACE(plugin);
+ return iface->get_config ? iface->get_config(plugin) : NULL;
}
GisPlugin *plugin;
} GisPluginStore;
+/**
+ * gis_plugins_new:
+ * @dir: the directory to search for plugins in
+ * @prefs: a #GisPrefs to save the state of plugins, or NULL
+ *
+ * Create a new plugin source. If @prefs is not %NULL, the state of the plugins
+ * will be saved when they are either enabled or disabled.
+ *
+ * Returns: the new plugin source
+ */
GisPlugins *gis_plugins_new(const gchar *dir, GisPrefs *prefs)
{
g_debug("GisPlugins: new - dir=%s", dir);
- GisPlugins *self = g_new0(GisPlugins, 1);
- self->prefs = prefs;
+ GisPlugins *plugins = g_new0(GisPlugins, 1);
+ plugins->prefs = prefs;
if (dir)
- self->dir = g_strdup(dir);
- return self;
+ plugins->dir = g_strdup(dir);
+ return plugins;
}
-void gis_plugins_free(GisPlugins *self)
+/**
+ * gis_plugins_free:
+ * @plugins: the #GisPlugins to free
+ *
+ * Free data used by a plugin source
+ */
+void gis_plugins_free(GisPlugins *plugins)
{
g_debug("GisPlugins: free");
- for (GList *cur = self->plugins; cur; cur = cur->next) {
+ for (GList *cur = plugins->plugins; cur; cur = cur->next) {
GisPluginStore *store = cur->data;
g_debug("GisPlugin: freeing %s refs=%d->%d", store->name,
G_OBJECT(store->plugin)->ref_count,
g_free(store->name);
g_free(store);
}
- g_list_free(self->plugins);
- if (self->dir)
- g_free(self->dir);
- g_free(self);
+ g_list_free(plugins->plugins);
+ if (plugins->dir)
+ g_free(plugins->dir);
+ g_free(plugins);
}
-GList *gis_plugins_available(GisPlugins *self)
+/**
+ * gis_plugins_available:
+ * @plugins: the plugin source
+ *
+ * Search the plugin directory for shared objects which can be loaded as
+ * plugins.
+ *
+ * Returns: the list of available plugins
+ */
+GList *gis_plugins_available(GisPlugins *plugins)
{
g_debug("GisPlugins: available");
GList *list = NULL;
- gchar *dirs[] = {self->dir, PLUGINSDIR};
+ gchar *dirs[] = {plugins->dir, PLUGINSDIR};
g_debug("pluginsdir=%s", PLUGINSDIR);
for (int i = 0; i<2; i++) {
if (dirs[i] == NULL)
g_strfreev(parts);
}
}
+ g_dir_close(dir);
}
+ list = g_list_sort(list, (GCompareFunc)strcmp);
+ for (GList *cur = list; cur; cur = cur->next)
+ while (cur->next && g_str_equal(cur->data,cur->next->data)) {
+ GList *tmp = cur->next;
+ list = g_list_remove_link(list, cur);
+ cur = tmp;
+ }
return list;
}
-GisPlugin *gis_plugins_load(GisPlugins *self, const char *name,
+/**
+ * gis_plugins_load:
+ * @plugins: the plugins source
+ * @name: the name of the plugin to load
+ * @viewer: a #GisViewer to pass to the plugins constructor
+ * @prefs: a #GisPrefs to pass to the plugins constructor
+ *
+ * @name should be the name of the shared object without the file extension.
+ * This is the same as what is returned by gis_plugins_available().
+ *
+ * When loading plugins, the @prefs argument is used, not the #GisPrefs stored
+ * in @plugins.
+ *
+ * Returns: the new plugin
+ */
+GisPlugin *gis_plugins_load(GisPlugins *plugins, const char *name,
GisViewer *viewer, GisPrefs *prefs)
{
g_debug("GisPlugins: load %s", name);
- gchar *path = g_strdup_printf("%s/%s.%s", self->dir, name, G_MODULE_SUFFIX);
+ gchar *path = g_strdup_printf("%s/%s.%s", plugins->dir, name, G_MODULE_SUFFIX);
g_debug("GisPlugins: load - trying %s", path);
if (!g_file_test(path, G_FILE_TEST_EXISTS)) {
g_free(path);
GisPluginStore *store = g_new0(GisPluginStore, 1);
store->name = g_strdup(name);
store->plugin = constructor(viewer, prefs);
- self->plugins = g_list_prepend(self->plugins, store);
+ plugins->plugins = g_list_prepend(plugins->plugins, store);
return store->plugin;
}
-GisPlugin *gis_plugins_enable(GisPlugins *self, const char *name,
+/**
+ * gis_plugins_enable:
+ * @plugins: the plugins source
+ * @name: the name of the plugin to load
+ * @viewer: a #GisViewer to pass to the plugins constructor
+ * @prefs: a #GisPrefs to pass to the plugins constructor
+ *
+ * Load a plugin and save it's loaded/unloaded state in the #GisPrefs stored in
+ * #plugins.
+ *
+ * See also: gis_plugins_load()
+ *
+ * Returns: the new plugin
+ */
+GisPlugin *gis_plugins_enable(GisPlugins *plugins, const char *name,
GisViewer *viewer, GisPrefs *prefs)
{
- GisPlugin *plugin = gis_plugins_load(self, name, viewer, prefs);
- gis_prefs_set_boolean_v(self->prefs, "plugins", name, TRUE);
+ GisPlugin *plugin = gis_plugins_load(plugins, name, viewer, prefs);
+ gis_prefs_set_boolean_v(plugins->prefs, "plugins", name, TRUE);
return plugin;
}
-GList *gis_plugins_load_enabled(GisPlugins *self,
+/**
+ * gis_plugins_load_enabled:
+ * @plugins: the plugins source
+ * @viewer: a #GisViewer to pass to the plugins constructor
+ * @prefs: a #GisPrefs to pass to the plugins constructor
+ *
+ * Load all enabled which have previously been enabled.
+ *
+ * See also: gis_plugins_load()
+ *
+ * Returns: a list of all loaded plugins
+ */
+GList *gis_plugins_load_enabled(GisPlugins *plugins,
GisViewer *viewer, GisPrefs *prefs)
{
GList *loaded = NULL;
- for (GList *cur = gis_plugins_available(self); cur; cur = cur->next) {
+ for (GList *cur = gis_plugins_available(plugins); cur; cur = cur->next) {
gchar *name = cur->data;
- if (gis_prefs_get_boolean_v(self->prefs, "plugins", name, NULL)) {
- GisPlugin *plugin = gis_plugins_load(self, name, viewer, prefs);
+ if (gis_prefs_get_boolean_v(plugins->prefs, "plugins", name, NULL)) {
+ GisPlugin *plugin = gis_plugins_load(plugins, name, viewer, prefs);
loaded = g_list_prepend(loaded, plugin);
}
}
return loaded;
}
-gboolean gis_plugins_unload(GisPlugins *self, const char *name)
+/**
+ * gis_plugins_unload:
+ * @plugins: the plugins source
+ * @name: the name of the plugin to unload
+ *
+ * Unload a plugin and free any associated data.
+ *
+ * Returns: %FALSE
+ */
+gboolean gis_plugins_unload(GisPlugins *plugins, const char *name)
{
g_debug("GisPlugins: unload %s", name);
- for (GList *cur = self->plugins; cur; cur = cur->next) {
+ for (GList *cur = plugins->plugins; cur; cur = cur->next) {
GisPluginStore *store = cur->data;
if (g_str_equal(store->name, name)) {
g_object_unref(store->plugin);
g_free(store->name);
g_free(store);
- self->plugins = g_list_delete_link(self->plugins, cur);
+ plugins->plugins = g_list_delete_link(plugins->plugins, cur);
}
}
return FALSE;
}
-gboolean gis_plugins_disable(GisPlugins *self, const char *name)
+/**
+ * gis_plugins_disable:
+ * @plugins: the plugins source
+ * @name: the name of the plugin to unload
+ *
+ * Unload a plugin and save it's loaded/unloaded state in the #GisPrefs stored
+ * in #plugins.
+ *
+ * See also: gis_plugins_unload()
+ *
+ * Returns: %FALSE
+ */
+gboolean gis_plugins_disable(GisPlugins *plugins, const char *name)
{
- gis_prefs_set_boolean_v(self->prefs, "plugins", name, FALSE);
- gis_plugins_unload(self, name);
+ gis_prefs_set_boolean_v(plugins->prefs, "plugins", name, FALSE);
+ gis_plugins_unload(plugins, name);
return FALSE;
}
-void gis_plugins_foreach(GisPlugins *self, GCallback _callback, gpointer user_data)
+/**
+ * gis_plugins_foreach:
+ * @plugins: the plugins source
+ * @callback: a function to call on each plugin
+ * @user_data: user data to pass to the function
+ *
+ * Iterate over all plugins loaded by the plugins source
+ */
+void gis_plugins_foreach(GisPlugins *plugins, GCallback _callback, gpointer user_data)
{
g_debug("GisPlugins: foreach");
- if (self == NULL)
+ if (plugins == NULL)
return;
typedef void (*CBFunc)(GisPlugin *, const gchar *, gpointer);
CBFunc callback = (CBFunc)_callback;
- for (GList *cur = self->plugins; cur; cur = cur->next) {
+ for (GList *cur = plugins->plugins; cur; cur = cur->next) {
GisPluginStore *store = cur->data;
callback(store->plugin, store->name, user_data);
}
projects / grits / blobdiff