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, 273 insertions, 0 deletions

diff --git a/e-util/e-menu-tool-button.c b/e-util/e-menu-tool-button.c
new file mode 100644
index 0000000000..c2a68d0c05
--- /dev/null
+++ b/e-util/e-menu-tool-button.c
@@ -0,0 +1,273 @@
+/*
+ * e-menu-tool-button.c
+ *
+ * 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/>
+ *
+ *
+ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include "e-menu-tool-button.h"
+
+#define E_MENU_TOOL_BUTTON_GET_PRIVATE(obj) \
+	(G_TYPE_INSTANCE_GET_PRIVATE \
+	((obj), E_TYPE_MENU_TOOL_BUTTON, EMenuToolButtonPrivate))
+
+struct _EMenuToolButtonPrivate {
+	gchar *prefer_item;
+};
+
+enum {
+	PROP_0,
+	PROP_PREFER_ITEM
+};
+
+G_DEFINE_TYPE (
+	EMenuToolButton,
+	e_menu_tool_button,
+	GTK_TYPE_MENU_TOOL_BUTTON)
+
+static GtkWidget *
+menu_tool_button_clone_image (GtkWidget *source)
+{
+	GtkIconSize size;
+	GtkImageType image_type;
+	const gchar *icon_name;
+
+	/* XXX This isn't general purpose because it requires that the
+	 *     source image be using a named icon.  Somewhat surprised
+	 *     GTK+ doesn't offer something like this. */
+	image_type = gtk_image_get_storage_type (GTK_IMAGE (source));
+	g_return_val_if_fail (image_type == GTK_IMAGE_ICON_NAME, NULL);
+	gtk_image_get_icon_name (GTK_IMAGE (source), &icon_name, &size);
+
+	return gtk_image_new_from_icon_name (icon_name, size);
+}
+
+static GtkMenuItem *
+menu_tool_button_get_prefer_menu_item (GtkMenuToolButton *menu_tool_button)
+{
+	GtkWidget *menu;
+	GtkMenuItem *item = NULL;
+	GList *children;
+	const gchar *prefer_item;
+
+	menu = gtk_menu_tool_button_get_menu (menu_tool_button);
+	if (!GTK_IS_MENU (menu))
+		return NULL;
+
+	children = gtk_container_get_children (GTK_CONTAINER (menu));
+	if (children == NULL)
+		return NULL;
+
+	prefer_item = e_menu_tool_button_get_prefer_item (
+		E_MENU_TOOL_BUTTON (menu_tool_button));
+	if (prefer_item != NULL && *prefer_item != '\0') {
+		GtkAction *action;
+		GList *iter;
+
+		for (iter = children; iter != NULL; iter = iter->next) {
+			item = GTK_MENU_ITEM (iter->data);
+
+			if (!item)
+				continue;
+
+			action = gtk_activatable_get_related_action (
+				GTK_ACTIVATABLE (item));
+			if (action && g_strcmp0 (gtk_action_get_name (action), prefer_item) == 0)
+				break;
+			else if (!action && g_strcmp0 (gtk_widget_get_name (GTK_WIDGET (item)), prefer_item) == 0)
+				break;
+
+			item = NULL;
+		}
+	}
+
+	if (!item)
+		item = GTK_MENU_ITEM (children->data);
+
+	g_list_free (children);
+
+	return item;
+}
+
+static void
+menu_tool_button_update_button (GtkToolButton *tool_button)
+{
+	GtkMenuItem *menu_item;
+	GtkMenuToolButton *menu_tool_button;
+	GtkImageMenuItem *image_menu_item;
+	GtkAction *action;
+	GtkWidget *image;
+	gchar *tooltip = NULL;
+
+	menu_tool_button = GTK_MENU_TOOL_BUTTON (tool_button);
+	menu_item = menu_tool_button_get_prefer_menu_item (menu_tool_button);
+	if (!GTK_IS_IMAGE_MENU_ITEM (menu_item))
+		return;
+
+	image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
+	image = gtk_image_menu_item_get_image (image_menu_item);
+	if (!GTK_IS_IMAGE (image))
+		return;
+
+	image = menu_tool_button_clone_image (image);
+	gtk_tool_button_set_icon_widget (tool_button, image);
+	gtk_widget_show (image);
+
+	/* If the menu item is a proxy for a GtkAction, extract
+	 * the action's tooltip and use it as our own tooltip. */
+	action = gtk_activatable_get_related_action (
+		GTK_ACTIVATABLE (menu_item));
+	if (action != NULL)
+		g_object_get (action, "tooltip", &tooltip, NULL);
+	gtk_widget_set_tooltip_text (GTK_WIDGET (tool_button), tooltip);
+	g_free (tooltip);
+}
+
+static void
+menu_tool_button_clicked (GtkToolButton *tool_button)
+{
+	GtkMenuItem *menu_item;
+	GtkMenuToolButton *menu_tool_button;
+
+	menu_tool_button = GTK_MENU_TOOL_BUTTON (tool_button);
+	menu_item = menu_tool_button_get_prefer_menu_item (menu_tool_button);
+
+	if (GTK_IS_MENU_ITEM (menu_item))
+		gtk_menu_item_activate (menu_item);
+}
+
+static void
+menu_tool_button_set_property (GObject *object,
+                               guint property_id,
+                               const GValue *value,
+                               GParamSpec *pspec)
+{
+	switch (property_id) {
+		case PROP_PREFER_ITEM:
+			e_menu_tool_button_set_prefer_item (
+				E_MENU_TOOL_BUTTON (object),
+				g_value_get_string (value));
+			return;
+	}
+
+	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+}
+
+static void
+menu_tool_button_get_property (GObject *object,
+                               guint property_id,
+                               GValue *value,
+                               GParamSpec *pspec)
+{
+	switch (property_id) {
+		case PROP_PREFER_ITEM:
+			g_value_set_string (
+				value, e_menu_tool_button_get_prefer_item (
+				E_MENU_TOOL_BUTTON (object)));
+			return;
+	}
+
+	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+}
+
+static void
+menu_tool_button_dispose (GObject *object)
+{
+	EMenuToolButtonPrivate *priv = E_MENU_TOOL_BUTTON (object)->priv;
+
+	if (priv->prefer_item) {
+		g_free (priv->prefer_item);
+		priv->prefer_item = NULL;
+	}
+
+	/* Chain up to parent's dispose() method. */
+	G_OBJECT_CLASS (e_menu_tool_button_parent_class)->dispose (object);
+}
+
+static void
+e_menu_tool_button_class_init (EMenuToolButtonClass *class)
+{
+	GObjectClass *object_class;
+	GtkToolButtonClass *tool_button_class;
+
+	g_type_class_add_private (class, sizeof (EMenuToolButtonPrivate));
+
+	object_class = G_OBJECT_CLASS (class);
+	object_class->set_property = menu_tool_button_set_property;
+	object_class->get_property = menu_tool_button_get_property;
+	object_class->dispose = menu_tool_button_dispose;
+
+	tool_button_class = GTK_TOOL_BUTTON_CLASS (class);
+	tool_button_class->clicked = menu_tool_button_clicked;
+
+	g_object_class_install_property (
+		object_class,
+		PROP_PREFER_ITEM,
+		g_param_spec_string (
+			"prefer-item",
+			"Prefer Item",
+			"Name of an item to show instead of the first",
+			NULL,
+			G_PARAM_READWRITE));
+}
+
+static void
+e_menu_tool_button_init (EMenuToolButton *button)
+{
+	button->priv = E_MENU_TOOL_BUTTON_GET_PRIVATE (button);
+
+	button->priv->prefer_item = NULL;
+
+	g_signal_connect (
+		button, "notify::menu",
+		G_CALLBACK (menu_tool_button_update_button), NULL);
+}
+
+GtkToolItem *
+e_menu_tool_button_new (const gchar *label)
+{
+	return g_object_new (E_TYPE_MENU_TOOL_BUTTON, "label", label, NULL);
+}
+
+void
+e_menu_tool_button_set_prefer_item (EMenuToolButton *button,
+                                    const gchar *prefer_item)
+{
+	g_return_if_fail (button != NULL);
+	g_return_if_fail (E_IS_MENU_TOOL_BUTTON (button));
+
+	if (g_strcmp0 (button->priv->prefer_item, prefer_item) == 0)
+		return;
+
+	g_free (button->priv->prefer_item);
+	button->priv->prefer_item = g_strdup (prefer_item);
+
+	g_object_notify (G_OBJECT (button), "prefer-item");
+}
+
+const gchar *
+e_menu_tool_button_get_prefer_item (EMenuToolButton *button)
+{
+	g_return_val_if_fail (button != NULL, NULL);
+	g_return_val_if_fail (E_IS_MENU_TOOL_BUTTON (button), NULL);
+
+	return button->priv->prefer_item;
+}