From: David Bremner Date: Sun, 27 Sep 2015 12:16:26 +0000 (+2100) Subject: [patch v3.1] lib: add versions of n_q_count_{message,threads} with status return X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=c2c169c83858ab451a134e4bbd4542857481a11c;p=notmuch-archives.git [patch v3.1] lib: add versions of n_q_count_{message,threads} with status return --- diff --git a/6e/7670a44109e120c29c1aa4e175ede6b7cfd91d b/6e/7670a44109e120c29c1aa4e175ede6b7cfd91d new file mode 100644 index 000000000..527b3c991 --- /dev/null +++ b/6e/7670a44109e120c29c1aa4e175ede6b7cfd91d @@ -0,0 +1,262 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by arlo.cworth.org (Postfix) with ESMTP id 4D96D6DE1510 + for ; Sun, 27 Sep 2015 05:17:53 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: 0.11 +X-Spam-Level: +X-Spam-Status: No, score=0.11 tagged_above=-999 required=5 tests=[AWL=0.110] + autolearn=disabled +Received: from arlo.cworth.org ([127.0.0.1]) + by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id B3vyZ-KdSRtK for ; + Sun, 27 Sep 2015 05:17:51 -0700 (PDT) +Received: from gitolite.debian.net (gitolite.debian.net [87.98.215.224]) + by arlo.cworth.org (Postfix) with ESMTPS id 25BA66DE141E + for ; Sun, 27 Sep 2015 05:17:51 -0700 (PDT) +Received: from remotemail by gitolite.debian.net with local (Exim 4.80) + (envelope-from ) + id 1ZgAt8-0007YZ-9h; Sun, 27 Sep 2015 12:17:06 +0000 +Received: (nullmailer pid 15557 invoked by uid 1000); Sun, 27 Sep 2015 + 12:16:47 -0000 +From: David Bremner +To: David Bremner , notmuch@notmuchmail.org +Subject: [patch v3.1] lib: add versions of n_q_count_{message,threads} with + status return +Date: Sun, 27 Sep 2015 09:16:26 -0300 +Message-Id: <1443356186-15517-1-git-send-email-david@tethera.net> +X-Mailer: git-send-email 2.5.3 +In-Reply-To: <1443322213-31075-3-git-send-email-david@tethera.net> +References: <1443322213-31075-3-git-send-email-david@tethera.net> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.18 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 27 Sep 2015 12:17:53 -0000 + +Although I think it's a pretty bad idea to continue using the old API, +this allows both a more gentle transition for clients of the library, +and allows us to break one monolithic change into a series +--- + lib/database.cc | 11 ++++++++++- + lib/notmuch.h | 48 ++++++++++++++++++++++++++++++++++++++++++------ + lib/query.cc | 47 +++++++++++++++++++++++++++++++++-------------- + 3 files changed, 85 insertions(+), 21 deletions(-) + +diff --git a/lib/database.cc b/lib/database.cc +index dcfad8c..fbfb1af 100644 +--- a/lib/database.cc ++++ b/lib/database.cc +@@ -1410,7 +1410,13 @@ notmuch_database_upgrade (notmuch_database_t *notmuch, + (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER | + NOTMUCH_FEATURE_LAST_MOD)) { + query = notmuch_query_create (notmuch, ""); +- total += notmuch_query_count_messages (query); ++ unsigned msg_count; ++ ++ status = notmuch_query_count_messages_st (query, &msg_count); ++ if (status) ++ goto DONE; ++ ++ total += msg_count; + notmuch_query_destroy (query); + } + if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) { +@@ -1612,6 +1618,9 @@ notmuch_database_upgrade (notmuch_database_t *notmuch, + sigaction (SIGALRM, &action, NULL); + } + ++ if (query) ++ notmuch_query_destroy (query); ++ + talloc_free (local); + return status; + } +diff --git a/lib/notmuch.h b/lib/notmuch.h +index 8775683..2fb778b 100644 +--- a/lib/notmuch.h ++++ b/lib/notmuch.h +@@ -984,10 +984,26 @@ notmuch_threads_destroy (notmuch_threads_t *threads); + * This function performs a search and returns the number of matching + * messages. + * +- * If a Xapian exception occurs, this function may return 0 (after +- * printing a message). ++ * @returns ++ * ++ * NOTMUCH_STATUS_SUCCESS: query complete successfully. ++ * ++ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The ++ * value of *count is not defined. + */ +-unsigned ++notmuch_status_t ++notmuch_query_count_messages_st (notmuch_query_t *query, unsigned *count); ++ ++/** ++ * like notmuch_query_count_messages_st, but without a status return ++ * ++ * May return 0 in the case of errors. ++ * ++ * @deprecated Deprecated since libnotmuch 4.3 (notmuch 0.21). Please ++ * use notmuch_query_count_messages_st instead. ++ */ ++NOTMUCH_DEPRECATED(4,3) ++unsigned int + notmuch_query_count_messages (notmuch_query_t *query); + + /** +@@ -998,11 +1014,31 @@ notmuch_query_count_messages (notmuch_query_t *query); + * search. + * + * Note that this is a significantly heavier operation than +- * notmuch_query_count_messages(). ++ * notmuch_query_count_messages{_st}(). ++ * ++ * @returns + * +- * If an error occurs, this function may return 0. ++ * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value ++ * of *count is not defined ++ ++ * NOTMUCH_STATUS_SUCCESS: query complete successfully. ++ * ++ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The ++ * value of *count is not defined. + */ +-unsigned ++notmuch_status_t ++notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count); ++ ++/** ++ * like notmuch_query_count_threads, but without a status return. ++ * ++ * May return 0 in case of errors. ++ * ++ * @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please ++ * use notmuch_query_count_threads_st instead. ++ */ ++NOTMUCH_DEPRECATED(4,3) ++unsigned int + notmuch_query_count_threads (notmuch_query_t *query); + + /** +diff --git a/lib/query.cc b/lib/query.cc +index 8cf0a07..e627bfc 100644 +--- a/lib/query.cc ++++ b/lib/query.cc +@@ -541,9 +541,19 @@ notmuch_threads_destroy (notmuch_threads_t *threads) + talloc_free (threads); + } + +-unsigned ++unsigned int + notmuch_query_count_messages (notmuch_query_t *query) + { ++ notmuch_status_t status; ++ unsigned int count; ++ ++ status = notmuch_query_count_messages_st (query, &count); ++ return status ? 0 : count; ++} ++ ++notmuch_status_t ++notmuch_query_count_messages_st (notmuch_query_t *query, unsigned *count_out) ++{ + notmuch_database_t *notmuch = query->notmuch; + const char *query_string = query->query_string; + Xapian::doccount count = 0; +@@ -605,35 +615,44 @@ notmuch_query_count_messages (notmuch_query_t *query) + "Query string was: %s\n", + error.get_msg().c_str(), + query->query_string); +- ++ return NOTMUCH_STATUS_XAPIAN_EXCEPTION; + } + +- return count; ++ *count_out = count; ++ return NOTMUCH_STATUS_SUCCESS; + } + + unsigned + notmuch_query_count_threads (notmuch_query_t *query) + { ++ notmuch_status_t status; ++ unsigned int count; ++ ++ status = notmuch_query_count_threads_st (query, &count); ++ return status ? 0 : count; ++} ++ ++notmuch_status_t ++notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count) ++{ + notmuch_messages_t *messages; + GHashTable *hash; +- unsigned int count; + notmuch_sort_t sort; +- notmuch_status_t status; ++ notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS; + + sort = query->sort; + query->sort = NOTMUCH_SORT_UNSORTED; +- status = notmuch_query_search_messages_st (query, &messages); +- if (status) +- return 0; +- ++ ret = notmuch_query_search_messages_st (query, &messages); ++ if (ret) ++ return ret; + query->sort = sort; + if (messages == NULL) +- return 0; ++ return NOTMUCH_STATUS_XAPIAN_EXCEPTION; + + hash = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, NULL); + if (hash == NULL) { + talloc_free (messages); +- return 0; ++ return NOTMUCH_STATUS_OUT_OF_MEMORY; + } + + while (notmuch_messages_valid (messages)) { +@@ -642,7 +661,7 @@ notmuch_query_count_threads (notmuch_query_t *query) + char *thread_id_copy = talloc_strdup (messages, thread_id); + if (unlikely (thread_id_copy == NULL)) { + notmuch_message_destroy (message); +- count = 0; ++ ret = NOTMUCH_STATUS_OUT_OF_MEMORY; + goto DONE; + } + g_hash_table_insert (hash, thread_id_copy, NULL); +@@ -650,13 +669,13 @@ notmuch_query_count_threads (notmuch_query_t *query) + notmuch_messages_move_to_next (messages); + } + +- count = g_hash_table_size (hash); ++ *count = g_hash_table_size (hash); + + DONE: + g_hash_table_unref (hash); + talloc_free (messages); + +- return count; ++ return ret; + } + + notmuch_database_t * +-- +2.5.3 +