Implemented an Evolution::Activity interface for keeping track of

background tasks.  The Activity interface is added to the shell, and
the status of the various tasks is now displayed in a task bar widget
at the bottom of the EShellView.

I also implemented a simple test component to test all this stuff.

svn path=/trunk/; revision=10434

1 files changed, 459 insertions, 0 deletions

diff --git a/shell/e-activity-handler.c b/shell/e-activity-handler.c
new file mode 100644
index 0000000000..4ae3e0ccde
--- /dev/null
+++ b/shell/e-activity-handler.c
@@ -0,0 +1,459 @@
+/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
+/* e-activity-handler.c
+ *
+ * Copyright (C) 2001  Ximian, Inc.
+ *
+ * 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.
+ *
+ * Author: Ettore Perazzoli <ettore@ximian.com>
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include "e-activity-handler.h"
+
+#include <gtk/gtksignal.h>
+#include <gdk-pixbuf/gdk-pixbuf.h>
+
+#include <gal/util/e-util.h>
+
+
+#define PARENT_TYPE bonobo_x_object_get_type ()
+static BonoboXObjectClass *parent_class = NULL;
+
+
+#define ICON_SIZE 16
+
+
+struct _ActivityInfo {
+	GdkPixbuf *icon_pixbuf;
+	GNOME_Evolution_Activity_ActivityID id;
+	CORBA_char *information;
+	CORBA_boolean cancellable;
+	Bonobo_Listener event_listener;
+	CORBA_float progress;
+};
+typedef struct _ActivityInfo ActivityInfo;
+
+struct _EActivityHandlerPrivate {
+	GNOME_Evolution_Activity_ActivityID next_activity_id;
+	GList *activity_infos;
+	GSList *task_bars;
+};
+
+
+/* Utility functions.  */
+
+static GdkPixbuf *
+create_gdk_pixbuf_from_corba_icon (const GNOME_Evolution_Icon *icon)
+{
+	GdkPixbuf *pixbuf;
+	GdkPixbuf *scaled_pixbuf;
+	unsigned char *p;
+	int src_offset;
+	int i, j;
+	int rowstride;
+	int total_width;
+
+	pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, icon->hasAlpha, 8, icon->width, icon->height);
+
+	if (icon->hasAlpha)
+		total_width = 4 * icon->width;
+	else
+		total_width = 3 * icon->width;
+
+	rowstride = gdk_pixbuf_get_rowstride (pixbuf);
+	src_offset = 0;
+	p = gdk_pixbuf_get_pixels (pixbuf);
+
+	for (i = 0; i < icon->height; i++) {
+		for (j = 0; j < total_width; j++)
+			p[j] = icon->rgba_data._buffer[src_offset ++];
+		p += rowstride;
+	}
+
+	if (icon->width == ICON_SIZE && icon->height == ICON_SIZE)
+		return pixbuf;
+		
+	scaled_pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, icon->hasAlpha, 8, ICON_SIZE, ICON_SIZE);
+	gdk_pixbuf_scale (pixbuf, scaled_pixbuf,
+			  0, 0, ICON_SIZE, ICON_SIZE,
+			  0, 0, (double) ICON_SIZE / icon->width, (double) ICON_SIZE / icon->height,
+			  GDK_INTERP_HYPER);
+
+	gdk_pixbuf_unref (pixbuf);
+
+	return scaled_pixbuf;
+}
+
+static unsigned int
+get_new_activity_id (EActivityHandler *activity_handler)
+{
+	EActivityHandlerPrivate *priv;
+
+	priv = activity_handler->priv;
+
+	return priv->next_activity_id ++;
+}
+
+static GList *
+lookup_activity (GList *list,
+		 GNOME_Evolution_Activity_ActivityID activity_id,
+		 int *order_number_return)
+{
+	GList *p;
+	int i;
+
+	for (p = list, i = 0; p != NULL; p = p->next, i ++) {
+		ActivityInfo *activity_info;
+
+		activity_info = (ActivityInfo *) p->data;
+		if (activity_info->id == activity_id) {
+			*order_number_return = i;
+			return p;
+		}
+	}
+
+	*order_number_return = -1;
+	return NULL;
+}
+
+
+/* Creating and destroying ActivityInfos.  */
+
+static ActivityInfo *
+activity_info_new (GNOME_Evolution_Activity_ActivityID id,
+		   GdkPixbuf *icon,
+		   const CORBA_char *information,
+		   CORBA_boolean cancellable,
+		   const Bonobo_Listener event_listener)
+{
+	ActivityInfo *info;
+	CORBA_Environment ev;
+
+	CORBA_exception_init (&ev);
+
+	info = g_new (ActivityInfo, 1);
+	info->id             = id;
+	info->icon_pixbuf    = gdk_pixbuf_ref (icon);
+	info->information    = CORBA_string_dup (information);
+	info->cancellable    = cancellable;
+	info->event_listener = CORBA_Object_duplicate (event_listener, &ev);
+	info->progress       = -1.0; /* (Unknown) */
+
+	CORBA_exception_free (&ev);
+
+	return info;
+}
+
+static void
+activity_info_free (ActivityInfo *info)
+{
+	CORBA_Environment ev;
+
+	CORBA_exception_init (&ev);
+
+	CORBA_free (info->information);
+	CORBA_Object_release (info->event_listener, &ev);
+
+	g_free (info);
+
+	CORBA_exception_free (&ev);
+}
+
+static ETaskWidget *
+task_widget_new_from_activity_info (ActivityInfo *activity_info)
+{
+	GtkWidget *widget;
+
+	widget = e_task_widget_new (activity_info->icon_pixbuf, activity_info->information);
+	gtk_widget_show (widget);
+
+	return E_TASK_WIDGET (widget);
+}
+
+
+/* Task Bar handling.  */
+
+static void
+setup_task_bar (EActivityHandler *activity_handler,
+		ETaskBar *task_bar)
+{
+	EActivityHandlerPrivate *priv;
+	GList *p;
+
+	priv = activity_handler->priv;
+
+	for (p = g_list_last (priv->activity_infos); p != NULL; p = p->prev) {
+		e_task_bar_prepend_task (task_bar,
+					 task_widget_new_from_activity_info ((ActivityInfo *) p->data));
+	}
+}
+
+static void
+task_bar_destroy_callback (GtkObject *task_bar_object,
+			   void *data)
+{
+	ETaskBar *task_bar;
+	EActivityHandler *activity_handler;
+	EActivityHandlerPrivate *priv;
+
+	task_bar = E_TASK_BAR (task_bar_object);
+
+	activity_handler = E_ACTIVITY_HANDLER (data);
+	priv = activity_handler->priv;
+
+	priv->task_bars = g_slist_remove (priv->task_bars, task_bar);
+}
+
+
+/* GtkObject methods.  */
+
+static void
+impl_destroy (GtkObject *object)
+{
+	EActivityHandler *handler;
+	EActivityHandlerPrivate *priv;
+	GList *p;
+
+	handler = E_ACTIVITY_HANDLER (object);
+	priv = handler->priv;
+
+	for (p = priv->activity_infos; p != NULL; p = p->next) {
+		ActivityInfo *info;
+
+		info = (ActivityInfo *) p->data;
+		activity_info_free (info);
+	}
+
+	g_free (priv);
+
+	(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
+}
+
+
+/* CORBA methods.  */
+
+static void
+impl_operationStarted (PortableServer_Servant servant,
+		       const CORBA_char *component_id,
+		       const GNOME_Evolution_AnimatedIcon *icon,
+		       const CORBA_char *information,
+		       const CORBA_boolean cancellable,
+		       const Bonobo_Listener event_listener,
+		       GNOME_Evolution_Activity_ActivityID *activity_id_return,
+		       CORBA_boolean *suggest_display_return,
+		       CORBA_Environment *ev)
+{
+	EActivityHandler *activity_handler;
+	EActivityHandlerPrivate *priv;
+	ActivityInfo *activity_info;
+	GdkPixbuf *icon_pixbuf;
+	unsigned int activity_id;
+	GSList *p;
+
+	activity_handler = E_ACTIVITY_HANDLER (bonobo_object_from_servant (servant));
+	priv = activity_handler->priv;
+
+	if (icon->_length == 0) {
+		CORBA_exception_set (ev, CORBA_USER_EXCEPTION,
+				     ex_GNOME_Evolution_Activity_InvalidIcon, NULL);
+		return;
+	}
+
+	if (icon->_length > 1)
+		g_warning ("Animated icons are not supported for activities (yet).");
+
+	icon_pixbuf = create_gdk_pixbuf_from_corba_icon (icon->_buffer);
+
+	activity_id = get_new_activity_id (activity_handler);
+
+	activity_info = activity_info_new (activity_id, icon_pixbuf, information, cancellable, event_listener);
+
+	for (p = priv->task_bars; p != NULL; p = p->next)
+		e_task_bar_prepend_task (E_TASK_BAR (p->data),
+					 task_widget_new_from_activity_info (activity_info));
+
+	priv->activity_infos = g_list_prepend (priv->activity_infos, activity_info);
+
+	*activity_id_return = activity_id;
+}
+
+static void
+impl_operationProgressing (PortableServer_Servant servant,
+			   const GNOME_Evolution_Activity_ActivityID activity_id,
+			   const CORBA_char *information,
+			   const CORBA_float progress,
+			   CORBA_Environment *ev)
+{
+	EActivityHandler *activity_handler;
+	EActivityHandlerPrivate *priv;
+	ActivityInfo *activity_info;
+	GList *p;
+	GSList *sp;
+	int order_number;
+
+	/* FIXME?  The complexity in this function sucks.  */
+
+	activity_handler = E_ACTIVITY_HANDLER (bonobo_object_from_servant (servant));
+	priv = activity_handler->priv;
+
+	p = lookup_activity (priv->activity_infos, activity_id, &order_number);
+	if (p == NULL) {
+		CORBA_exception_set (ev, CORBA_USER_EXCEPTION,
+				     ex_GNOME_Evolution_Activity_IdNotFound, NULL);
+		return;
+	}
+
+	activity_info = (ActivityInfo *) p->data;
+
+	CORBA_free (activity_info->information);
+	activity_info->information = CORBA_string_dup (information);
+
+	activity_info->progress = progress;
+
+	for (sp = priv->task_bars; sp != NULL; sp = sp->next) {
+		ETaskBar *task_bar;
+		ETaskWidget *task_widget;
+
+		task_bar = E_TASK_BAR (sp->data);
+		task_widget = e_task_bar_get_task_widget (task_bar, order_number);
+
+		e_task_widget_update (task_widget, information, progress);
+	}
+}
+
+static void
+impl_operationFinished (PortableServer_Servant servant,
+			const GNOME_Evolution_Activity_ActivityID activity_id,
+			CORBA_Environment *ev)
+{
+	EActivityHandler *activity_handler;
+	EActivityHandlerPrivate *priv;
+	GList *p;
+	GSList *sp;
+	int order_number;
+
+	activity_handler = E_ACTIVITY_HANDLER (bonobo_object_from_servant (servant));
+	priv = activity_handler->priv;
+
+	p = lookup_activity (priv->activity_infos, activity_id, &order_number);
+
+	activity_info_free ((ActivityInfo *) p->data);
+	priv->activity_infos = g_list_remove_link (priv->activity_infos, p);
+
+	for (sp = priv->task_bars; sp != NULL; sp = sp->next) {
+		ETaskBar *task_bar;
+
+		task_bar = E_TASK_BAR (sp->data);
+		e_task_bar_remove_task (task_bar, order_number);
+	}
+}
+
+static GNOME_Evolution_Activity_DialogAction
+impl_requestDialog (PortableServer_Servant servant,
+		    const GNOME_Evolution_Activity_ActivityID activity_id,
+		    const GNOME_Evolution_Activity_DialogType dialog_type,
+		    CORBA_Environment *ev)
+{
+	/* FIXME implement.  */
+	g_warning ("Evolution::Activity::requestDialog not implemented");
+
+	return GNOME_Evolution_Activity_DIALOG_ACTION_DISPLAY;
+}
+
+
+/* GTK+ type stuff.  */
+
+static void
+class_init (GtkObjectClass *object_class)
+{
+	EActivityHandlerClass *handler_class;
+
+	parent_class = gtk_type_class (PARENT_TYPE);
+
+	object_class->destroy = impl_destroy;
+
+	handler_class = E_ACTIVITY_HANDLER_CLASS (object_class);
+	handler_class->epv.operationStarted     = impl_operationStarted;
+	handler_class->epv.operationProgressing = impl_operationProgressing;
+	handler_class->epv.operationFinished    = impl_operationFinished;
+	handler_class->epv.requestDialog        = impl_requestDialog;
+}
+
+static void
+init (EActivityHandler *activity_handler)
+{
+	EActivityHandlerPrivate *priv;
+
+	priv = g_new (EActivityHandlerPrivate, 1);
+	priv->next_activity_id = 0;
+	priv->activity_infos   = NULL;
+	priv->task_bars        = NULL;
+
+	activity_handler->priv = priv;
+}
+
+
+void
+e_activity_handler_construct (EActivityHandler *activity_handler)
+{
+	g_return_if_fail (activity_handler != NULL);
+	g_return_if_fail (E_IS_ACTIVITY_HANDLER (activity_handler));
+
+	/* Nothing to do here.  */
+}
+
+EActivityHandler *
+e_activity_handler_new (void)
+{
+	EActivityHandler *activity_handler;
+
+	activity_handler = gtk_type_new (e_activity_handler_get_type ());
+	e_activity_handler_construct (activity_handler);
+
+	return activity_handler;
+}
+
+
+void
+e_activity_handler_attach_task_bar (EActivityHandler *activity_handler,
+				    ETaskBar *task_bar)
+{
+	EActivityHandlerPrivate *priv;
+
+	g_return_if_fail (activity_handler != NULL);
+	g_return_if_fail (E_IS_ACTIVITY_HANDLER (activity_handler));
+	g_return_if_fail (task_bar != NULL);
+	g_return_if_fail (E_IS_TASK_BAR (task_bar));
+
+	priv = activity_handler->priv;
+
+	gtk_signal_connect_while_alive (GTK_OBJECT (task_bar), "destroy",
+					GTK_SIGNAL_FUNC (task_bar_destroy_callback), activity_handler,
+					GTK_OBJECT (activity_handler));
+
+	priv->task_bars = g_slist_prepend (priv->task_bars, task_bar);
+
+	setup_task_bar (activity_handler, task_bar);
+}
+
+
+E_MAKE_X_TYPE (e_activity_handler, "EActivityHandler", EActivityHandler, class_init, init, PARENT_TYPE,
+	       POA_GNOME_Evolution_Activity__init,
+	       GTK_STRUCT_OFFSET (EActivityHandlerClass, epv))