Re: [PATCH 4/4] lib: make notmuch_query_add_tag_exclude return a status value

[David Bremner]

David Bremner  writes:

> Since this is an ABI breaking change, bump the SONAME.

pushed, although the SONAME bump was already there from the previous
series.

d
___
notmuch mailing list
notmuch@notmuchmail.org
https://notmuchmail.org/mailman/listinfo/notmuch

[PATCH 4/4] lib: make notmuch_query_add_tag_exclude return a status value

[David Bremner]

Since this is an ABI breaking change, bump the SONAME.
---
 lib/notmuch.h| 23 +++
 lib/query.cc |  7 ---
 notmuch-count.c  |  9 +++--
 notmuch-search.c | 12 ++--
 notmuch-show.c   | 13 +++--
 5 files changed, 51 insertions(+), 13 deletions(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 16da8be9..74043819 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -55,8 +55,8 @@ NOTMUCH_BEGIN_DECLS
  * The library version number.  This must agree with the soname
  * version in Makefile.local.
  */
-#define LIBNOTMUCH_MAJOR_VERSION   4
-#define LIBNOTMUCH_MINOR_VERSION   4
+#define LIBNOTMUCH_MAJOR_VERSION   5
+#define LIBNOTMUCH_MINOR_VERSION   0
 #define LIBNOTMUCH_MICRO_VERSION   0
 
 
@@ -180,6 +180,11 @@ typedef enum _notmuch_status {
  */
 NOTMUCH_STATUS_PATH_ERROR,
 /**
+ * The requested operation was ignored. Depending on the function,
+ * this may not be an actual error.
+ */
+NOTMUCH_STATUS_IGNORED,
+/**
  * One of the arguments violates the preconditions for the
  * function, in a way not covered by a more specific argument.
  */
@@ -812,10 +817,20 @@ notmuch_query_get_sort (const notmuch_query_t *query);
 
 /**
  * Add a tag that will be excluded from the query results by default.
- * This exclusion will be overridden if this tag appears explicitly in
+ * This exclusion will be ignored if this tag appears explicitly in
  * the query.
+ *
+ * @returns
+ *
+ * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
+ *
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
+ *  Most likely a problem lazily parsing the query string.
+ *
+ * NOTMUCH_STATUS_IGNORED: tag is explicitely present in the query, so
+ * not excluded.
  */
-void
+notmuch_status_t
 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
 
 /**
diff --git a/lib/query.cc b/lib/query.cc
index c0a1cdf8..c027edd3 100644
--- a/lib/query.cc
+++ b/lib/query.cc
@@ -174,7 +174,7 @@ notmuch_query_get_sort (const notmuch_query_t *query)
 return query->sort;
 }
 
-void
+notmuch_status_t
 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag)
 {
 notmuch_status_t status;
@@ -182,13 +182,14 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, 
const char *tag)
 
 status = _notmuch_query_ensure_parsed (query);
 if (status)
-   return; /* XXX report error */
+   return status;
 
 term = talloc_asprintf (query, "%s%s", _find_prefix ("tag"), tag);
 if (query->terms.count(term) != 0)
-   return; /* XXX report ignoring exclude? */
+   return NOTMUCH_STATUS_IGNORED;
 
 _notmuch_string_list_append (query->exclude_terms, term);
+return NOTMUCH_STATUS_SUCCESS;
 }
 
 /* We end up having to call the destructors explicitly because we had
diff --git a/notmuch-count.c b/notmuch-count.c
index 35a2aa70..3207c015 100644
--- a/notmuch-count.c
+++ b/notmuch-count.c
@@ -87,8 +87,13 @@ print_count (notmuch_database_t *notmuch, const char 
*query_str,
return -1;
 }
 
-for (i = 0; i < exclude_tags_length; i++)
-   notmuch_query_add_tag_exclude (query, exclude_tags[i]);
+for (i = 0; i < exclude_tags_length; i++) {
+   status = notmuch_query_add_tag_exclude (query, exclude_tags[i]);
+   if (status && status != NOTMUCH_STATUS_IGNORED) {
+   print_status_query ("notmuch count", query, status);
+   return -1;
+   }
+}
 
 switch (output) {
 case OUTPUT_MESSAGES:
diff --git a/notmuch-search.c b/notmuch-search.c
index 8c65d5ad..64a98110 100644
--- a/notmuch-search.c
+++ b/notmuch-search.c
@@ -735,11 +735,19 @@ _notmuch_search_prepare (search_context_t *ctx, 
notmuch_config_t *config, int ar
 if (ctx->exclude != NOTMUCH_EXCLUDE_FALSE) {
const char **search_exclude_tags;
size_t search_exclude_tags_length;
+   notmuch_status_t status;
 
search_exclude_tags = notmuch_config_get_search_exclude_tags
(config, _exclude_tags_length);
-   for (i = 0; i < search_exclude_tags_length; i++)
-   notmuch_query_add_tag_exclude (ctx->query, search_exclude_tags[i]);
+
+   for (i = 0; i < search_exclude_tags_length; i++) {
+   status = notmuch_query_add_tag_exclude (ctx->query, 
search_exclude_tags[i]);
+   if (status && status != NOTMUCH_STATUS_IGNORED) {
+   print_status_query ("notmuch search", ctx->query, status);
+   return EXIT_FAILURE;
+   }
+   }
+
notmuch_query_set_omit_excluded (ctx->query, ctx->exclude);
 }
 
diff --git a/notmuch-show.c b/notmuch-show.c
index 22fa655a..4c63959f 100644
--- a/notmuch-show.c
+++ b/notmuch-show.c
@@ -1157,11 +1157,19 @@ notmuch_show_command (notmuch_config_t *config, int 
argc, char *argv[])
const char **search_exclude_tags;
size_t search_exclude_tags_length;
unsigned int i;
+   notmuch_status_t status;
 

[PATCH 4/4] lib: make notmuch_query_add_tag_exclude return a status value

[David Bremner]

Since this is an ABI breaking change, bump the SONAME.
---
 lib/notmuch.h| 23 +++
 lib/query.cc |  7 ---
 notmuch-count.c  |  9 +++--
 notmuch-search.c | 12 ++--
 notmuch-show.c   | 13 +++--
 5 files changed, 51 insertions(+), 13 deletions(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 18678c0..054d86a 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -55,8 +55,8 @@ NOTMUCH_BEGIN_DECLS
  * The library version number.  This must agree with the soname
  * version in Makefile.local.
  */
-#define LIBNOTMUCH_MAJOR_VERSION   4
-#define LIBNOTMUCH_MINOR_VERSION   4
+#define LIBNOTMUCH_MAJOR_VERSION   5
+#define LIBNOTMUCH_MINOR_VERSION   0
 #define LIBNOTMUCH_MICRO_VERSION   0
 
 
@@ -180,6 +180,11 @@ typedef enum _notmuch_status {
  */
 NOTMUCH_STATUS_PATH_ERROR,
 /**
+ * The requested operation was ignored. Depending on the function,
+ * this may not be an actual error.
+ */
+NOTMUCH_STATUS_IGNORED,
+/**
  * One of the arguments violates the preconditions for the
  * function, in a way not covered by a more specific argument.
  */
@@ -812,10 +817,20 @@ notmuch_query_get_sort (const notmuch_query_t *query);
 
 /**
  * Add a tag that will be excluded from the query results by default.
- * This exclusion will be overridden if this tag appears explicitly in
+ * This exclusion will be ignored if this tag appears explicitly in
  * the query.
+ *
+ * @returns
+ *
+ * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
+ *
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
+ *  Most likely a problem lazily parsing the query string.
+ *
+ * NOTMUCH_STATUS_IGNORED: tag is explicitely present in the query, so
+ * not excluded.
  */
-void
+notmuch_status_t
 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
 
 /**
diff --git a/lib/query.cc b/lib/query.cc
index 961cb76..fba6e07 100644
--- a/lib/query.cc
+++ b/lib/query.cc
@@ -174,7 +174,7 @@ notmuch_query_get_sort (const notmuch_query_t *query)
 return query->sort;
 }
 
-void
+notmuch_status_t
 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag)
 {
 notmuch_status_t status;
@@ -182,13 +182,14 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, 
const char *tag)
 
 status = _notmuch_query_ensure_parsed (query);
 if (status)
-   return; /* XXX report error */
+   return status;
 
 term = talloc_asprintf (query, "%s%s", _find_prefix ("tag"), tag);
 if (query->terms.count(term) != 0)
-   return; /* XXX report ignoring exclude? */
+   return NOTMUCH_STATUS_IGNORED;
 
 _notmuch_string_list_append (query->exclude_terms, term);
+return NOTMUCH_STATUS_SUCCESS;
 }
 
 /* We end up having to call the destructors explicitly because we had
diff --git a/notmuch-count.c b/notmuch-count.c
index 35a2aa7..3207c01 100644
--- a/notmuch-count.c
+++ b/notmuch-count.c
@@ -87,8 +87,13 @@ print_count (notmuch_database_t *notmuch, const char 
*query_str,
return -1;
 }
 
-for (i = 0; i < exclude_tags_length; i++)
-   notmuch_query_add_tag_exclude (query, exclude_tags[i]);
+for (i = 0; i < exclude_tags_length; i++) {
+   status = notmuch_query_add_tag_exclude (query, exclude_tags[i]);
+   if (status && status != NOTMUCH_STATUS_IGNORED) {
+   print_status_query ("notmuch count", query, status);
+   return -1;
+   }
+}
 
 switch (output) {
 case OUTPUT_MESSAGES:
diff --git a/notmuch-search.c b/notmuch-search.c
index 8c65d5a..64a9811 100644
--- a/notmuch-search.c
+++ b/notmuch-search.c
@@ -735,11 +735,19 @@ _notmuch_search_prepare (search_context_t *ctx, 
notmuch_config_t *config, int ar
 if (ctx->exclude != NOTMUCH_EXCLUDE_FALSE) {
const char **search_exclude_tags;
size_t search_exclude_tags_length;
+   notmuch_status_t status;
 
search_exclude_tags = notmuch_config_get_search_exclude_tags
(config, _exclude_tags_length);
-   for (i = 0; i < search_exclude_tags_length; i++)
-   notmuch_query_add_tag_exclude (ctx->query, search_exclude_tags[i]);
+
+   for (i = 0; i < search_exclude_tags_length; i++) {
+   status = notmuch_query_add_tag_exclude (ctx->query, 
search_exclude_tags[i]);
+   if (status && status != NOTMUCH_STATUS_IGNORED) {
+   print_status_query ("notmuch search", ctx->query, status);
+   return EXIT_FAILURE;
+   }
+   }
+
notmuch_query_set_omit_excluded (ctx->query, ctx->exclude);
 }
 
diff --git a/notmuch-show.c b/notmuch-show.c
index 22fa655..4c63959 100644
--- a/notmuch-show.c
+++ b/notmuch-show.c
@@ -1157,11 +1157,19 @@ notmuch_show_command (notmuch_config_t *config, int 
argc, char *argv[])
const char **search_exclude_tags;
size_t search_exclude_tags_length;
unsigned int i;
+   notmuch_status_t status;