[PATCH 3/3] Use the S-Expression structured printer in notmuch show and notmuch reply.

diff --git a/bc/1d3c348f0999ffb626a8fc2c61d4de13e7ea77 b/bc/1d3c348f0999ffb626a8fc2c61d4de13e7ea77
new file mode 100644 (file)
index 0000000..0a8e5ce
--- /dev/null
+++ b/bc/1d3c348f0999ffb626a8fc2c61d4de13e7ea77
@@ -0,0 +1,383 @@
+Return-Path: <nex@nexoid.at>\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 50825431FAF\r
+       for <notmuch@notmuchmail.org>; Fri, 30 Nov 2012 00:35:13 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.001\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.001 tagged_above=-999 required=5\r
+       tests=[FREEMAIL_FROM=0.001] 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 GciJoh2Oo4EN for <notmuch@notmuchmail.org>;\r
+       Fri, 30 Nov 2012 00:35:11 -0800 (PST)\r
+Received: from mail.nexoid.at (www.nexoid.at [178.79.130.240])\r
+       (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 045B4431FC0\r
+       for <notmuch@notmuchmail.org>; Fri, 30 Nov 2012 00:35:10 -0800 (PST)\r
+Received: by mail.nexoid.at (Postfix, from userid 1000)\r
+       id A927F11C0D2; Fri, 30 Nov 2012 09:29:18 +0100 (CET)\r
+From: Peter Feigl <craven@gmx.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 3/3] Use the S-Expression structured printer in notmuch show\r
+       and notmuch reply.\r
+Date: Fri, 30 Nov 2012 09:29:03 +0100\r
+Message-Id: <1354264143-30173-3-git-send-email-craven@gmx.net>\r
+X-Mailer: git-send-email 1.8.0\r
+In-Reply-To: <1354264143-30173-1-git-send-email-craven@gmx.net>\r
+References: <1354264143-30173-1-git-send-email-craven@gmx.net>\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, 30 Nov 2012 08:35:13 -0000\r
+\r
+This commit changes the json printer (which doesn't do anything\r
+json-specific anyway but just uses the structured printers) to generic\r
+sprinters, and adds support for the printer defined in sprinter-sexp.c.\r
+---\r
+ notmuch-client.h |  8 ++++----\r
+ notmuch-reply.c  | 40 ++++++++++++++++++++++++----------------\r
+ notmuch-show.c   | 48 +++++++++++++++++++++++++++++-------------------\r
+ 3 files changed, 57 insertions(+), 39 deletions(-)\r
+\r
+diff --git a/notmuch-client.h b/notmuch-client.h\r
+index ae9344b..1c336dc 100644\r
+--- a/notmuch-client.h\r
++++ b/notmuch-client.h\r
+@@ -175,12 +175,12 @@ notmuch_status_t\r
+ show_one_part (const char *filename, int part);\r
+ \r
+ void\r
+-format_part_json (const void *ctx, struct sprinter *sp, mime_node_t *node,\r
+-                notmuch_bool_t first, notmuch_bool_t output_body);\r
++format_part_sprinter (const void *ctx, struct sprinter *sp, mime_node_t *node,\r
++                    notmuch_bool_t first, notmuch_bool_t output_body);\r
+ \r
+ void\r
+-format_headers_json (struct sprinter *sp, GMimeMessage *message,\r
+-                   notmuch_bool_t reply);\r
++format_headers_sprinter (struct sprinter *sp, GMimeMessage *message,\r
++                       notmuch_bool_t reply);\r
+ \r
+ typedef enum {\r
+     NOTMUCH_SHOW_TEXT_PART_REPLY = 1 << 0,\r
+diff --git a/notmuch-reply.c b/notmuch-reply.c\r
+index e60a264..a7469a2 100644\r
+--- a/notmuch-reply.c\r
++++ b/notmuch-reply.c\r
+@@ -548,7 +548,8 @@ notmuch_reply_format_default(void *ctx,\r
+                            notmuch_config_t *config,\r
+                            notmuch_query_t *query,\r
+                            notmuch_show_params_t *params,\r
+-                           notmuch_bool_t reply_all)\r
++                           notmuch_bool_t reply_all,\r
++                           unused (sprinter_t *sp))\r
+ {\r
+     GMimeMessage *reply;\r
+     notmuch_messages_t *messages;\r
+@@ -587,17 +588,17 @@ notmuch_reply_format_default(void *ctx,\r
+ }\r
+ \r
+ static int\r
+-notmuch_reply_format_json(void *ctx,\r
+-                        notmuch_config_t *config,\r
+-                        notmuch_query_t *query,\r
+-                        notmuch_show_params_t *params,\r
+-                        notmuch_bool_t reply_all)\r
++notmuch_reply_format_sprinter(void *ctx,\r
++                            notmuch_config_t *config,\r
++                            notmuch_query_t *query,\r
++                            notmuch_show_params_t *params,\r
++                            notmuch_bool_t reply_all,\r
++                            sprinter_t *sp)\r
+ {\r
+     GMimeMessage *reply;\r
+     notmuch_messages_t *messages;\r
+     notmuch_message_t *message;\r
+     mime_node_t *node;\r
+-    sprinter_t *sp;\r
+ \r
+     if (notmuch_query_count_messages (query) != 1) {\r
+       fprintf (stderr, "Error: search term did not match precisely one message.\n");\r
+@@ -613,18 +614,17 @@ notmuch_reply_format_json(void *ctx,\r
+     if (!reply)\r
+       return 1;\r
+ \r
+-    sp = sprinter_json_create (ctx, stdout);\r
+     sp->begin_map (sp);\r
+ \r
+     /* The headers of the reply message we've created */\r
+     sp->map_key (sp, "reply-headers");\r
+-    format_headers_json (sp, reply, TRUE);\r
++    format_headers_sprinter (sp, reply, TRUE);\r
+     g_object_unref (G_OBJECT (reply));\r
+     reply = NULL;\r
+ \r
+     /* Start the original */\r
+     sp->map_key (sp, "original");\r
+-    format_part_json (ctx, sp, node, TRUE, TRUE);\r
++    format_part_sprinter (ctx, sp, node, TRUE, TRUE);\r
+ \r
+     /* End */\r
+     sp->end (sp);\r
+@@ -639,7 +639,8 @@ notmuch_reply_format_headers_only(void *ctx,\r
+                                 notmuch_config_t *config,\r
+                                 notmuch_query_t *query,\r
+                                 unused (notmuch_show_params_t *params),\r
+-                                notmuch_bool_t reply_all)\r
++                                notmuch_bool_t reply_all,\r
++                                unused (sprinter_t *sp))\r
+ {\r
+     GMimeMessage *reply;\r
+     notmuch_messages_t *messages;\r
+@@ -696,6 +697,7 @@ notmuch_reply_format_headers_only(void *ctx,\r
+ enum {\r
+     FORMAT_DEFAULT,\r
+     FORMAT_JSON,\r
++    FORMAT_SEXP,\r
+     FORMAT_HEADERS_ONLY,\r
+ };\r
+ \r
+@@ -707,7 +709,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])\r
+     notmuch_query_t *query;\r
+     char *query_string;\r
+     int opt_index, ret = 0;\r
+-    int (*reply_format_func)(void *ctx, notmuch_config_t *config, notmuch_query_t *query, notmuch_show_params_t *params, notmuch_bool_t reply_all);\r
++    int (*reply_format_func)(void *ctx, notmuch_config_t *config, notmuch_query_t *query, notmuch_show_params_t *params, notmuch_bool_t reply_all, struct sprinter *sp);\r
+     notmuch_show_params_t params = {\r
+       .part = -1,\r
+       .crypto = {\r
+@@ -717,11 +719,13 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])\r
+     };\r
+     int format = FORMAT_DEFAULT;\r
+     int reply_all = TRUE;\r
++    struct sprinter *sp = NULL;\r
+ \r
+     notmuch_opt_desc_t options[] = {\r
+       { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',\r
+         (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },\r
+                                 { "json", FORMAT_JSON },\r
++                                { "sexp", FORMAT_SEXP },\r
+                                 { "headers-only", FORMAT_HEADERS_ONLY },\r
+                                 { 0, 0 } } },\r
+       { NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r',\r
+@@ -740,9 +744,13 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])\r
+ \r
+     if (format == FORMAT_HEADERS_ONLY)\r
+       reply_format_func = notmuch_reply_format_headers_only;\r
+-    else if (format == FORMAT_JSON)\r
+-      reply_format_func = notmuch_reply_format_json;\r
+-    else\r
++    else if (format == FORMAT_JSON) {\r
++      reply_format_func = notmuch_reply_format_sprinter;\r
++      sp = sprinter_json_create(ctx, stdout);\r
++    } else if (format == FORMAT_SEXP) {\r
++      reply_format_func = notmuch_reply_format_sprinter;\r
++      sp = sprinter_sexp_create(ctx, stdout);\r
++    } else\r
+       reply_format_func = notmuch_reply_format_default;\r
+ \r
+     config = notmuch_config_open (ctx, NULL, NULL);\r
+@@ -770,7 +778,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])\r
+       return 1;\r
+     }\r
+ \r
+-    if (reply_format_func (ctx, config, query, &params, reply_all) != 0)\r
++    if (reply_format_func (ctx, config, query, &params, reply_all, sp) != 0)\r
+       return 1;\r
+ \r
+     notmuch_crypto_cleanup (&params.crypto);\r
+diff --git a/notmuch-show.c b/notmuch-show.c\r
+index 2fa2292..e6da2ff 100644\r
+--- a/notmuch-show.c\r
++++ b/notmuch-show.c\r
+@@ -32,12 +32,17 @@ static const notmuch_show_format_t format_text = {\r
+ };\r
+ \r
+ static notmuch_status_t\r
+-format_part_json_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
++format_part_sprinter_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+                       int indent, const notmuch_show_params_t *params);\r
+ \r
+ static const notmuch_show_format_t format_json = {\r
+     .new_sprinter = sprinter_json_create,\r
+-    .part = format_part_json_entry,\r
++    .part = format_part_sprinter_entry,\r
++};\r
++\r
++static const notmuch_show_format_t format_sexp = {\r
++    .new_sprinter = sprinter_sexp_create,\r
++    .part = format_part_sprinter_entry,\r
+ };\r
+ \r
+ static notmuch_status_t\r
+@@ -108,9 +113,9 @@ _get_one_line_summary (const void *ctx, notmuch_message_t *message)\r
+ /* Emit a sequence of key/value pairs for the metadata of message.\r
+  * The caller should begin a map before calling this. */\r
+ static void\r
+-format_message_json (sprinter_t *sp, notmuch_message_t *message)\r
++format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)\r
+ {\r
+-    /* Any changes to the JSON format should be reflected in the file\r
++    /* Any changes to the JSON or S-Expression format should be reflected in the file\r
+      * devel/schemata. */\r
+ \r
+     void *local = talloc_new (NULL);\r
+@@ -208,7 +213,7 @@ _is_from_line (const char *line)\r
+ }\r
+ \r
+ void\r
+-format_headers_json (sprinter_t *sp, GMimeMessage *message,\r
++format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,\r
+                    notmuch_bool_t reply)\r
+ {\r
+     /* Any changes to the JSON format should be reflected in the file\r
+@@ -363,7 +368,7 @@ signer_status_to_string (GMimeSignerStatus x)\r
+ \r
+ #ifdef GMIME_ATLEAST_26\r
+ static void\r
+-format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)\r
++format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)\r
+ {\r
+     /* Any changes to the JSON format should be reflected in the file\r
+      * devel/schemata. */\r
+@@ -438,7 +443,7 @@ format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)\r
+ }\r
+ #else\r
+ static void\r
+-format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)\r
++format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)\r
+ {\r
+     const GMimeSignatureValidity* validity = node->sig_validity;\r
+ \r
+@@ -595,7 +600,7 @@ format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+ }\r
+ \r
+ void\r
+-format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
++format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+                 notmuch_bool_t first, notmuch_bool_t output_body)\r
+ {\r
+     /* Any changes to the JSON format should be reflected in the file\r
+@@ -603,15 +608,15 @@ format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+ \r
+     if (node->envelope_file) {\r
+       sp->begin_map (sp);\r
+-      format_message_json (sp, node->envelope_file);\r
++      format_message_sprinter (sp, node->envelope_file);\r
+ \r
+       sp->map_key (sp, "headers");\r
+-      format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);\r
++      format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);\r
+ \r
+       if (output_body) {\r
+           sp->map_key (sp, "body");\r
+           sp->begin_list (sp);\r
+-          format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE);\r
++          format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE);\r
+           sp->end (sp);\r
+       }\r
+       sp->end (sp);\r
+@@ -646,7 +651,7 @@ format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+ \r
+     if (node->verify_attempted) {\r
+       sp->map_key (sp, "sigstatus");\r
+-      format_part_sigstatus_json (sp, node);\r
++      format_part_sigstatus_sprinter (sp, node);\r
+     }\r
+ \r
+     sp->map_key (sp, "content-type");\r
+@@ -698,7 +703,7 @@ format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+       sp->begin_map (sp);\r
+ \r
+       sp->map_key (sp, "headers");\r
+-      format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);\r
++      format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);\r
+ \r
+       sp->map_key (sp, "body");\r
+       sp->begin_list (sp);\r
+@@ -706,7 +711,7 @@ format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+     }\r
+ \r
+     for (i = 0; i < node->nchildren; i++)\r
+-      format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE);\r
++      format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE);\r
+ \r
+     /* Close content structures */\r
+     for (i = 0; i < nclose; i++)\r
+@@ -716,11 +721,11 @@ format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,\r
+ }\r
+ \r
+ static notmuch_status_t\r
+-format_part_json_entry (const void *ctx, sprinter_t *sp,\r
++format_part_sprinter_entry (const void *ctx, sprinter_t *sp,\r
+                       mime_node_t *node, unused (int indent),\r
+                       const notmuch_show_params_t *params)\r
+ {\r
+-    format_part_json (ctx, sp, node, TRUE, params->output_body);\r
++    format_part_sprinter (ctx, sp, node, TRUE, params->output_body);\r
+ \r
+     return NOTMUCH_STATUS_SUCCESS;\r
+ }\r
+@@ -1012,6 +1017,7 @@ do_show (void *ctx,\r
+ enum {\r
+     NOTMUCH_FORMAT_NOT_SPECIFIED,\r
+     NOTMUCH_FORMAT_JSON,\r
++    NOTMUCH_FORMAT_SEXP,\r
+     NOTMUCH_FORMAT_TEXT,\r
+     NOTMUCH_FORMAT_MBOX,\r
+     NOTMUCH_FORMAT_RAW\r
+@@ -1056,6 +1062,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+       { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',\r
+         (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },\r
+                                 { "text", NOTMUCH_FORMAT_TEXT },\r
++                                { "sexp", NOTMUCH_FORMAT_SEXP },\r
+                                 { "mbox", NOTMUCH_FORMAT_MBOX },\r
+                                 { "raw", NOTMUCH_FORMAT_RAW },\r
+                                 { 0, 0 } } },\r
+@@ -1100,6 +1107,9 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+     case NOTMUCH_FORMAT_TEXT:\r
+       format = &format_text;\r
+       break;\r
++    case NOTMUCH_FORMAT_SEXP:\r
++      format = &format_sexp;\r
++      break;\r
+     case NOTMUCH_FORMAT_MBOX:\r
+       if (params.part > 0) {\r
+           fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");\r
+@@ -1120,7 +1130,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+ \r
+     /* Default is entire-thread = FALSE except for format=json. */\r
+     if (entire_thread == ENTIRE_THREAD_DEFAULT) {\r
+-      if (format == &format_json)\r
++      if (format == &format_json || format == &format_sexp)\r
+           entire_thread = ENTIRE_THREAD_TRUE;\r
+       else\r
+           entire_thread = ENTIRE_THREAD_FALSE;\r
+@@ -1131,8 +1141,8 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+           fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");\r
+           params.output_body = TRUE;\r
+       } else {\r
+-          if (format != &format_json)\r
+-              fprintf (stderr, "Warning: --body=false only implemented for format=json\n");\r
++          if (format != &format_json && format != &format_sexp)\r
++              fprintf (stderr, "Warning: --body=false only implemented for format=json or format=sexp\n");\r
+       }\r
+     }\r
+ \r
+-- \r
+1.8.0\r
+\r