Added. A simplified, cancellable query mechanism that lets you avoid

2001-03-11  Jon Trowbridge  <trow@ximian.com>

	* backend/ebook/e-book.c (e_book_simple_query): Added. A
	simplified, cancellable query mechanism that lets you avoid
	dealing with EBookView.
	(e_book_simple_query_cancel): Added. Cancels a running query.

	* backend/ebook/e-book-types.h: Add enum EBookSimpleQueryStatus.

svn path=/trunk/; revision=8627

3 files changed, 171 insertions, 0 deletions

diff --git a/addressbook/backend/ebook/e-book-types.h b/addressbook/backend/ebook/e-book-types.h
index a3e8bbc032..2ce1956080 100644
--- a/addressbook/backend/ebook/e-book-types.h
+++ b/addressbook/backend/ebook/e-book-types.h
@@ -26,6 +26,12 @@ typedef enum {
 	E_BOOK_STATUS_OTHER_ERROR
 } EBookStatus;
 
+typedef enum {
+	E_BOOK_SIMPLE_QUERY_STATUS_SUCCESS,
+	E_BOOK_SIMPLE_QUERY_STATUS_CANCELLED,
+	E_BOOK_SIMPLE_QUERY_STATUS_OTHER_ERROR
+} EBookSimpleQueryStatus;
+
 END_GNOME_DECLS
 
 #endif /* ! __E_BOOK_TYPES_H__ */
