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

diff --git a/e-util/e-table.h b/e-util/e-table.h
new file mode 100644
index 0000000000..8370e440df
--- /dev/null
+++ b/e-util/e-table.h
@@ -0,0 +1,403 @@
+/*
+ * 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)
+ *
+ */
+
+#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
+#error "Only <e-util/e-util.h> should be included directly."
+#endif
+
+#ifndef _E_TABLE_H_
+#define _E_TABLE_H_
+
+#include <libgnomecanvas/libgnomecanvas.h>
+#include <gtk/gtk.h>
+#include <libxml/tree.h>
+
+#include <e-util/e-printable.h>
+#include <e-util/e-table-extras.h>
+#include <e-util/e-table-group.h>
+#include <e-util/e-table-header.h>
+#include <e-util/e-table-item.h>
+#include <e-util/e-table-model.h>
+#include <e-util/e-table-search.h>
+#include <e-util/e-table-selection-model.h>
+#include <e-util/e-table-sort-info.h>
+#include <e-util/e-table-sorter.h>
+#include <e-util/e-table-specification.h>
+#include <e-util/e-table-state.h>
+
+/* Standard GObject macros */
+#define E_TYPE_TABLE \
+	(e_table_get_type ())
+#define E_TABLE(obj) \
+	(G_TYPE_CHECK_INSTANCE_CAST \
+	((obj), E_TYPE_TABLE, ETable))
+#define E_TABLE_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_CAST \
+	((cls), E_TYPE_TABLE, ETableClass))
+#define E_IS_TABLE(obj) \
+	(G_TYPE_CHECK_INSTANCE_TYPE \
+	((obj), E_TYPE_TABLE))
+#define E_IS_TABLE_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_TYPE \
+	((cls), E_TYPE_TABLE))
+#define E_TABLE_GET_CLASS(obj) \
+	(G_TYPE_INSTANCE_GET_CLASS \
+	((obj), E_TYPE_TABLE, ETableClass))
+
+G_BEGIN_DECLS
+
+typedef struct _ETable ETable;
+typedef struct _ETableClass ETableClass;
+
+typedef struct _ETableDragSourceSite ETableDragSourceSite;
+
+typedef enum {
+	E_TABLE_CURSOR_LOC_NONE = 0,
+	E_TABLE_CURSOR_LOC_ETCTA = 1 << 0,
+	E_TABLE_CURSOR_LOC_TABLE = 1 << 1
+} ETableCursorLoc;
+
+struct _ETable {
+	GtkTable parent;
+
+	ETableModel *model;
+
+	ETableHeader *full_header, *header;
+
+	GnomeCanvasItem *canvas_vbox;
+	ETableGroup *group;
+
+	ETableSortInfo *sort_info;
+	ETableSorter *sorter;
+
+	ETableSelectionModel *selection;
+	ETableCursorLoc cursor_loc;
+	ETableSpecification *spec;
+
+	ETableSearch *search;
+
+	ETableCol *current_search_col;
+
+	guint	 search_search_id;
+	guint	 search_accept_id;
+
+	gint table_model_change_id;
+	gint table_row_change_id;
+	gint table_cell_change_id;
+	gint table_rows_inserted_id;
+	gint table_rows_deleted_id;
+
+	gint group_info_change_id;
+	gint sort_info_change_id;
+
+	gint structure_change_id;
+	gint expansion_change_id;
+	gint dimension_change_id;
+
+	gint reflow_idle_id;
+	gint scroll_idle_id;
+
+	GnomeCanvas *header_canvas, *table_canvas;
+
+	GnomeCanvasItem *header_item, *root;
+
+	GnomeCanvasItem *white_item;
+
+	gint length_threshold;
+
+	gint rebuild_idle_id;
+	guint need_rebuild : 1;
+	guint size_allocated : 1;
+
+	/*
+	 * Configuration settings
+	 */
+	guint alternating_row_colors : 1;
+	guint horizontal_draw_grid : 1;
+	guint vertical_draw_grid : 1;
+	guint draw_focus : 1;
+	guint row_selection_active : 1;
+
+	guint horizontal_scrolling : 1;
+	guint horizontal_resize : 1;
+
+	guint is_grouped : 1;
+
+	guint scroll_direction : 4;
+
+	guint do_drag : 1;
+
+	guint uniform_row_height : 1;
+	guint allow_grouping : 1;
+
+	guint always_search : 1;
+	guint search_col_set : 1;
+
+	gchar *click_to_add_message;
+	GnomeCanvasItem *click_to_add;
+	gboolean use_click_to_add;
+	gboolean use_click_to_add_end;
+
+	ECursorMode cursor_mode;
+
+	gint drop_row;
+	gint drop_col;
+	GnomeCanvasItem *drop_highlight;
+	gint last_drop_x;
+	gint last_drop_y;
+	gint last_drop_time;
+	GdkDragContext *last_drop_context;
+
+	gint drag_row;
+	gint drag_col;
+	ETableDragSourceSite *site;
+
+	gint header_width;
+
+	gchar *domain;
+
+	gboolean state_changed;
+	guint state_change_freeze;
+};
+
+struct _ETableClass {
+	GtkTableClass parent_class;
+
+	void		(*cursor_change)	(ETable *et,
+						 gint row);
+	void		(*cursor_activated)	(ETable *et,
+						 gint row);
+	void		(*selection_change)	(ETable *et);
+	void		(*double_click)		(ETable *et,
+						 gint row,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*right_click)		(ETable *et,
+						 gint row,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*click)		(ETable *et,
+						 gint row,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*key_press)		(ETable *et,
+						 gint row,
+						 gint col,
+						 GdkEvent *event);
+	gboolean	(*start_drag)		(ETable *et,
+						 gint row,
+						 gint col,
+						 GdkEvent *event);
+	void		(*state_change)		(ETable *et);
+	gboolean	(*white_space_event)	(ETable *et,
+						 GdkEvent *event);
+
+	/* Source side drag signals */
+	void		(*table_drag_begin)	 (ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context);
+	void		(*table_drag_end)	(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context);
+	void		(*table_drag_data_get)	(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 GtkSelectionData *selection_data,
+						 guint info,
+						 guint time);
+	void		(*table_drag_data_delete)
+						(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context);
+
+	/* Target side drag signals */
+	void		(*table_drag_leave)	(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 guint time);
+	gboolean	(*table_drag_motion)	(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 gint x,
+						 gint y,
+						 guint time);
+	gboolean	(*table_drag_drop)	(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 gint x,
+						 gint y,
+						 guint time);
+	void		(*table_drag_data_received)
+						(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 gint x,
+						 gint y,
+						 GtkSelectionData *selection_data,
+						 guint info,
+						 guint time);
+};
+
+GType		e_table_get_type		(void) G_GNUC_CONST;
+ETable *	e_table_construct		(ETable *e_table,
+						 ETableModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec,
+						 const gchar *state);
+GtkWidget *	e_table_new			(ETableModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec,
+						 const gchar *state);
+
+/* Create an ETable using files. */
+ETable *	e_table_construct_from_spec_file
+						(ETable *e_table,
+						 ETableModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec_fn,
+						 const gchar *state_fn);
+GtkWidget *	e_table_new_from_spec_file	(ETableModel *etm,
+						 ETableExtras *ete,
+						 const gchar *spec_fn,
+						 const gchar *state_fn);
+
+/* To save the state */
+gchar *		e_table_get_state		(ETable *e_table);
+void		e_table_save_state		(ETable *e_table,
+						 const gchar *filename);
+ETableState *e_table_get_state_object		(ETable *e_table);
+
+/* note that it is more efficient to provide the state at creation time */
+void		e_table_set_state		(ETable *e_table,
+						 const gchar *state);
+void		e_table_set_state_object	(ETable *e_table,
+						 ETableState *state);
+void		e_table_load_state		(ETable *e_table,
+						 const gchar *filename);
+void		e_table_set_cursor_row		(ETable *e_table,
+						 gint row);
+
+/* -1 means we don't have the cursor. This is in model rows. */
+gint		e_table_get_cursor_row		(ETable *e_table);
+void		e_table_selected_row_foreach	(ETable *e_table,
+						 EForeachFunc callback,
+						 gpointer closure);
+gint		e_table_selected_count		(ETable *e_table);
+EPrintable *	e_table_get_printable		(ETable *e_table);
+gint		e_table_get_next_row		(ETable *e_table,
+						 gint model_row);
+gint		e_table_get_prev_row		(ETable *e_table,
+						 gint model_row);
+gint		e_table_model_to_view_row	(ETable *e_table,
+						 gint model_row);
+gint		e_table_view_to_model_row	(ETable *e_table,
+						 gint view_row);
+void		e_table_get_cell_at		(ETable *table,
+						 gint x,
+						 gint y,
+						 gint *row_return,
+						 gint *col_return);
+void		e_table_get_mouse_over_cell	(ETable *table,
+						 gint *row,
+						 gint *col);
+void		e_table_get_cell_geometry	(ETable *table,
+						 gint row,
+						 gint col,
+						 gint *x_return,
+						 gint *y_return,
+						 gint *width_return,
+						 gint *height_return);
+
+/* Useful accessor functions. */
+ESelectionModel *e_table_get_selection_model	(ETable *table);
+
+/* Drag & drop stuff. */
+/* Target */
+void		e_table_drag_get_data		(ETable *table,
+						 gint row,
+						 gint col,
+						 GdkDragContext *context,
+						 GdkAtom target,
+						 guint32 time);
+void		e_table_drag_highlight	(ETable *table,
+						 gint row,
+						 gint col); /* col == -1 to highlight entire row. */
+void		e_table_drag_unhighlight	(ETable *table);
+void		e_table_drag_dest_set		(ETable *table,
+						 GtkDestDefaults flags,
+						 const GtkTargetEntry *targets,
+						 gint n_targets,
+						 GdkDragAction actions);
+void		e_table_drag_dest_set_proxy	(ETable *table,
+						 GdkWindow *proxy_window,
+						 GdkDragProtocol protocol,
+						 gboolean use_coordinates);
+
+/* There probably should be functions for setting the targets
+ * as a GtkTargetList
+ */
+void		e_table_drag_dest_unset		(GtkWidget *widget);
+
+/* Source side */
+void		e_table_drag_source_set		(ETable *table,
+						 GdkModifierType start_button_mask,
+						 const GtkTargetEntry *targets,
+						 gint n_targets,
+						 GdkDragAction actions);
+void		e_table_drag_source_unset	(ETable *table);
+
+/* There probably should be functions for setting the targets
+ * as a GtkTargetList
+ */
+GdkDragContext *e_table_drag_begin		(ETable *table,
+						 gint row,
+						 gint col,
+						 GtkTargetList *targets,
+						 GdkDragAction actions,
+						 gint button,
+						 GdkEvent *event);
+
+/* selection stuff */
+void		e_table_select_all		(ETable *table);
+void		e_table_invert_selection	(ETable *table);
+
+/* This function is only needed in single_selection_mode. */
+void		e_table_right_click_up		(ETable *table);
+
+void		e_table_commit_click_to_add	(ETable *table);
+
+void		e_table_freeze_state_change	(ETable *table);
+void		e_table_thaw_state_change	(ETable *table);
+
+G_END_DECLS
+
+#endif /* _E_TABLE_H_ */
+