xed/plugins/modelines/xed-modeline-plugin.c

/*
 * xed-modeline-plugin.c
 * Emacs, Kate and Vim-style modelines support for xed.
 *
 * Copyright (C) 2005-2007 - Steve Frécinaux <code@istique.net>
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifdef HAVE_CONFIG_H
#	include <config.h>
#endif

#include <glib/gi18n-lib.h>
#include <gmodule.h>
#include <libpeas/peas-activatable.h>
#include "xed-modeline-plugin.h"
#include "modeline-parser.h"

#include <xed/xed-window.h>
#include <xed/xed-debug.h>
#include <xed/xed-utils.h>

#define DOCUMENT_DATA_KEY "XedModelinePluginDocumentData"

struct _XedModelinePluginPrivate
{
    GtkWidget *window;

	gulong tab_added_handler_id;
	gulong tab_removed_handler_id;
};

typedef struct
{
	gulong document_loaded_handler_id;
	gulong document_saved_handler_id;
} DocumentData;

enum
{
    PROP_0,
    PROP_OBJECT
};

static void peas_activatable_iface_init (PeasActivatableInterface *iface);

G_DEFINE_DYNAMIC_TYPE_EXTENDED (XedModelinePlugin,
                                xed_modeline_plugin,
                                PEAS_TYPE_EXTENSION_BASE,
                                0,
                                G_IMPLEMENT_INTERFACE_DYNAMIC (PEAS_TYPE_ACTIVATABLE,
                                                               peas_activatable_iface_init))

static void
document_data_free (DocumentData *ddata)
{
	g_slice_free (DocumentData, ddata);
}

static void
xed_modeline_plugin_constructed (GObject *object)
{
	gchar *data_dir;

	data_dir = peas_extension_base_get_data_dir (PEAS_EXTENSION_BASE (object));

	modeline_parser_init (data_dir);

	g_free (data_dir);

	G_OBJECT_CLASS (xed_modeline_plugin_parent_class)->constructed (object);
}

static void
xed_modeline_plugin_init (XedModelinePlugin *plugin)
{
	xed_debug_message (DEBUG_PLUGINS, "XedModelinePlugin initializing");

    plugin->priv = G_TYPE_INSTANCE_GET_PRIVATE (plugin,
                                                XED_TYPE_MODELINE_PLUGIN,
                                                XedModelinePluginPrivate);
}

static void
xed_modeline_plugin_finalize (GObject *object)
{
	xed_debug_message (DEBUG_PLUGINS, "XedModelinePlugin finalizing");

	modeline_parser_shutdown ();

	G_OBJECT_CLASS (xed_modeline_plugin_parent_class)->finalize (object);
}

static void
xed_modeline_plugin_dispose (GObject *object)
{
    XedModelinePlugin *plugin = XED_MODELINE_PLUGIN (object);

    xed_debug_message (DEBUG_PLUGINS, "XedModelinePlugin disposing");

    if (plugin->priv->window != NULL)
    {
        g_object_unref (plugin->priv->window);
        plugin->priv->window = NULL;
    }

    G_OBJECT_CLASS (xed_modeline_plugin_parent_class)->dispose (object);
}

static void
xed_modeline_plugin_set_property (GObject      *object,
                                  guint         prop_id,
                                  const GValue *value,
                                  GParamSpec   *pspec)
{
    XedModelinePlugin *plugin = XED_MODELINE_PLUGIN (object);

    switch (prop_id)
    {
        case PROP_OBJECT:
            plugin->priv->window = GTK_WIDGET (g_value_dup_object (value));
            break;
        default:
            G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
            break;
    }
}

static void
xed_modeline_plugin_get_property (GObject    *object,
                                  guint       prop_id,
                                  GValue     *value,
                                  GParamSpec *pspec)
{
    XedModelinePlugin *plugin = XED_MODELINE_PLUGIN (object);

    switch (prop_id)
    {
        case PROP_OBJECT:
            g_value_set_object (value, plugin->priv->window);
            break;
        default:
            G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
            break;
    }
}

static void
on_document_loaded_or_saved (XedDocument *document,
			     const GError  *error,
			     GtkSourceView *view)
{
	modeline_parser_apply_modeline (view);
}

static void
connect_handlers (XedView *view)
{
	DocumentData *data;
        GtkTextBuffer *doc;

        doc = gtk_text_view_get_buffer (GTK_TEXT_VIEW (view));

        data = g_slice_new (DocumentData);

	data->document_loaded_handler_id =
		g_signal_connect (doc, "loaded",
				  G_CALLBACK (on_document_loaded_or_saved),
				  view);
	data->document_saved_handler_id =
		g_signal_connect (doc, "saved",
				  G_CALLBACK (on_document_loaded_or_saved),
				  view);

	g_object_set_data_full (G_OBJECT (doc), DOCUMENT_DATA_KEY,
				data, (GDestroyNotify) document_data_free);
}

static void
disconnect_handlers (XedView *view)
{
	DocumentData *data;
	GtkTextBuffer *doc;

	doc = gtk_text_view_get_buffer (GTK_TEXT_VIEW (view));

	data = g_object_steal_data (G_OBJECT (doc), DOCUMENT_DATA_KEY);

	if (data)
	{
		g_signal_handler_disconnect (doc, data->document_loaded_handler_id);
		g_signal_handler_disconnect (doc, data->document_saved_handler_id);

		document_data_free (data);
	}
	else
	{
		g_warning ("Modeline handlers not found");
	}
}

static void
on_window_tab_added (XedWindow *window,
		     XedTab *tab,
		     gpointer user_data)
{
	connect_handlers (xed_tab_get_view (tab));
}

static void
on_window_tab_removed (XedWindow *window,
		       XedTab *tab,
		       gpointer user_data)
{
	disconnect_handlers (xed_tab_get_view (tab));
}

static void
xed_modeline_plugin_activate (PeasActivatable *activatable)
{
	XedModelinePluginPrivate *data;
    XedWindow *window;
	GList *views;
	GList *l;

	xed_debug (DEBUG_PLUGINS);

    data = XED_MODELINE_PLUGIN (activatable)->priv;
    window = XED_WINDOW (data->window);

	views = xed_window_get_views (window);
	for (l = views; l != NULL; l = l->next)
	{
		connect_handlers (XED_VIEW (l->data));
		modeline_parser_apply_modeline (GTK_SOURCE_VIEW (l->data));
	}
	g_list_free (views);

    data->tab_added_handler_id =
		g_signal_connect (window, "tab-added",
				  G_CALLBACK (on_window_tab_added), NULL);

	data->tab_removed_handler_id =
		g_signal_connect (window, "tab-removed",
				  G_CALLBACK (on_window_tab_removed), NULL);
}

static void
xed_modeline_plugin_deactivate (PeasActivatable *activatable)
{
	XedModelinePluginPrivate *data;
    XedWindow *window;
	GList *views;
	GList *l;

	xed_debug (DEBUG_PLUGINS);

	data = XED_MODELINE_PLUGIN (activatable)->priv;
    window = XED_WINDOW (data->window);

	g_signal_handler_disconnect (window, data->tab_added_handler_id);
    g_signal_handler_disconnect (window, data->tab_removed_handler_id);

	views = xed_window_get_views (window);

	for (l = views; l != NULL; l = l->next)
	{
		disconnect_handlers (XED_VIEW (l->data));

		modeline_parser_deactivate (GTK_SOURCE_VIEW (l->data));
	}

	g_list_free (views);
}

static void
xed_modeline_plugin_class_init (XedModelinePluginClass *klass)
{
    GObjectClass *object_class = G_OBJECT_CLASS (klass);

    object_class->constructed = xed_modeline_plugin_constructed;
    object_class->finalize = xed_modeline_plugin_finalize;
    object_class->dispose = xed_modeline_plugin_dispose;
    object_class->set_property = xed_modeline_plugin_set_property;
    object_class->get_property = xed_modeline_plugin_get_property;

    g_object_class_override_property (object_class, PROP_OBJECT, "object");

    g_type_class_add_private (klass, sizeof (XedModelinePluginPrivate));
}

static void
xed_modeline_plugin_class_finalize (XedModelinePluginClass *klass)
{
   /* dummy function - used by G_DEFINE_DYNAMIC_TYPE_EXTENDED */
}

static void
peas_activatable_iface_init (PeasActivatableInterface *iface)
{
   iface->activate = xed_modeline_plugin_activate;
   iface->deactivate = xed_modeline_plugin_deactivate;
}

G_MODULE_EXPORT void
peas_register_types (PeasObjectModule *module)
{
   xed_modeline_plugin_register_type (G_TYPE_MODULE (module));

   peas_object_module_register_extension_type (module,
                                               PEAS_TYPE_ACTIVATABLE,
                                               XED_TYPE_MODELINE_PLUGIN);
}