Re: [PATCH v3 1/2] cli: make --entire-thread=false work for format=json.
[notmuch-archives.git] / 05 / 71942e5ad5c8cc25090fea51d6f8e5cf082a58
diff --git a/05/71942e5ad5c8cc25090fea51d6f8e5cf082a58 b/05/71942e5ad5c8cc25090fea51d6f8e5cf082a58
new file mode 100644 (file)
index 0000000..a0375ed
--- /dev/null
@@ -0,0 +1,188 @@
+Return-Path: <amdragon@mit.edu>\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 D5379431FAF\r
+       for <notmuch@notmuchmail.org>; Mon, 23 Apr 2012 18:47:57 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[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 HANXb8D-7IG6 for <notmuch@notmuchmail.org>;\r
+       Mon, 23 Apr 2012 18:47:57 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (DMZ-MAILSEC-SCANNER-5.MIT.EDU\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1BF43431FAE\r
+       for <notmuch@notmuchmail.org>; Mon, 23 Apr 2012 18:47:57 -0700 (PDT)\r
+X-AuditID: 12074422-b7fd66d0000008f9-b8-4f96064ba3c2\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 42.B5.02297.B46069F4; Mon, 23 Apr 2012 21:47:55 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q3O1ltuf005880; \r
+       Mon, 23 Apr 2012 21:47:55 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q3O1ls3u028479\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 23 Apr 2012 21:47:54 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1SMUrB-0004An-Qz; Mon, 23 Apr 2012 21:47:53 -0400\r
+Date: Mon, 23 Apr 2012 21:47:53 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH v3 1/2] cli: make --entire-thread=false work for\r
+       format=json.\r
+Message-ID: <20120424014753.GI17810@mit.edu>\r
+References: <1334999750-21811-1-git-send-email-markwalters1009@gmail.com>\r
+       <1334999750-21811-2-git-send-email-markwalters1009@gmail.com>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <1334999750-21811-2-git-send-email-markwalters1009@gmail.com>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFupnleLIzCtJLcpLzFFi42IRYrdT1/Vmm+ZvMOeGlsXquTwW12/OZHZg\r
+       8tg56y67x7NVt5gDmKK4bFJSczLLUov07RK4MibcX8BW8FehomfWTcYGxn2SXYycHBICJhKr\r
+       P09ngrDFJC7cW8/WxcjFISSwj1Fi/u+Z7BDOBkaJGW+amEGqhAROMkmsOmkCkVjCKPHq2R8W\r
+       kASLgKrE6q1fWUFsNgENiW37lzOC2CICOhK3Dy1gB7GZBaQlvv1uBlsnLBAs8XntWrB6XqCa\r
+       vQ3zGSGGdjJKLF5+hA0iIShxcuYTFohmLYkb/14CNXOADVr+jwMkzCngJfH1ym+w+aICKhJT\r
+       Tm5jm8AoNAtJ9ywk3bMQuhcwMq9ilE3JrdLNTczMKU5N1i1OTszLSy3SNdXLzSzRS00p3cQI\r
+       DmsXpR2MPw8qHWIU4GBU4uHNTJ/qL8SaWFZcmXuIUZKDSUmUl591mr8QX1J+SmVGYnFGfFFp\r
+       TmrxIUYJDmYlEd5H/4HKeVMSK6tSi/JhUtIcLErivOpa7/yEBNITS1KzU1MLUotgsjIcHEoS\r
+       vPEgQwWLUtNTK9Iyc0oQ0kwcnCDDeYCGTwGp4S0uSMwtzkyHyJ9i1OW49uXoFUYhlrz8vFQp\r
+       cd5CkCIBkKKM0jy4ObB09IpRHOgtYd5YkCoeYCqDm/QKaAkT0JKEmEkgS0oSEVJSDYwTav1L\r
+       3MPqsv4WrrAxDj7SeOiD1vankQ1fTjD89fjfnNlUY1BX3MbLv4At8ewGCRm3vrbHKQKsW78t\r
+       3zPnpP/N8Fy9m4sbjdf8658U5i+dZbPvAbPEserCFwJdrYseTzkicfi2QkT25AaZC6uTvDzD\r
+       Pb5mGLumWBcemXE8XKlUMsXg0SxbASWW4oxEQy3mouJEAP73LbYiAwAA\r
+Cc: notmuch@notmuchmail.org\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: Tue, 24 Apr 2012 01:47:58 -0000\r
+\r
+Quoth Mark Walters on Apr 21 at 10:15 am:\r
+> The --entire-thread option in notmuch-show.c defaults to true when\r
+> format=json. Previously there was no way to turn this off. This patch\r
+> makes it respect --entire-thread=false.\r
+> \r
+> The one subtlety is that we initialise a notmuch_bool_t to -1 to\r
+> indicate that the option parsing has not set it. This allows the code\r
+> to distinguish between the option being omitted from the command line,\r
+> and the option being set to false on the command line.\r
+> \r
+> Finally, all formats except Json can output empty messages for non\r
+> entire-thread, but in Json format we need to output {} to keep the\r
+> other elements (e.g. the replies to this message) in the correct\r
+> place.\r
+> ---\r
+>  notmuch-show.c |   34 +++++++++++++++++++++++++++++-----\r
+>  1 files changed, 29 insertions(+), 5 deletions(-)\r
+> \r
+> diff --git a/notmuch-show.c b/notmuch-show.c\r
+> index da4a797..327c263 100644\r
+> --- a/notmuch-show.c\r
+> +++ b/notmuch-show.c\r
+> @@ -800,6 +800,16 @@ format_part_raw (unused (const void *ctx), mime_node_t *node,\r
+>  }\r
+>  \r
+>  static notmuch_status_t\r
+> +show_null_message (const notmuch_show_format_t *format)\r
+> +{\r
+> +    /* For all formats except json an empty message output is valid;\r
+> +     * for json we need the braces.*/\r
+> +    if (format == &format_json)\r
+\r
+This should probably be specified as a field in the format, rather\r
+than using a hard-coded dispatch.  It could even be a plain string\r
+field that you could fputs in show_messages.\r
+\r
+> +    printf ("{}");\r
+\r
+This is a definite improvement over the current strangeness, but I\r
+think 'null' would be better than an empty object.  null is a clearly\r
+distinguished value, rather than something that initially has a\r
+message-like type, but then isn't a message.\r
+\r
+You should also update devel/schemata to reflect this change.\r
+\r
+> +    return NOTMUCH_STATUS_SUCCESS;\r
+> +}\r
+> +\r
+> +static notmuch_status_t\r
+>  show_message (void *ctx,\r
+>            const notmuch_show_format_t *format,\r
+>            notmuch_message_t *message,\r
+> @@ -862,11 +872,13 @@ show_messages (void *ctx,\r
+>          if (status && !res)\r
+>              res = status;\r
+>          next_indent = indent + 1;\r
+> -\r
+> -        if (!status && format->message_set_sep)\r
+> -            fputs (format->message_set_sep, stdout);\r
+> +    } else {\r
+> +        status = show_null_message (format);\r
+>      }\r
+>  \r
+> +    if (!status && format->message_set_sep)\r
+> +        fputs (format->message_set_sep, stdout);\r
+> +\r
+>      status = show_messages (ctx,\r
+>                              format,\r
+>                              notmuch_message_get_replies (message),\r
+\r
+I believe the stuff above could be a separate patch from the stuff\r
+below.\r
+\r
+> @@ -984,7 +996,13 @@ 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, .omit_excluded = TRUE };\r
+> +\r
+> +    /* We abuse the notmuch_bool_t variable params.entire-thread by\r
+> +     * setting it to -1 to denote that the command line parsing has\r
+> +     * not set it. We ensure it is set to TRUE or FALSE before passing\r
+> +     * it to any other function.*/\r
+> +    notmuch_show_params_t params = { .part = -1, .entire_thread = -1 };\r
+> +\r
+>      int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;\r
+>      notmuch_bool_t verify = FALSE;\r
+>      int exclude = EXCLUDE_TRUE;\r
+> @@ -1024,7 +1042,9 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>      switch (format_sel) {\r
+>      case NOTMUCH_FORMAT_JSON:\r
+>      format = &format_json;\r
+> -    params.entire_thread = TRUE;\r
+> +    /* JSON defaults to entire-thread TRUE */\r
+> +    if (params.entire_thread == -1)\r
+> +        params.entire_thread = TRUE;\r
+>      break;\r
+>      case NOTMUCH_FORMAT_TEXT:\r
+>      format = &format_text;\r
+> @@ -1046,6 +1066,10 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>      params.raw = TRUE;\r
+>      break;\r
+>      }\r
+> +    /* Default is entire-thread = FALSE except for format=json which\r
+> +     * is dealt with above. */\r
+> +    if (params.entire_thread == -1)\r
+> +    params.entire_thread = FALSE;\r
+>  \r
+>      if (params.decrypt || verify) {\r
+>  #ifdef GMIME_ATLEAST_26\r