From: Mark Walters Date: Thu, 15 Mar 2012 18:42:04 +0000 (+0000) Subject: [PATCH 4/5] cli: move show to the new --exclude= option naming scheme. X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=21c47c525a57c701e69f829948d72db69c154902;p=notmuch-archives.git [PATCH 4/5] cli: move show to the new --exclude= option naming scheme. --- diff --git a/7a/54307c314ffc3860a9ac63b9329b05ef4fa93d b/7a/54307c314ffc3860a9ac63b9329b05ef4fa93d new file mode 100644 index 000000000..0e0c2d072 --- /dev/null +++ b/7a/54307c314ffc3860a9ac63b9329b05ef4fa93d @@ -0,0 +1,229 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id A3E8A429E34 + for ; Thu, 15 Mar 2012 11:42:26 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0.201 +X-Spam-Level: +X-Spam-Status: No, score=0.201 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001, + RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id E1FjWsKDpaKS for ; + Thu, 15 Mar 2012 11:42:24 -0700 (PDT) +Received: from mail-wi0-f179.google.com (mail-wi0-f179.google.com + [209.85.212.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 1A108431FAE + for ; Thu, 15 Mar 2012 11:42:23 -0700 (PDT) +Received: by mail-wi0-f179.google.com with SMTP id hn6so3844513wib.2 + for ; Thu, 15 Mar 2012 11:42:23 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; + bh=X7tkFsQY8U9jLo4+S2QF/rBwSLaAQ6WxxiIl/BwhV8Q=; + b=VvrGEM7WP4kqop5FZAUbKTHzPGlqLG475xTD/D1Ct7STONPQ4ZVTzXMPI9bJ6Hua9C + 6PWFjpiwTLC52cc5Wz7tcgCwNnN8117D+KwGWyh+sYz7nW2tImimwl7HHWtMvW+41U7X + AtEGgDVoeb3hBdcBj92FVRKcx5nssMR/Cgb6dVuxGiaEAx9SawIPXoafT8Pxh1HqANJN + tKK+7fDdmNw0ag8d1w+HT7U7LCU8ahMApql99zkSuKdQrwtK/VS3Sc116F6AtZLlrNM1 + NaR0icdEqdMk2kQ08vWeptvv5OCmxN4aSXWXNO9Mi5blIY2JG8jIIBBGItdi79dsoDJE + IObw== +Received: by 10.180.95.129 with SMTP id dk1mr1649820wib.3.1331836943775; + Thu, 15 Mar 2012 11:42:23 -0700 (PDT) +Received: from localhost (94-192-233-223.zone6.bethere.co.uk. + [94.192.233.223]) by mx.google.com with ESMTPS id + df3sm7082139wib.1.2012.03.15.11.42.22 (version=TLSv1/SSLv3 cipher=OTHER); + Thu, 15 Mar 2012 11:42:23 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org +Subject: [PATCH 4/5] cli: move show to the new --exclude= option naming + scheme. +Date: Thu, 15 Mar 2012 18:42:04 +0000 +Message-Id: <1331836925-31437-5-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <1331836925-31437-1-git-send-email-markwalters1009@gmail.com> +References: <1331836925-31437-1-git-send-email-markwalters1009@gmail.com> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +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: Thu, 15 Mar 2012 18:42:27 -0000 + +This moves show to the --exclude=(true|false|flag) naming +scheme. When `exclude' is false or flag show returns all threads +that match including those that only match in an excluded message, the +difference being whether excluded messages are flagged excluded. + +When exclude=true the behaviour depends on whether --entire-threads +is set. If it is not set then show only returns the messages which +match and are not excluded. If it is set then show returns all +messages in these threads flagging the excluded messages. The +rationale is that it is awkward to use a thread with some missing +messages. +--- + man/man1/notmuch-show.1 | 16 ++++++++++++++-- + notmuch-client.h | 1 + + notmuch-show.c | 39 +++++++++++++++++++++++++++++---------- + 3 files changed, 44 insertions(+), 12 deletions(-) + +diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 +index d75d971..801b7f1 100644 +--- a/man/man1/notmuch-show.1 ++++ b/man/man1/notmuch-show.1 +@@ -130,9 +130,21 @@ content. + + .RS 4 + .TP 4 +-.B \-\-no-exclude ++.BR \-\-exclude=(true|false|flag) ++ ++Specify whether to omit threads only matching search.tag_exclude from ++the search results (the default) or not. The extra option ++.B flag ++includes these messages but marks them with the excluded flag. ++ ++If --entire-thread is specified then complete threads are returned ++regardless (with the excluded flag being set when appropriate) but ++threads that only match in an excluded message are not returned when ++.B --exclude=true. ++ ++The default is ++.B --exclude=true. + +-Do not exclude the messages matching search.exclude_tags in the config file. + .RE + + A common use of +diff --git a/notmuch-client.h b/notmuch-client.h +index f4a62cc..e36148b 100644 +--- a/notmuch-client.h ++++ b/notmuch-client.h +@@ -99,6 +99,7 @@ typedef struct notmuch_show_format { + + typedef struct notmuch_show_params { + notmuch_bool_t entire_thread; ++ notmuch_bool_t omit_excluded; + notmuch_bool_t raw; + int part; + #ifdef GMIME_ATLEAST_26 +diff --git a/notmuch-show.c b/notmuch-show.c +index 05d51b2..20d6635 100644 +--- a/notmuch-show.c ++++ b/notmuch-show.c +@@ -812,6 +812,7 @@ show_messages (void *ctx, + { + notmuch_message_t *message; + notmuch_bool_t match; ++ notmuch_bool_t excluded; + int first_set = 1; + int next_indent; + +@@ -830,10 +831,11 @@ show_messages (void *ctx, + message = notmuch_messages_get (messages); + + match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH); ++ excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED); + + next_indent = indent; + +- if (match || params->entire_thread) { ++ if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) { + show_message (ctx, format, message, indent, params); + next_indent = indent + 1; + +@@ -974,6 +976,12 @@ enum { + NOTMUCH_FORMAT_RAW + }; + ++enum { ++ EXCLUDE_TRUE, ++ EXCLUDE_FALSE, ++ EXCLUDE_FLAG, ++}; ++ + int + notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) + { +@@ -983,10 +991,10 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) + char *query_string; + int opt_index, ret; + const notmuch_show_format_t *format = &format_text; +- notmuch_show_params_t params = { .part = -1 }; ++ notmuch_show_params_t params = { .part = -1, .omit_excluded = TRUE }; + int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED; + notmuch_bool_t verify = FALSE; +- notmuch_bool_t no_exclude = FALSE; ++ int exclude = EXCLUDE_TRUE; + + notmuch_opt_desc_t options[] = { + { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f', +@@ -995,11 +1003,15 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) + { "mbox", NOTMUCH_FORMAT_MBOX }, + { "raw", NOTMUCH_FORMAT_RAW }, + { 0, 0 } } }, ++ { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x', ++ (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE }, ++ { "false", EXCLUDE_FALSE }, ++ { "flag", EXCLUDE_FLAG }, ++ { 0, 0 } } }, + { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.entire_thread, "entire-thread", 't', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.decrypt, "decrypt", 'd', 0 }, + { NOTMUCH_OPT_BOOLEAN, &verify, "verify", 'v', 0 }, +- { NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'n', 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -1088,16 +1100,18 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) + return 1; + } + +- /* if format=mbox then we can not output excluded messages as +- * there is no way to make the exclude flag available */ +- if (format_sel == NOTMUCH_FORMAT_MBOX) +- notmuch_query_set_omit_excluded_messages (query, TRUE); +- + /* If a single message is requested we do not use search_excludes. */ + if (params.part >= 0) + ret = do_show_single (ctx, query, format, ¶ms); + else { +- if (!no_exclude) { ++ if (format == &format_mbox && exclude == EXCLUDE_FLAG) { ++ /* there is no where to mark flagged messages so fall back on ++ * including the excluded messages */ ++ fprintf (stderr, "Cannot flag excluded messages with format=mbox: fall back on just including them\n"); ++ exclude = EXCLUDE_FALSE; ++ } ++ ++ if (exclude != EXCLUDE_FALSE) { + const char **search_exclude_tags; + size_t search_exclude_tags_length; + unsigned int i; +@@ -1106,7 +1120,12 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) + (config, &search_exclude_tags_length); + for (i = 0; i < search_exclude_tags_length; i++) + notmuch_query_add_tag_exclude (query, search_exclude_tags[i]); ++ if (exclude == EXCLUDE_FLAG) { ++ notmuch_query_set_omit_excluded_messages(query, FALSE); ++ params.omit_excluded = FALSE; ++ } + } ++ + ret = do_show (ctx, query, format, ¶ms); + } + +-- +1.7.9.1 +