Move gromit annotation support into a new plugin. (Closes #428290)

2007-04-26  Jan Arne Petersen  <jpetersen@jpetersen.org>

	* configure.in:
	* src/Makefile.am:
	* src/plugins/gromit/Makefile.am:
	* src/plugins/gromit/gromit.totem-plugin.in:
	* src/plugins/gromit/totem-gromit.c:
	(totem_gromit_plugin_class_init), (totem_gromit_plugin_init),
	(totem_gromit_plugin_finalize), (totem_gromit_available),
	(totem_gromit_exit), (totem_gromit_timeout_cb),
	(totem_gromit_toggle), (totem_gromit_clear),
	(on_window_key_press_event), (impl_activate), (impl_deactivate):
	* src/totem-gromit.c:
	* src/totem-gromit.h:
	* src/totem.c: (totem_action_exit),
	(totem_action_handle_key_press): Move gromit annotation support into a
	new plugin. (Closes #428290)


svn path=/trunk/; revision=4271

3 files changed, 360 insertions, 0 deletions

diff --git a/src/plugins/gromit/Makefile.am b/src/plugins/gromit/Makefile.am
new file mode 100644
index 000000000..fabad1f8a
--- /dev/null
+++ b/src/plugins/gromit/Makefile.am
@@ -0,0 +1,41 @@
+modules_flags = -export_dynamic -avoid-version -module
+
+plugindir = $(PLUGINDIR)/gromit
+plugin_LTLIBRARIES = libgromit.la
+
+plugin_in_files = gromit.totem-plugin.in
+
+%.totem-plugin: %.totem-plugin.in $(INTLTOOL_MERGE) $(wildcard $(top_srcdir)/po/*po) ; $(INTLTOOL_MERGE) $(top_srcdir)/po $< $@ -d -u -c $(top_builddir)/po/.intltool-merge-cache
+
+plugin_DATA = $(plugin_in_files:.totem-plugin.in=.totem-plugin)
+
+common_defines = \
+	-D_REENTRANT					\
+	-DDBUS_API_SUBJECT_TO_CHANGE			\
+	-DGNOMELOCALEDIR=\""$(datadir)/locale"\"	\
+	-DGCONF_PREFIX=\""/apps/totem"\"		\
+	-DDATADIR=\""$(datadir)"\"			\
+	-DLIBEXECDIR=\""$(libexecdir)"\"		\
+	-DBINDIR=\""$(bindir)"\"			\
+	-DTOTEM_PLUGIN_DIR=\""$(libdir)/totem/plugins"\"\
+	$(DISABLE_DEPRECATED)
+
+libgromit_la_SOURCES = totem-gromit.c
+libgromit_la_LDFLAGS = $(modules_flags)
+libgromit_la_LIBADD = 
+libgromit_la_CPPFLAGS = $(common_defines)
+
+libgromit_la_CFLAGS = \
+	$(EXTRA_GNOME_CFLAGS)	\
+	$(WARN_CFLAGS)		\
+	$(DBUS_CFLAGS)		\
+	$(AM_CFLAGS)		\
+	-I$(top_srcdir)/lib	\
+	-I$(top_srcdir)/src	\
+	-I$(top_srcdir)/src/plugins
+
+EXTRA_DIST = $(plugin_in_files)
+
+CLEANFILES = $(plugin_DATA) $(BUILT_SOURCES)
+DISTCLEANFILES = $(plugin_DATA)
+
diff --git a/src/plugins/gromit/gromit.totem-plugin.in b/src/plugins/gromit/gromit.totem-plugin.in
new file mode 100644
index 000000000..16659bc5d
--- /dev/null
+++ b/src/plugins/gromit/gromit.totem-plugin.in
@@ -0,0 +1,8 @@
+[Totem Plugin]
+Module=gromit
+IAge=1
+_Name=Gromit Annotations
+_Description=Presentation helper to make annotations on screen
+Authors=Bastien Nocera, Jan Arne Petersen
+Copyright=Copyright © 2007 Bastien Nocera, Jan Arne Petersen
+Website=http://www.gnome.org/projects/totem/
diff --git a/src/plugins/gromit/totem-gromit.c b/src/plugins/gromit/totem-gromit.c
new file mode 100644
index 000000000..e34c7bab1
--- /dev/null
+++ b/src/plugins/gromit/totem-gromit.c
@@ -0,0 +1,311 @@
+/*
+ *  Copyright (C) 2004 Bastien Nocera <hadess@hadess.net>
+ *		  2007 Jan Arne Petersen <jpetersen@jpetersen.org>
+ *
+ *  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.
+ *
+ * The Totem project hereby grant permission for non-gpl compatible GStreamer
+ * plugins to be used and distributed together with GStreamer and Totem. This
+ * permission are above and beyond the permissions granted by the GPL license
+ * Totem is covered by.
+ *
+ * Monday 7th February 2005: Christian Schaller: Add excemption clause.
+ * See license_change file for details.
+ *
+ */
+
+#include <config.h>
+
+#include <glib.h>
+#include <glib-object.h>
+#include <glib/gi18n-lib.h>
+#include <gmodule.h>
+#include <string.h>
+
+#include <sys/types.h>
+#include <signal.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#include <gdk/gdkkeysyms.h>
+
+#include "totem-plugin.h"
+#include "totem.h"
+
+#include "totem-interface.h"
+
+#define TOTEM_TYPE_GROMIT_PLUGIN		(totem_gromit_plugin_get_type ())
+#define TOTEM_GROMIT_PLUGIN(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), TOTEM_TYPE_GROMIT_PLUGIN, TotemGromitPlugin))
+#define TOTEM_GROMIT_PLUGIN_CLASS(k)		(G_TYPE_CHECK_CLASS_CAST((k), TOTEM_TYPE_GROMIT_PLUGIN, TotemGromitPluginClass))
+#define TOTEM_IS_GROMIT_PLUGIN(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), TOTEM_TYPE_GROMIT_PLUGIN))
+#define TOTEM_IS_GROMIT_PLUGIN_CLASS(k)		(G_TYPE_CHECK_CLASS_TYPE ((k), TOTEM_TYPE_GROMIT_PLUGIN))
+#define TOTEM_GROMIT_PLUGIN_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), TOTEM_TYPE_GROMIT_PLUGIN, TotemGromitPluginClass))
+
+typedef struct
+{
+	TotemPlugin   parent;
+
+	char *path;
+	int id;
+	GPid pid;
+
+	gulong handler_id;
+} TotemGromitPlugin;
+
+typedef struct
+{
+	TotemPluginClass parent_class;
+} TotemGromitPluginClass;
+
+#define INTERVAL 10000
+
+static const char *start_cmd[] =	{ NULL, "-a", "-k", "none", NULL };
+static const char *toggle_cmd[] =	{ NULL, "-t", NULL };
+static const char *clear_cmd[] =	{ NULL, "-c", NULL };
+static const char *visibility_cmd[] =	{ NULL, "-v", NULL };
+/* no quit command, we just kill the process */
+
+#define DEFAULT_CONFIG							\
+"#Default gromit configuration for Totem's telestrator mode		\n\
+\"red Pen\" = PEN (size=5 color=\"red\");				\n\
+\"blue Pen\" = \"red Pen\" (color=\"blue\");				\n\
+\"yellow Pen\" = \"red Pen\" (color=\"yellow\");			\n\
+\"green Marker\" = PEN (size=6 color=\"green\" arrowsize=1);		\n\
+									\n\
+\"Eraser\" = ERASER (size = 100);					\n\
+									\n\
+\"Core Pointer\" = \"red Pen\";						\n\
+\"Core Pointer\"[SHIFT] = \"blue Pen\";					\n\
+\"Core Pointer\"[CONTROL] = \"yellow Pen\";				\n\
+\"Core Pointer\"[2] = \"green Marker\";					\n\
+\"Core Pointer\"[Button3] = \"Eraser\";					\n\
+\n"
+
+G_MODULE_EXPORT GType register_totem_plugin	(GTypeModule *module);
+GType	totem_gromit_plugin_get_type		(void) G_GNUC_CONST;
+
+static void totem_gromit_plugin_init		(TotemGromitPlugin *plugin);
+static void totem_gromit_plugin_finalize		(GObject *object);
+static gboolean impl_activate			(TotemPlugin *plugin, TotemObject *totem, GError **error);
+static void impl_deactivate			(TotemPlugin *plugin, TotemObject *totem);
+
+TOTEM_PLUGIN_REGISTER(TotemGromitPlugin, totem_gromit_plugin)
+
+static void
+totem_gromit_plugin_class_init (TotemGromitPluginClass *klass)
+{
+	GObjectClass *object_class = G_OBJECT_CLASS (klass);
+	TotemPluginClass *plugin_class = TOTEM_PLUGIN_CLASS (klass);
+
+	object_class->finalize = totem_gromit_plugin_finalize;
+
+	plugin_class->activate = impl_activate;
+	plugin_class->deactivate = impl_deactivate;
+}
+
+static void
+totem_gromit_plugin_init (TotemGromitPlugin *plugin)
+{
+	plugin->id = -1;
+	plugin->pid = -1;
+}
+
+static void
+totem_gromit_plugin_finalize (GObject *object)
+{
+	TotemGromitPlugin *plugin = TOTEM_GROMIT_PLUGIN (object);
+
+	if (plugin->path != NULL) {
+		g_free (plugin->path);
+		plugin->path = NULL;
+	}
+
+	G_OBJECT_CLASS (totem_gromit_plugin_parent_class)->finalize (object);
+}
+
+static void
+totem_gromit_ensure_config_file (void)
+{
+	char *path;
+	int fd;
+
+	path = g_build_filename (g_get_home_dir (), ".gromitrc", NULL);
+	if (g_file_test (path, G_FILE_TEST_EXISTS) != FALSE) {
+		g_free (path);
+		return;
+	}
+
+	g_message ("%s doesn't exist", path);
+
+	fd = creat (path, 0755);
+	g_free (path);
+	if (fd < 0) {
+		return;
+	}
+
+	write (fd, DEFAULT_CONFIG, sizeof (DEFAULT_CONFIG));
+	close (fd);
+}
+
+static gboolean
+totem_gromit_available (TotemGromitPlugin *plugin)
+{
+	plugin->path = g_find_program_in_path ("gromit");
+
+	if (plugin->path == NULL) {
+		return FALSE;
+	}
+
+	start_cmd[0] = toggle_cmd[0] = clear_cmd[0] = visibility_cmd[0] = plugin->path;
+	totem_gromit_ensure_config_file ();
+
+	return TRUE;
+}
+
+static void
+launch (const char **cmd)
+{
+	g_spawn_sync (NULL, (char **)cmd, NULL, 0, NULL, NULL,
+			NULL, NULL, NULL, NULL);
+}
+
+static void
+totem_gromit_exit (TotemGromitPlugin *plugin)
+{
+	/* Nothing to do */
+	if (plugin->pid == -1) {
+		if (plugin->id != -1) {
+			g_source_remove (plugin->id);
+			plugin->id = -1;
+		}
+		return;
+	}
+
+	kill ((pid_t) plugin->pid, SIGKILL);
+	plugin->pid = -1;
+}
+
+static gboolean
+totem_gromit_timeout_cb (gpointer data)
+{
+	TotemGromitPlugin *plugin = TOTEM_GROMIT_PLUGIN (data);
+
+	plugin->id = -1;
+	totem_gromit_exit (plugin);
+	return FALSE;
+}
+
+static void
+totem_gromit_toggle (TotemGromitPlugin *plugin)
+{
+	/* Not started */
+	if (plugin->pid == -1) {
+		if (g_spawn_async (NULL,
+				(char **)start_cmd, NULL, 0, NULL, NULL,
+				&plugin->pid, NULL) == FALSE) {
+			g_printerr ("Couldn't start gromit");
+			return;
+		}
+	} else if (plugin->id == -1) { /* Started but disabled */
+		g_source_remove (plugin->id);
+		plugin->id = -1;
+		launch (toggle_cmd);
+	} else {
+		/* Started and visible */
+		g_source_remove (plugin->id);
+		plugin->id = -1;
+		launch (toggle_cmd);
+	}
+}
+
+static void
+totem_gromit_clear (TotemGromitPlugin *plugin, gboolean now)
+{
+	if (now != FALSE) {
+		totem_gromit_exit (plugin);
+		return;
+	}
+
+	launch (visibility_cmd);
+	launch (clear_cmd);
+	plugin->id = g_timeout_add (INTERVAL, totem_gromit_timeout_cb, plugin);
+}
+
+static gboolean
+on_window_key_press_event (GtkWidget *window, GdkEventKey *event, TotemGromitPlugin *plugin)
+{
+	if (event->state != 0
+			&& ((event->state & GDK_CONTROL_MASK)
+				|| (event->state & GDK_MOD1_MASK)
+				|| (event->state & GDK_MOD3_MASK)
+				|| (event->state & GDK_MOD4_MASK)
+				|| (event->state & GDK_MOD5_MASK)))
+		return FALSE;
+
+	switch (event->keyval) {
+		case GDK_D:
+		case GDK_d:
+			totem_gromit_toggle (plugin);
+			break;
+		case GDK_E:
+		case GDK_e:
+			totem_gromit_clear (plugin, FALSE);
+			break;
+		default:
+			return FALSE;
+	}
+
+	return TRUE;
+}
+
+static gboolean
+impl_activate (TotemPlugin *plugin,
+	       TotemObject *totem,
+	       GError **error)
+{
+	TotemGromitPlugin *pi = TOTEM_GROMIT_PLUGIN (plugin);
+	GtkWindow *window;
+
+	if (!totem_gromit_available (pi)) {
+		g_set_error (error, TOTEM_PLUGIN_ERROR, TOTEM_PLUGIN_ERROR_ACTIVATION,
+				_("The gromit binary was not found."));
+
+		return FALSE;
+	}
+
+	window = totem_get_main_window (totem);
+	pi->handler_id = g_signal_connect (G_OBJECT(window), "key-press-event", 
+			G_CALLBACK (on_window_key_press_event), plugin);
+	g_object_unref (window);
+
+	return TRUE;
+}
+
+static void
+impl_deactivate	(TotemPlugin *plugin,
+		 TotemObject *totem)
+{
+	TotemGromitPlugin *pi = TOTEM_GROMIT_PLUGIN (plugin);
+	GtkWindow *window;
+
+	if (pi->handler_id != 0) {
+		window = totem_get_main_window (totem);
+		g_signal_handler_disconnect (G_OBJECT(window), pi->handler_id);
+		pi->handler_id = 0;
+		g_object_unref (window);
+	}
+
+	totem_gromit_clear (pi, TRUE);
+}