diff --git a/addressbook/backend/ebook/e-book.c b/addressbook/backend/ebook/e-book.c
index 1401498d2d..e0b62c48d1 100644
--- a/addressbook/backend/ebook/e-book.c
+++ b/addressbook/backend/ebook/e-book.c
@@ -44,6 +44,9 @@ struct _EBookPrivate {
 	 * the op structures are popped off the front of the queue.
 	 */
 	GList                 *pending_ops;
+
+	guint sq_tag;
+	GList *sq_pending;
 };
 
 enum {
@@ -1116,6 +1119,157 @@ e_book_get_changes         (EBook                 *book,
 	return TRUE;
 }
 
+/*
+ *
+ * Simple Query Stuff
+ *
+ */
+
+typedef struct _SimpleQueryInfo SimpleQueryInfo;
+struct _SimpleQueryInfo {
+	guint tag;
+	EBook *book;
+	gchar *query;
+	EBookSimpleQueryCallback cb;
+	gpointer closure;
+	EBookView *view;
+	guint add_tag;
+	guint seq_complete_tag;
+	GList *cards;
+};
+
+static SimpleQueryInfo *
+simple_query_new (EBook *book, char *query, EBookSimpleQueryCallback cb, gpointer closure)
+{
+	SimpleQueryInfo *sq = g_new0 (SimpleQueryInfo, 1);
+
+	sq->tag = ++book->priv->sq_tag;
+	sq->book = book;
+	gtk_object_ref (GTK_OBJECT (book));
+	sq->query = g_strdup_printf (query);
+	sq->cb = cb;
+	sq->closure = closure;
+
+	/* Automatically add ourselves to the EBook's pending list. */
+	book->priv->sq_pending = g_list_prepend (book->priv->sq_pending, sq);
+
+	return sq;
+}
+
+static void
+simple_query_free (SimpleQueryInfo *sq)
+{
+	GList *i;
+	gboolean found = FALSE;
+
+	/* Find & remove ourselves from the EBook's pending list. */
+	for (i = sq->book->priv->sq_pending; i != NULL; i = g_list_next (i)) {
+		if (i->data == sq) {
+			sq->book->priv->sq_pending = g_list_remove_link (sq->book->priv->sq_pending, i);
+			g_list_free_1 (i);
+			i = NULL;
+			found = TRUE;
+		} else
+			i = g_list_next (i);
+	}
+
+	g_assert (found);
+	
+	g_free (sq->query);
+
+	if (sq->add_tag)
+		gtk_signal_disconnect (GTK_OBJECT (sq->view), sq->add_tag);
+	if (sq->seq_complete_tag)
+		gtk_signal_disconnect (GTK_OBJECT (sq->view), sq->seq_complete_tag);
+
+	if (sq->view)
+		gtk_object_unref (GTK_OBJECT (sq->view));
+
+	if (sq->book)
+		gtk_object_unref (GTK_OBJECT (sq->book));
+
+	g_list_foreach (sq->cards, (GFunc) gtk_object_unref, NULL);
+	g_list_free (sq->cards);
+
+	g_free (sq);
+}
+
+static void
+simple_query_card_added_cb (EBookView *view, const GList *cards, gpointer closure)
+{
+	SimpleQueryInfo *sq = closure;
+	
+	sq->cards = g_list_concat (sq->cards, g_list_copy ((GList *) cards));
+	g_list_foreach ((GList *) cards, (GFunc) gtk_object_ref, NULL);
+}
+
+static void
+simple_query_sequence_complete_cb (EBookView *view, gpointer closure)
+{
+	SimpleQueryInfo *sq = closure;
+
+	sq->cb (sq->book, E_BOOK_SIMPLE_QUERY_STATUS_SUCCESS, sq->cards, sq->closure);
+	simple_query_free (sq);
+}
+
+static void
+simple_query_book_view_cb (EBook *book, EBookStatus status, EBookView *book_view, gpointer closure)
+{
+	SimpleQueryInfo *sq = closure;
+
+	if (status != E_BOOK_STATUS_SUCCESS) {
+		sq->cb (sq->book, E_BOOK_SIMPLE_QUERY_STATUS_OTHER_ERROR, NULL, sq->closure);
+		simple_query_free (sq);
+		return;
+	}
+
+	sq->view = book_view;
+	gtk_object_ref (GTK_OBJECT (book_view));
+
+	sq->add_tag = gtk_signal_connect (GTK_OBJECT (sq->view),
+					  "card_added",
+					  GTK_SIGNAL_FUNC (simple_query_card_added_cb),
+					  sq);
+	sq->seq_complete_tag = gtk_signal_connect (GTK_OBJECT (sq->view),
+						   "sequence_complete",
+						   GTK_SIGNAL_FUNC (simple_query_sequence_complete_cb),
+						   sq);
+}
+
+guint
+e_book_simple_query (EBook *book, char *query, EBookSimpleQueryCallback cb, gpointer closure)
+{
+	SimpleQueryInfo *sq;
+
+	g_return_val_if_fail (book && E_IS_BOOK (book), 0);
+	g_return_val_if_fail (query, 0);
+	g_return_val_if_fail (cb, 0);
+
+	sq = simple_query_new (book, query, cb, closure);
+	e_book_get_book_view (book, query, simple_query_book_view_cb, sq);
+
+	return sq->tag;
+}
+
+void
+e_book_simple_query_cancel (EBook *book, guint tag)
+{
+	GList *i;
+
+	g_return_if_fail (book && E_IS_BOOK (book));
+
+	for (i=book->priv->sq_pending; i != NULL; i=g_list_next (i)) {
+		SimpleQueryInfo *sq = i->data;
+
+		if (sq->tag == tag) {
+			sq->cb (sq->book, E_BOOK_SIMPLE_QUERY_STATUS_CANCELLED, NULL, sq->closure);
+			simple_query_free (sq);
+			return;
+		}
+	}
+	g_warning ("Simple query tag %d is unknown", tag);
+}
+
 /**
  * e_book_get_name:
  */
diff --git a/addressbook/backend/ebook/e-book.h b/addressbook/backend/ebook/e-book.h
index d992f63471..2521edb24f 100644
--- a/addressbook/backend/ebook/e-book.h
+++ b/addressbook/backend/ebook/e-book.h
@@ -50,6 +50,8 @@ typedef void (*EBookCursorCallback) (EBook *book, EBookStatus status, ECardCurso
 typedef void (*EBookBookViewCallback) (EBook *book, EBookStatus status, EBookView *book_view, gpointer closure);
 typedef void (*EBookFieldsCallback) (EBook *book, EBookStatus status, EList *fields, gpointer closure);
 
+typedef void (*EBookSimpleQueryCallback) (EBook *book, EBookSimpleQueryStatus status, const GList *cards, gpointer closure);
+
 
 /* Creating a new addressbook. */
 EBook    *e_book_new                      (void);
@@ -131,6 +133,15 @@ gboolean  e_book_get_changes              (EBook                 *book,
 					   EBookBookViewCallback  cb,
 					   gpointer               closure);
 
+/* Simple Query Interface. */
+
+guint     e_book_simple_query             (EBook                    *book,
+					   char                     *query,
+					   EBookSimpleQueryCallback  cb,
+					   gpointer                  closure);
+void      e_book_simple_query_cancel      (EBook                    *book,
+					   guint                     tag);
+
 /* Getting the name of the repository. */
 char     *e_book_get_name                 (EBook                 *book);