diff options
Diffstat (limited to 'gedit/gedit-plugin.c')
| -rwxr-xr-x | gedit/gedit-plugin.c | 334 |
1 files changed, 334 insertions, 0 deletions
diff --git a/gedit/gedit-plugin.c b/gedit/gedit-plugin.c new file mode 100755 index 00000000..2b00e3fd --- /dev/null +++ b/gedit/gedit-plugin.c @@ -0,0 +1,334 @@ +/* + * gedit-plugin.h + * This file is part of gedit + * + * Copyright (C) 2002-2005 Paolo Maggi + * + * 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., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +/* + * Modified by the gedit Team, 2002-2005. See the AUTHORS file for a + * list of people on the gedit Team. + * See the ChangeLog files for a list of changes. + * + * $Id$ + */ + +#ifdef HAVE_CONFIG_H +#include <config.h> +#endif + +#include "gedit-plugin.h" +#include "gedit-dirs.h" + +/* properties */ +enum { + PROP_0, + PROP_INSTALL_DIR, + PROP_DATA_DIR_NAME, + PROP_DATA_DIR +}; + +typedef struct _GeditPluginPrivate GeditPluginPrivate; + +struct _GeditPluginPrivate +{ + gchar *install_dir; + gchar *data_dir_name; +}; + +#define GEDIT_PLUGIN_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), GEDIT_TYPE_PLUGIN, GeditPluginPrivate)) + +G_DEFINE_TYPE(GeditPlugin, gedit_plugin, G_TYPE_OBJECT) + +static void +dummy (GeditPlugin *plugin, GeditWindow *window) +{ + /* Empty */ +} + +static GtkWidget * +create_configure_dialog (GeditPlugin *plugin) +{ + return NULL; +} + +static gboolean +is_configurable (GeditPlugin *plugin) +{ + return (GEDIT_PLUGIN_GET_CLASS (plugin)->create_configure_dialog != + create_configure_dialog); +} + +static void +gedit_plugin_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + switch (prop_id) + { + case PROP_INSTALL_DIR: + g_value_take_string (value, gedit_plugin_get_install_dir (GEDIT_PLUGIN (object))); + break; + case PROP_DATA_DIR: + g_value_take_string (value, gedit_plugin_get_data_dir (GEDIT_PLUGIN (object))); + break; + default: + g_return_if_reached (); + } +} + +static void +gedit_plugin_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + GeditPluginPrivate *priv = GEDIT_PLUGIN_GET_PRIVATE (object); + + switch (prop_id) + { + case PROP_INSTALL_DIR: + priv->install_dir = g_value_dup_string (value); + break; + case PROP_DATA_DIR_NAME: + priv->data_dir_name = g_value_dup_string (value); + break; + default: + g_return_if_reached (); + } +} + +static void +gedit_plugin_finalize (GObject *object) +{ + GeditPluginPrivate *priv = GEDIT_PLUGIN_GET_PRIVATE (object); + + g_free (priv->install_dir); + g_free (priv->data_dir_name); + + G_OBJECT_CLASS (gedit_plugin_parent_class)->finalize (object); +} + +static void +gedit_plugin_class_init (GeditPluginClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + klass->activate = dummy; + klass->deactivate = dummy; + klass->update_ui = dummy; + + klass->create_configure_dialog = create_configure_dialog; + klass->is_configurable = is_configurable; + + object_class->get_property = gedit_plugin_get_property; + object_class->set_property = gedit_plugin_set_property; + object_class->finalize = gedit_plugin_finalize; + + g_object_class_install_property (object_class, + PROP_INSTALL_DIR, + g_param_spec_string ("install-dir", + "Install Directory", + "The directory where the plugin is installed", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + + /* the basename of the data dir is set at construction time by the plugin loader + * while the full path is constructed on the fly to take into account relocability + * that's why we have a writeonly prop and a readonly prop */ + g_object_class_install_property (object_class, + PROP_DATA_DIR_NAME, + g_param_spec_string ("data-dir-name", + "Basename of the data directory", + "The basename of the directory where the plugin should look for its data files", + NULL, + G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY)); + g_object_class_install_property (object_class, + PROP_DATA_DIR, + g_param_spec_string ("data-dir", + "Data Directory", + "The full path of the directory where the plugin should look for its data files", + NULL, + G_PARAM_READABLE)); + + g_type_class_add_private (klass, sizeof (GeditPluginPrivate)); +} + +static void +gedit_plugin_init (GeditPlugin *plugin) +{ + /* Empty */ +} + +/** + * gedit_plugin_get_install_dir: + * @plugin: a #GeditPlugin + * + * Get the path of the directory where the plugin is installed. + * + * Return value: a newly allocated string with the path of the + * directory where the plugin is installed + */ +gchar * +gedit_plugin_get_install_dir (GeditPlugin *plugin) +{ + g_return_val_if_fail (GEDIT_IS_PLUGIN (plugin), NULL); + + return g_strdup (GEDIT_PLUGIN_GET_PRIVATE (plugin)->install_dir); +} + +/** + * gedit_plugin_get_data_dir: + * @plugin: a #GeditPlugin + * + * Get the path of the directory where the plugin should look for + * its data files. + * + * Return value: a newly allocated string with the path of the + * directory where the plugin should look for its data files + */ +gchar * +gedit_plugin_get_data_dir (GeditPlugin *plugin) +{ + GeditPluginPrivate *priv; + gchar *gedit_lib_dir; + gchar *data_dir; + + g_return_val_if_fail (GEDIT_IS_PLUGIN (plugin), NULL); + + priv = GEDIT_PLUGIN_GET_PRIVATE (plugin); + + /* If it's a "user" plugin the data dir is + * install_dir/data_dir_name if instead it's a + * "system" plugin the data dir is under gedit_data_dir, + * so it's under $prefix/share/gedit-2/plugins/data_dir_name + * where data_dir_name usually it's the name of the plugin + */ + gedit_lib_dir = gedit_dirs_get_gedit_lib_dir (); + + /* CHECK: is checking the prefix enough or should we be more + * careful about normalizing paths etc? */ + if (g_str_has_prefix (priv->install_dir, gedit_lib_dir)) + { + gchar *gedit_data_dir; + + gedit_data_dir = gedit_dirs_get_gedit_data_dir (); + + data_dir = g_build_filename (gedit_data_dir, + "plugins", + priv->data_dir_name, + NULL); + + g_free (gedit_data_dir); + } + else + { + data_dir = g_build_filename (priv->install_dir, + priv->data_dir_name, + NULL); + } + + g_free (gedit_lib_dir); + + return data_dir; +} + +/** + * gedit_plugin_activate: + * @plugin: a #GeditPlugin + * @window: a #GeditWindow + * + * Activates the plugin. + */ +void +gedit_plugin_activate (GeditPlugin *plugin, + GeditWindow *window) +{ + g_return_if_fail (GEDIT_IS_PLUGIN (plugin)); + g_return_if_fail (GEDIT_IS_WINDOW (window)); + + GEDIT_PLUGIN_GET_CLASS (plugin)->activate (plugin, window); +} + +/** + * gedit_plugin_deactivate: + * @plugin: a #GeditPlugin + * @window: a #GeditWindow + * + * Deactivates the plugin. + */ +void +gedit_plugin_deactivate (GeditPlugin *plugin, + GeditWindow *window) +{ + g_return_if_fail (GEDIT_IS_PLUGIN (plugin)); + g_return_if_fail (GEDIT_IS_WINDOW (window)); + + GEDIT_PLUGIN_GET_CLASS (plugin)->deactivate (plugin, window); +} + +/** + * gedit_plugin_update_ui: + * @plugin: a #GeditPlugin + * @window: a #GeditWindow + * + * Triggers an update of the user interface to take into account state changes + * caused by the plugin. + */ +void +gedit_plugin_update_ui (GeditPlugin *plugin, + GeditWindow *window) +{ + g_return_if_fail (GEDIT_IS_PLUGIN (plugin)); + g_return_if_fail (GEDIT_IS_WINDOW (window)); + + GEDIT_PLUGIN_GET_CLASS (plugin)->update_ui (plugin, window); +} + +/** + * gedit_plugin_is_configurable: + * @plugin: a #GeditPlugin + * + * Whether the plugin is configurable. + * + * Returns: TRUE if the plugin is configurable: + */ +gboolean +gedit_plugin_is_configurable (GeditPlugin *plugin) +{ + g_return_val_if_fail (GEDIT_IS_PLUGIN (plugin), FALSE); + + return GEDIT_PLUGIN_GET_CLASS (plugin)->is_configurable (plugin); +} + +/** + * gedit_plugin_create_configure_dialog: + * @plugin: a #GeditPlugin + * + * Creates the configure dialog widget for the plugin. + * + * Returns: the configure dialog widget for the plugin. + */ +GtkWidget * +gedit_plugin_create_configure_dialog (GeditPlugin *plugin) +{ + g_return_val_if_fail (GEDIT_IS_PLUGIN (plugin), NULL); + + return GEDIT_PLUGIN_GET_CLASS (plugin)->create_configure_dialog (plugin); +} |