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

diff --git a/e-util/e-tree.h b/e-util/e-tree.h
new file mode 100644
index 0000000000..1d6243cc61
--- /dev/null
+++ b/e-util/e-tree.h
@@ -0,0 +1,376 @@
+/*
+ * 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>
+ *
+ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
+ *
+ */
+
+#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
+#error "Only <e-util/e-util.h> should be included directly."
+#endif
+
+#ifndef _E_TREE_H_
+#define _E_TREE_H_
+
+#include <gtk/gtk.h>
+#include <libxml/tree.h>
+#include <libgnomecanvas/libgnomecanvas.h>
+
+#include <e-util/e-printable.h>
+#include <e-util/e-table-extras.h>
+#include <e-util/e-table-item.h>
+#include <e-util/e-table-specification.h>
+#include <e-util/e-table-state.h>
+#include <e-util/e-tree-model.h>
+#include <e-util/e-tree-table-adapter.h>
+
+#define E_TREE_USE_TREE_SELECTION
+
+#ifdef E_TREE_USE_TREE_SELECTION
+#include <e-util/e-tree-selection-model.h>
+#endif
+
+/* Standard GObject macros */
+#define E_TYPE_TREE \
+	(e_tree_get_type ())
+#define E_TREE(obj) \
+	(G_TYPE_CHECK_INSTANCE_CAST \
+	((obj), E_TYPE_TREE, ETree))
+#define E_TREE_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_CAST \
+	((cls), E_TYPE_TREE, ETreeClass))
+#define E_IS_TREE(obj) \
+	(G_TYPE_CHECK_INSTANCE_TYPE \
+	((obj), E_TYPE_TREE))
+#define E_IS_TREE_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_TYPE \
+	((cls), E_TYPE_TREE))
+#define E_TREE_GET_CLASS(obj) \
+	(G_TYPE_INSTANCE_GET_CLASS \
+	((obj), E_TYPE_TREE))
+
+G_BEGIN_DECLS
+
+typedef struct _ETreeDragSourceSite ETreeDragSourceSite;
+
+typedef struct _ETree ETree;
+typedef struct _ETreeClass ETreeClass;
+typedef struct _ETreePrivate ETreePrivate;
+
+struct _ETree {
+	GtkTable parent;
+	ETreePrivate *priv;
+};
+
+struct _ETreeClass {
+	GtkTableClass parent_class;
+
+	void		(*cursor_change)	(ETree *et,
+						 gint row,
+						 ETreePath path);
+	void		(*cursor_activated)	(ETree *et,
+						 gint row,
+						 ETreePath path);
+	void		(*selection_change)	(ETree *et);
+	void		(*double_click)		(ETree *et,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*right_click)		(ETree *et,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*click)		(ETree *et,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*key_press)		(ETree *et,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*start_drag)		(ETree *et,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkEvent *event);
+	void		(*state_change)		(ETree *et);
+	gboolean	(*white_space_event)	(ETree *et,
+						 GdkEvent *event);
+
+	/* Source side drag signals */
+	void		(*tree_drag_begin)	(ETree	 *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context);
+	void		(*tree_drag_end)	(ETree	 *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context);
+	void		(*tree_drag_data_get)	(ETree *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context,
+						 GtkSelectionData *selection_data,
+						 guint info,
+						 guint time);
+	void		(*tree_drag_data_delete)
+						(ETree	 *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context);
+
+	/* Target side drag signals */
+	void		(*tree_drag_leave)	(ETree	 *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context,
+						 guint time);
+	gboolean	(*tree_drag_motion)	(ETree	 *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context,
+						 gint x,
+						 gint y,
+						 guint time);
+	gboolean	(*tree_drag_drop)	(ETree	 *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context,
+						 gint x,
+						 gint y,
+						 guint time);
+	void		(*tree_drag_data_received)
+						(ETree *tree,
+						 gint row,
+						 ETreePath path,
+						 gint col,
+						 GdkDragContext *context,
+						 gint x,
+						 gint y,
+						 GtkSelectionData *selection_data,
+						 guint info,
+						 guint time);
+};
+
+GType		e_tree_get_type			(void) G_GNUC_CONST;
+gboolean	e_tree_construct		(ETree *e_tree,
+						 ETreeModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec,
+						 const gchar *state);
+GtkWidget *	e_tree_new			(ETreeModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec,
+						 const gchar *state);
+
+/* Create an ETree using files. */
+gboolean	e_tree_construct_from_spec_file	(ETree *e_tree,
+						 ETreeModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec_fn,
+						 const gchar *state_fn);
+GtkWidget *	e_tree_new_from_spec_file	(ETreeModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec_fn,
+						 const gchar *state_fn);
+
+/* To save the state */
+gchar *		e_tree_get_state		(ETree *e_tree);
+void		e_tree_save_state		(ETree *e_tree,
+						 const gchar *filename);
+ETableState *	e_tree_get_state_object		(ETree *e_tree);
+ETableSpecification *
+		e_tree_get_spec			(ETree *e_tree);
+
+/* note that it is more efficient to provide the state at creation time */
+void		e_tree_set_search_column	(ETree *e_tree,
+						 gint col);
+void		e_tree_set_state		(ETree *e_tree,
+						 const gchar *state);
+void		e_tree_set_state_object		(ETree *e_tree,
+						 ETableState *state);
+void		e_tree_load_state		(ETree *e_tree,
+						 const gchar *filename);
+void		e_tree_show_cursor_after_reflow	(ETree *e_tree);
+
+void		e_tree_set_cursor		(ETree *e_tree,
+						 ETreePath path);
+
+/* NULL means we don't have the cursor. */
+ETreePath	e_tree_get_cursor		(ETree *e_tree);
+void		e_tree_selected_row_foreach	(ETree *e_tree,
+						 EForeachFunc callback,
+						 gpointer closure);
+#ifdef E_TREE_USE_TREE_SELECTION
+void		e_tree_selected_path_foreach	(ETree *e_tree,
+						 ETreeForeachFunc callback,
+						 gpointer closure);
+void		e_tree_path_foreach		(ETree *e_tree,
+						 ETreeForeachFunc callback,
+						 gpointer closure);
+#endif
+EPrintable *e_tree_get_printable		(ETree *e_tree);
+gint		e_tree_get_next_row		(ETree *e_tree,
+						 gint model_row);
+gint		e_tree_get_prev_row		(ETree *e_tree,
+						 gint model_row);
+gint		e_tree_model_to_view_row	(ETree *e_tree,
+						 gint model_row);
+gint		e_tree_view_to_model_row	(ETree *e_tree,
+						 gint view_row);
+void		e_tree_get_cell_at		(ETree *tree,
+						 gint x,
+						 gint y,
+						 gint *row_return,
+						 gint *col_return);
+void		e_tree_get_cell_geometry	(ETree *tree,
+						 gint row,
+						 gint col,
+						 gint *x_return,
+						 gint *y_return,
+						 gint *width_return,
+						 gint *height_return);
+
+/* Useful accessors */
+ETreeModel *	e_tree_get_model		(ETree *et);
+ESelectionModel *
+		e_tree_get_selection_model	(ETree *et);
+ETreeTableAdapter *
+		e_tree_get_table_adapter	(ETree *et);
+
+/* Drag & drop stuff. */
+/* Target */
+void		e_tree_drag_get_data		(ETree *tree,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 GdkAtom target,
+						 guint32 time);
+void		e_tree_drag_highlight		(ETree *tree,
+						 gint row,
+						 gint col); /* col == -1 to highlight entire row. */
+void		e_tree_drag_unhighlight		(ETree *tree);
+void		e_tree_drag_dest_set		(ETree *tree,
+						 GtkDestDefaults flags,
+						 const GtkTargetEntry *targets,
+						 gint n_targets,
+						 GdkDragAction actions);
+void		e_tree_drag_dest_set_proxy	(ETree *tree,
+						 GdkWindow *proxy_window,
+						 GdkDragProtocol protocol,
+						 gboolean use_coordinates);
+
+/* There probably should be functions for setting the targets
+ * as a GtkTargetList
+ */
+void		e_tree_drag_dest_unset		(GtkWidget *widget);
+
+/* Source side */
+void		e_tree_drag_source_set		(ETree *tree,
+						 GdkModifierType start_button_mask,
+						 const GtkTargetEntry *targets,
+						 gint n_targets,
+						 GdkDragAction actions);
+void		e_tree_drag_source_unset	(ETree *tree);
+
+/* There probably should be functions for setting the targets
+ * as a GtkTargetList
+ */
+GdkDragContext *e_tree_drag_begin		(ETree *tree,
+						 gint row,
+						 gint col,
+						 GtkTargetList *targets,
+						 GdkDragAction actions,
+						 gint button,
+						 GdkEvent *event);
+
+gboolean	e_tree_is_dragging		(ETree *tree);
+
+/* Adapter functions */
+gboolean	e_tree_node_is_expanded		(ETree *et,
+						 ETreePath path);
+void		e_tree_node_set_expanded	(ETree *et,
+						 ETreePath path,
+						 gboolean expanded);
+void		e_tree_node_set_expanded_recurse
+						(ETree *et,
+						 ETreePath path,
+						 gboolean expanded);
+void		e_tree_root_node_set_visible	(ETree *et,
+						 gboolean visible);
+ETreePath	e_tree_node_at_row		(ETree *et,
+						 gint row);
+gint		e_tree_row_of_node		(ETree *et,
+						 ETreePath path);
+gboolean	e_tree_root_node_is_visible	(ETree *et);
+void		e_tree_show_node		(ETree *et,
+						 ETreePath path);
+void		e_tree_save_expanded_state	(ETree *et,
+						 gchar *filename);
+void		e_tree_load_expanded_state	(ETree *et,
+						 gchar *filename);
+
+xmlDoc *	e_tree_save_expanded_state_xml	(ETree *et);
+void		e_tree_load_expanded_state_xml	(ETree *et,
+						 xmlDoc *doc);
+
+gint		e_tree_row_count		(ETree *et);
+GtkWidget *	e_tree_get_tooltip		(ETree *et);
+void		e_tree_force_expanded_state	(ETree *et,
+						 gint state);
+
+typedef enum {
+	E_TREE_FIND_NEXT_BACKWARD = 0,
+	E_TREE_FIND_NEXT_FORWARD = 1 << 0,
+	E_TREE_FIND_NEXT_WRAP = 1 << 1
+} ETreeFindNextParams;
+
+gboolean	e_tree_find_next		(ETree *et,
+						 ETreeFindNextParams params,
+						 ETreePathFunc func,
+						 gpointer data);
+
+/* This function is only needed in single_selection_mode. */
+void		e_tree_right_click_up		(ETree *et);
+
+ETableItem *	e_tree_get_item			(ETree *et);
+
+GnomeCanvasItem *
+		e_tree_get_header_item		(ETree *et);
+
+void		e_tree_set_info_message		(ETree *tree,
+						 const gchar *info_message);
+
+void		e_tree_freeze_state_change	(ETree *table);
+void		e_tree_thaw_state_change	(ETree *table);
+
+G_END_DECLS
+
+#endif /* _E_TREE_H_ */
+