Consolidate base utility libraries into libeutil.

Evolution consists of entirely too many small utility libraries, which
increases linking and loading time, places a burden on higher layers of
the application (e.g. modules) which has to remember to link to all the
small in-tree utility libraries, and makes it difficult to generate API
documentation for these utility libraries in one Gtk-Doc module.

Merge the following utility libraries under the umbrella of libeutil,
and enforce a single-include policy on libeutil so we can reorganize
the files as desired without disrupting its pseudo-public API.

   libemail-utils/libemail-utils.la
   libevolution-utils/libevolution-utils.la
   filter/libfilter.la
   widgets/e-timezone-dialog/libetimezonedialog.la
   widgets/menus/libmenus.la
   widgets/misc/libemiscwidgets.la
   widgets/table/libetable.la
   widgets/text/libetext.la

This also merges libedataserverui from the Evolution-Data-Server module,
since Evolution is its only consumer nowadays, and I'd like to make some
improvements to those APIs without concern for backward-compatibility.

And finally, start a Gtk-Doc module for libeutil.  It's going to be a
project just getting all the symbols _listed_ much less _documented_.
But the skeletal structure is in place and I'm off to a good start.

1 files changed, 567 insertions, 0 deletions

diff --git a/e-util/e-table-subset.c b/e-util/e-table-subset.c
new file mode 100644
index 0000000000..88532d03bd
--- /dev/null
+++ b/e-util/e-table-subset.c
@@ -0,0 +1,567 @@
+/*
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) version 3.
+ *
+ * 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with the program; if not, see <http://www.gnu.org/licenses/>
+ *
+ *
+ * Authors:
+ *		Chris Lahey <clahey@ximian.com>
+ *		Miguel de Icaza <miguel@ximian.com>
+ *
+ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <stdlib.h>
+
+#include "e-table-subset.h"
+
+static void	etss_proxy_model_pre_change_real
+						(ETableSubset *etss,
+						 ETableModel *etm);
+static void	etss_proxy_model_no_change_real	(ETableSubset *etss,
+						 ETableModel *etm);
+static void	etss_proxy_model_changed_real	(ETableSubset *etss,
+						 ETableModel *etm);
+static void	etss_proxy_model_row_changed_real
+						(ETableSubset *etss,
+						 ETableModel *etm,
+						 gint row);
+static void	etss_proxy_model_cell_changed_real
+						(ETableSubset *etss,
+						 ETableModel *etm,
+						 gint col,
+						 gint row);
+static void	etss_proxy_model_rows_inserted_real
+						(ETableSubset *etss,
+						 ETableModel *etm,
+						 gint row,
+						 gint count);
+static void	etss_proxy_model_rows_deleted_real
+						(ETableSubset *etss,
+						 ETableModel *etm,
+						 gint row,
+						 gint count);
+
+#define d(x)
+
+/* workaround for avoding API breakage */
+#define etss_get_type e_table_subset_get_type
+G_DEFINE_TYPE (ETableSubset, etss, E_TYPE_TABLE_MODEL)
+
+#define ETSS_CLASS(object) (E_TABLE_SUBSET_GET_CLASS(object))
+
+#define VALID_ROW(etss, row) (row >= -1 && row < etss->n_map)
+#define MAP_ROW(etss, row) (row == -1 ? -1 : etss->map_table[row])
+
+static gint
+etss_get_view_row (ETableSubset *etss,
+                   gint row)
+{
+	const gint n = etss->n_map;
+	const gint * const map_table = etss->map_table;
+	gint i;
+
+	gint end = MIN (etss->n_map, etss->last_access + 10);
+	gint start = MAX (0, etss->last_access - 10);
+	gint initial = MAX (MIN (etss->last_access, end), start);
+
+	for (i = initial; i < end; i++) {
+		if (map_table[i] == row) {
+			d (g_print ("a) Found %d from %d\n", i, etss->last_access));
+			etss->last_access = i;
+			return i;
+		}
+	}
+
+	for (i = initial - 1; i >= start; i--) {
+		if (map_table[i] == row) {
+			d (g_print ("b) Found %d from %d\n", i, etss->last_access));
+			etss->last_access = i;
+			return i;
+		}
+	}
+
+	for (i = 0; i < n; i++) {
+		if (map_table[i] == row) {
+			d (g_print ("c) Found %d from %d\n", i, etss->last_access));
+			etss->last_access = i;
+			return i;
+		}
+	}
+	return -1;
+}
+
+static void
+etss_dispose (GObject *object)
+{
+	ETableSubset *etss = E_TABLE_SUBSET (object);
+
+	if (etss->source) {
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_pre_change_id);
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_no_change_id);
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_changed_id);
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_row_changed_id);
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_cell_changed_id);
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_rows_inserted_id);
+		g_signal_handler_disconnect (
+			etss->source,
+			etss->table_model_rows_deleted_id);
+
+		g_object_unref (etss->source);
+		etss->source = NULL;
+
+		etss->table_model_changed_id = 0;
+		etss->table_model_row_changed_id = 0;
+		etss->table_model_cell_changed_id = 0;
+		etss->table_model_rows_inserted_id = 0;
+		etss->table_model_rows_deleted_id = 0;
+	}
+
+	G_OBJECT_CLASS (etss_parent_class)->dispose (object);
+}
+
+static void
+etss_finalize (GObject *object)
+{
+	ETableSubset *etss = E_TABLE_SUBSET (object);
+
+	g_free (etss->map_table);
+	etss->map_table = NULL;
+
+	G_OBJECT_CLASS (etss_parent_class)->finalize (object);
+}
+
+static gint
+etss_column_count (ETableModel *etm)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	return e_table_model_column_count (etss->source);
+}
+
+static gint
+etss_row_count (ETableModel *etm)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	return etss->n_map;
+}
+
+static gpointer
+etss_value_at (ETableModel *etm,
+               gint col,
+               gint row)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	g_return_val_if_fail (VALID_ROW (etss, row), NULL);
+
+	etss->last_access = row;
+	d (g_print ("g) Setting last_access to %d\n", row));
+	return e_table_model_value_at (etss->source, col, MAP_ROW (etss, row));
+}
+
+static void
+etss_set_value_at (ETableModel *etm,
+                   gint col,
+                   gint row,
+                   gconstpointer val)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	g_return_if_fail (VALID_ROW (etss, row));
+
+	etss->last_access = row;
+	d (g_print ("h) Setting last_access to %d\n", row));
+	e_table_model_set_value_at (etss->source, col, MAP_ROW (etss, row), val);
+}
+
+static gboolean
+etss_is_cell_editable (ETableModel *etm,
+                       gint col,
+                       gint row)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	g_return_val_if_fail (VALID_ROW (etss, row), FALSE);
+
+	return e_table_model_is_cell_editable (etss->source, col, MAP_ROW (etss, row));
+}
+
+static gboolean
+etss_has_save_id (ETableModel *etm)
+{
+	return TRUE;
+}
+
+static gchar *
+etss_get_save_id (ETableModel *etm,
+                  gint row)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	g_return_val_if_fail (VALID_ROW (etss, row), NULL);
+
+	if (e_table_model_has_save_id (etss->source))
+		return e_table_model_get_save_id (etss->source, MAP_ROW (etss, row));
+	else
+		return g_strdup_printf ("%d", MAP_ROW (etss, row));
+}
+
+static void
+etss_append_row (ETableModel *etm,
+                 ETableModel *source,
+                 gint row)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+	e_table_model_append_row (etss->source, source, row);
+}
+
+static gpointer
+etss_duplicate_value (ETableModel *etm,
+                      gint col,
+                      gconstpointer value)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	return e_table_model_duplicate_value (etss->source, col, value);
+}
+
+static void
+etss_free_value (ETableModel *etm,
+                 gint col,
+                 gpointer value)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	e_table_model_free_value (etss->source, col, value);
+}
+
+static gpointer
+etss_initialize_value (ETableModel *etm,
+                       gint col)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	return e_table_model_initialize_value (etss->source, col);
+}
+
+static gboolean
+etss_value_is_empty (ETableModel *etm,
+                     gint col,
+                     gconstpointer value)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	return e_table_model_value_is_empty (etss->source, col, value);
+}
+
+static gchar *
+etss_value_to_string (ETableModel *etm,
+                      gint col,
+                      gconstpointer value)
+{
+	ETableSubset *etss = (ETableSubset *) etm;
+
+	return e_table_model_value_to_string (etss->source, col, value);
+}
+
+static void
+etss_class_init (ETableSubsetClass *class)
+{
+	ETableModelClass *table_class    = E_TABLE_MODEL_CLASS (class);
+	GObjectClass *object_class       = G_OBJECT_CLASS (class);
+
+	object_class->dispose            = etss_dispose;
+	object_class->finalize           = etss_finalize;
+
+	table_class->column_count        = etss_column_count;
+	table_class->row_count           = etss_row_count;
+	table_class->append_row          = etss_append_row;
+
+	table_class->value_at            = etss_value_at;
+	table_class->set_value_at        = etss_set_value_at;
+	table_class->is_cell_editable    = etss_is_cell_editable;
+
+	table_class->has_save_id         = etss_has_save_id;
+	table_class->get_save_id         = etss_get_save_id;
+
+	table_class->duplicate_value     = etss_duplicate_value;
+	table_class->free_value          = etss_free_value;
+	table_class->initialize_value    = etss_initialize_value;
+	table_class->value_is_empty      = etss_value_is_empty;
+	table_class->value_to_string     = etss_value_to_string;
+
+	class->proxy_model_pre_change    = etss_proxy_model_pre_change_real;
+	class->proxy_model_no_change     = etss_proxy_model_no_change_real;
+	class->proxy_model_changed       = etss_proxy_model_changed_real;
+	class->proxy_model_row_changed   = etss_proxy_model_row_changed_real;
+	class->proxy_model_cell_changed  = etss_proxy_model_cell_changed_real;
+	class->proxy_model_rows_inserted = etss_proxy_model_rows_inserted_real;
+	class->proxy_model_rows_deleted  = etss_proxy_model_rows_deleted_real;
+}
+
+static void
+etss_init (ETableSubset *etss)
+{
+	etss->last_access = 0;
+}
+
+static void
+etss_proxy_model_pre_change_real (ETableSubset *etss,
+                                  ETableModel *etm)
+{
+	e_table_model_pre_change (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_no_change_real (ETableSubset *etss,
+                                 ETableModel *etm)
+{
+	e_table_model_no_change (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_changed_real (ETableSubset *etss,
+                               ETableModel *etm)
+{
+	e_table_model_changed (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_row_changed_real (ETableSubset *etss,
+                                   ETableModel *etm,
+                                   gint row)
+{
+	gint view_row = etss_get_view_row (etss, row);
+	if (view_row != -1)
+		e_table_model_row_changed (E_TABLE_MODEL (etss), view_row);
+	else
+		e_table_model_no_change (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_cell_changed_real (ETableSubset *etss,
+                                    ETableModel *etm,
+                                    gint col,
+                                    gint row)
+{
+	gint view_row = etss_get_view_row (etss, row);
+	if (view_row != -1)
+		e_table_model_cell_changed (E_TABLE_MODEL (etss), col, view_row);
+	else
+		e_table_model_no_change (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_rows_inserted_real (ETableSubset *etss,
+                                     ETableModel *etm,
+                                     gint row,
+                                     gint count)
+{
+	e_table_model_no_change (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_rows_deleted_real (ETableSubset *etss,
+                                    ETableModel *etm,
+                                    gint row,
+                                    gint count)
+{
+	e_table_model_no_change (E_TABLE_MODEL (etss));
+}
+
+static void
+etss_proxy_model_pre_change (ETableModel *etm,
+                             ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_pre_change)
+		(ETSS_CLASS (etss)->proxy_model_pre_change) (etss, etm);
+}
+
+static void
+etss_proxy_model_no_change (ETableModel *etm,
+                            ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_no_change)
+		(ETSS_CLASS (etss)->proxy_model_no_change) (etss, etm);
+}
+
+static void
+etss_proxy_model_changed (ETableModel *etm,
+                          ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_changed)
+		(ETSS_CLASS (etss)->proxy_model_changed) (etss, etm);
+}
+
+static void
+etss_proxy_model_row_changed (ETableModel *etm,
+                              gint row,
+                              ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_row_changed)
+		(ETSS_CLASS (etss)->proxy_model_row_changed) (etss, etm, row);
+}
+
+static void
+etss_proxy_model_cell_changed (ETableModel *etm,
+                               gint col,
+                               gint row,
+                               ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_cell_changed)
+		(ETSS_CLASS (etss)->proxy_model_cell_changed) (etss, etm, col, row);
+}
+
+static void
+etss_proxy_model_rows_inserted (ETableModel *etm,
+                                gint row,
+                                gint col,
+                                ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_rows_inserted)
+		(ETSS_CLASS (etss)->proxy_model_rows_inserted) (etss, etm, row, col);
+}
+
+static void
+etss_proxy_model_rows_deleted (ETableModel *etm,
+                               gint row,
+                               gint col,
+                               ETableSubset *etss)
+{
+	if (ETSS_CLASS (etss)->proxy_model_rows_deleted)
+		(ETSS_CLASS (etss)->proxy_model_rows_deleted) (etss, etm, row, col);
+}
+
+ETableModel *
+e_table_subset_construct (ETableSubset *etss,
+                          ETableModel *source,
+                          gint nvals)
+{
+	guint *buffer;
+	gint i;
+
+	if (nvals) {
+		buffer = (guint *) g_malloc (sizeof (guint) * nvals);
+		if (buffer == NULL)
+			return NULL;
+	} else
+		buffer = NULL;
+	etss->map_table = (gint *) buffer;
+	etss->n_map = nvals;
+	etss->source = source;
+	g_object_ref (source);
+
+	/* Init */
+	for (i = 0; i < nvals; i++)
+		etss->map_table[i] = i;
+
+	etss->table_model_pre_change_id = g_signal_connect (
+		source, "model_pre_change",
+		G_CALLBACK (etss_proxy_model_pre_change), etss);
+	etss->table_model_no_change_id = g_signal_connect (
+		source, "model_no_change",
+		G_CALLBACK (etss_proxy_model_no_change), etss);
+	etss->table_model_changed_id = g_signal_connect (
+		source, "model_changed",
+		G_CALLBACK (etss_proxy_model_changed), etss);
+	etss->table_model_row_changed_id = g_signal_connect (
+		source, "model_row_changed",
+		G_CALLBACK (etss_proxy_model_row_changed), etss);
+	etss->table_model_cell_changed_id = g_signal_connect (
+		source, "model_cell_changed",
+		G_CALLBACK (etss_proxy_model_cell_changed), etss);
+	etss->table_model_rows_inserted_id = g_signal_connect (
+		source, "model_rows_inserted",
+		G_CALLBACK (etss_proxy_model_rows_inserted), etss);
+	etss->table_model_rows_deleted_id = g_signal_connect (
+		source, "model_rows_deleted",
+		G_CALLBACK (etss_proxy_model_rows_deleted), etss);
+
+	return E_TABLE_MODEL (etss);
+}
+
+ETableModel *
+e_table_subset_new (ETableModel *source,
+                    const gint nvals)
+{
+	ETableSubset *etss = g_object_new (E_TYPE_TABLE_SUBSET, NULL);
+
+	if (e_table_subset_construct (etss, source, nvals) == NULL) {
+		g_object_unref (etss);
+		return NULL;
+	}
+
+	return (ETableModel *) etss;
+}
+
+gint
+e_table_subset_model_to_view_row (ETableSubset *ets,
+                                  gint model_row)
+{
+	gint i;
+	for (i = 0; i < ets->n_map; i++) {
+		if (ets->map_table[i] == model_row)
+			return i;
+	}
+	return -1;
+}
+
+gint
+e_table_subset_view_to_model_row (ETableSubset *ets,
+                                  gint view_row)
+{
+	if (view_row >= 0 && view_row < ets->n_map)
+		return ets->map_table[view_row];
+	else
+		return -1;
+}
+
+ETableModel *
+e_table_subset_get_toplevel (ETableSubset *table)
+{
+	g_return_val_if_fail (table != NULL, NULL);
+	g_return_val_if_fail (E_IS_TABLE_SUBSET (table), NULL);
+
+	if (E_IS_TABLE_SUBSET (table->source))
+		return e_table_subset_get_toplevel (E_TABLE_SUBSET (table->source));
+	else
+		return table->source;
+}
+
+void
+e_table_subset_print_debugging (ETableSubset *table_model)
+{
+	gint i;
+	for (i = 0; i < table_model->n_map; i++) {
+		g_print ("%8d\n", table_model->map_table[i]);
+	}
+}