[PATCH v3 5/6] cli: move show to the new --exclude= option naming scheme.

diff --git a/10/9537d0f2a9c2e499294a15e0ced3552d694113 b/10/9537d0f2a9c2e499294a15e0ced3552d694113
new file mode 100644 (file)
index 0000000..8f6767a
--- /dev/null
+++ b/10/9537d0f2a9c2e499294a15e0ced3552d694113
@@ -0,0 +1,236 @@
+Return-Path: <markwalters1009@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 32DE5431FD6\r
+       for <notmuch@notmuchmail.org>; Fri,  6 Apr 2012 05:49:28 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id zFSzabWV9VZt for <notmuch@notmuchmail.org>;\r
+       Fri,  6 Apr 2012 05:49:26 -0700 (PDT)\r
+Received: from mail-we0-f181.google.com (mail-we0-f181.google.com\r
+       [74.125.82.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 2B890429E2E\r
+       for <notmuch@notmuchmail.org>; Fri,  6 Apr 2012 05:49:24 -0700 (PDT)\r
+Received: by mail-we0-f181.google.com with SMTP id m13so1667174wer.26\r
+       for <notmuch@notmuchmail.org>; Fri, 06 Apr 2012 05:49:23 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=sJInaK4MPwl719u/pQeaJN1jaTkMGa+HjYOfWYMFtaA=;\r
+       b=GcVjyXtwbYLKIF0OA146At1lmwEZy6uAKP3r9em88T1hMm60yE7Asc4qe4WvM4kifS\r
+       wxHKHiDWmwoTENKT2HEynJ7iI4Hrw9P4SA6C6RRJId2mCBoqdwylEWaeR2YLXN6UWcOy\r
+       tDhfMUODzYxDRuEyAa8ubk88J2JRlruK341B7xZVsoD5jfX4Wgms2sg2AzAP3AX1i/zb\r
+       sruu9HObaKb20HToq1rkNdEKNYzXd++hw1DBy2Zv8zx8az0gOtuf7XSx1VYQeobPAtdU\r
+       tmg0yTY22AW1A5Sa1UCMf6gYTiMYy1UxKEmJvoqYSFp1hwuBNeVj5Jh86cbhSPFeVLJK\r
+       2mGw==\r
+Received: by 10.216.137.226 with SMTP id y76mr3620144wei.96.1333716563813;\r
+       Fri, 06 Apr 2012 05:49:23 -0700 (PDT)\r
+Received: from localhost (94-192-233-223.zone6.bethere.co.uk.\r
+ [94.192.233.223])     by mx.google.com with ESMTPS id\r
+ e6sm6141546wix.8.2012.04.06.05.49.22  (version=TLSv1/SSLv3 cipher=OTHER);     Fri,\r
+ 06 Apr 2012 05:49:22 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v3 5/6] cli: move show to the new --exclude= option naming\r
+       scheme.\r
+Date: Fri,  6 Apr 2012 13:49:10 +0100\r
+Message-Id: <1333716551-29153-6-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <1333716551-29153-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1333716551-29153-1-git-send-email-markwalters1009@gmail.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Fri, 06 Apr 2012 12:49:28 -0000\r
+\r
+This moves notmuch show to the --exclude=(true|false) naming\r
+scheme. When exclude=false show returns all threads that match\r
+including those that only match in an excluded message. The excluded\r
+messages are flagged.\r
+\r
+When exclude=true the behaviour depends on whether --entire-thread is\r
+set. If it is not set then show only returns the messages which match\r
+and are not excluded. If it is set then show returns all messages in\r
+the threads that match in a non-excluded message, flagging the excluded\r
+messages in these threads. The rationale is that it is awkward to use\r
+a thread with some missing messages.\r
+---\r
+ man/man1/notmuch-show.1 |   16 +++++++++++++-\r
+ notmuch-client.h        |    1 +\r
+ notmuch-show.c          |   50 +++++++++++++++++++++++++++++-----------------\r
+ 3 files changed, 46 insertions(+), 21 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+index b81cce6..83cc575 100644\r
+--- a/man/man1/notmuch-show.1\r
++++ b/man/man1/notmuch-show.1\r
+@@ -135,9 +135,21 @@ content.\r
+ \r
+ .RS 4\r
+ .TP 4\r
+-.B \-\-no-exclude\r
++.BR \-\-exclude=(true|false)\r
++\r
++Specify whether to omit threads only matching search.tag_exclude from\r
++the search results (the default) or not. In either case the excluded\r
++message will be marked with the exclude flag (except when output=mbox\r
++when there is nowhere to put the flag).\r
++\r
++If --entire-thread is specified then complete threads are returned\r
++regardless (with the excluded flag being set when appropriate) but\r
++threads that only match in an excluded message are not returned when\r
++.B --exclude=true.\r
++\r
++The default is\r
++.B --exclude=true.\r
+ \r
+-Do not exclude the messages matching search.exclude_tags in the config file.\r
+ .RE\r
+ \r
+ A common use of\r
+diff --git a/notmuch-client.h b/notmuch-client.h\r
+index 203ac49..880b153 100644\r
+--- a/notmuch-client.h\r
++++ b/notmuch-client.h\r
+@@ -99,6 +99,7 @@ typedef struct notmuch_show_format {\r
+ \r
+ typedef struct notmuch_show_params {\r
+     notmuch_bool_t entire_thread;\r
++    notmuch_bool_t omit_excluded;\r
+     notmuch_bool_t raw;\r
+     int part;\r
+ #ifdef GMIME_ATLEAST_26\r
+diff --git a/notmuch-show.c b/notmuch-show.c\r
+index 0bf5e21..7af8e64 100644\r
+--- a/notmuch-show.c\r
++++ b/notmuch-show.c\r
+@@ -866,6 +866,7 @@ show_messages (void *ctx,\r
+ {\r
+     notmuch_message_t *message;\r
+     notmuch_bool_t match;\r
++    notmuch_bool_t excluded;\r
+     int first_set = 1;\r
+     int next_indent;\r
+     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;\r
+@@ -885,10 +886,11 @@ show_messages (void *ctx,\r
+       message = notmuch_messages_get (messages);\r
+ \r
+       match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);\r
++      excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);\r
+ \r
+       next_indent = indent;\r
+ \r
+-      if (match || params->entire_thread) {\r
++      if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {\r
+           status = show_message (ctx, format, message, indent, params);\r
+           if (status && !res)\r
+               res = status;\r
+@@ -996,6 +998,12 @@ enum {\r
+     NOTMUCH_FORMAT_RAW\r
+ };\r
+ \r
++/* The following is to allow future options to be added more easily */\r
++enum {\r
++    EXCLUDE_TRUE,\r
++    EXCLUDE_FALSE,\r
++};\r
++\r
+ int\r
+ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+ {\r
+@@ -1005,10 +1013,10 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+     char *query_string;\r
+     int opt_index, ret;\r
+     const notmuch_show_format_t *format = &format_text;\r
+-    notmuch_show_params_t params = { .part = -1 };\r
++    notmuch_show_params_t params = { .part = -1, .omit_excluded = TRUE };\r
+     int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;\r
+     notmuch_bool_t verify = FALSE;\r
+-    notmuch_bool_t no_exclude = FALSE;\r
++    int exclude = EXCLUDE_TRUE;\r
+ \r
+     notmuch_opt_desc_t options[] = {\r
+       { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',\r
+@@ -1017,11 +1025,14 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+                                 { "mbox", NOTMUCH_FORMAT_MBOX },\r
+                                 { "raw", NOTMUCH_FORMAT_RAW },\r
+                                 { 0, 0 } } },\r
++        { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',\r
++          (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },\r
++                                  { "false", EXCLUDE_FALSE },\r
++                                  { 0, 0 } } },\r
+       { NOTMUCH_OPT_INT, &params.part, "part", 'p', 0 },\r
+       { NOTMUCH_OPT_BOOLEAN, &params.entire_thread, "entire-thread", 't', 0 },\r
+       { NOTMUCH_OPT_BOOLEAN, &params.decrypt, "decrypt", 'd', 0 },\r
+       { NOTMUCH_OPT_BOOLEAN, &verify, "verify", 'v', 0 },\r
+-      { NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'n', 0 },\r
+       { 0, 0, 0, 0, 0 }\r
+     };\r
+ \r
+@@ -1110,29 +1121,30 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+       return 1;\r
+     }\r
+ \r
+-    /* if format=mbox then we can not output excluded messages as\r
+-     * there is no way to make the exclude flag available */\r
+-    if (format_sel == NOTMUCH_FORMAT_MBOX)\r
+-      notmuch_query_set_omit_excluded_messages (query, TRUE);\r
+-\r
+     /* If a single message is requested we do not use search_excludes. */\r
+     if (params.part >= 0)\r
+       ret = do_show_single (ctx, query, format, &params);\r
+     else {\r
+-      if (!no_exclude) {\r
+-          const char **search_exclude_tags;\r
+-          size_t search_exclude_tags_length;\r
+-          unsigned int i;\r
+-\r
+-          search_exclude_tags = notmuch_config_get_search_exclude_tags\r
+-              (config, &search_exclude_tags_length);\r
+-          for (i = 0; i < search_exclude_tags_length; i++)\r
+-              notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);\r
++      /* We always apply set the exclude flag. The\r
++       * exclude=true|false option controls whether or not we return\r
++       * threads that only match in an excluded message */\r
++      const char **search_exclude_tags;\r
++      size_t search_exclude_tags_length;\r
++      unsigned int i;\r
++\r
++      search_exclude_tags = notmuch_config_get_search_exclude_tags\r
++          (config, &search_exclude_tags_length);\r
++      for (i = 0; i < search_exclude_tags_length; i++)\r
++          notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);\r
++\r
++      if (exclude == EXCLUDE_FALSE) {\r
++          notmuch_query_set_omit_excluded (query, FALSE);\r
++          params.omit_excluded = FALSE;\r
+       }\r
++\r
+       ret = do_show (ctx, query, format, &params);\r
+     }\r
+ \r
+-\r
+     notmuch_query_destroy (query);\r
+     notmuch_database_close (notmuch);\r
+ \r
+-- \r
+1.7.9.1\r
+\r