show: Feed the sprinter down to part formatters

[notmuch] / notmuch-show.c

diff --git a/notmuch-show.c b/notmuch-show.c
index b00446843e37894f1966b6fdb8037f01f351b8c8..b258f656c09d38653db6fa84eb3c1daf492d6a33 100644 (file)
--- a/notmuch-show.c
+++ b/notmuch-show.c
@@ -20,20 +20,23 @@
 
 #include "notmuch-client.h"
 #include "gmime-filter-reply.h"
+#include "sprinter.h"
 
 static notmuch_status_t
-format_part_text (const void *ctx, mime_node_t *node,
+format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
                  int indent, const notmuch_show_params_t *params);
 
 static const notmuch_show_format_t format_text = {
+    .new_sprinter = sprinter_text_create,
     .part = format_part_text,
 };
 
 static notmuch_status_t
-format_part_json_entry (const void *ctx, mime_node_t *node,
+format_part_json_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,
                        int indent, const notmuch_show_params_t *params);
 
 static const notmuch_show_format_t format_json = {
+    .new_sprinter = sprinter_json_create,
     .message_set_start = "[",
     .part = format_part_json_entry,
     .message_set_sep = ", ",
@@ -42,19 +45,21 @@ static const notmuch_show_format_t format_json = {
 };
 
 static notmuch_status_t
-format_part_mbox (const void *ctx, mime_node_t *node,
+format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node,
                  int indent, const notmuch_show_params_t *params);
 
 static const notmuch_show_format_t format_mbox = {
+    .new_sprinter = sprinter_text_create,
     .part = format_part_mbox,
 };
 
 static notmuch_status_t
-format_part_raw (unused (const void *ctx), mime_node_t *node,
+format_part_raw (unused (const void *ctx), sprinter_t *sp, mime_node_t *node,
                 unused (int indent),
                 unused (const notmuch_show_params_t *params));
 
 static const notmuch_show_format_t format_raw = {
+    .new_sprinter = sprinter_text_create,
     .part = format_part_raw,
 };
 
@@ -466,7 +471,7 @@ format_part_sigstatus_json (mime_node_t *node)
 #endif
 
 static notmuch_status_t
-format_part_text (const void *ctx, mime_node_t *node,
+format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
                  int indent, const notmuch_show_params_t *params)
 {
     /* The disposition and content-type metadata are associated with
@@ -548,7 +553,7 @@ format_part_text (const void *ctx, mime_node_t *node,
     }
 
     for (i = 0; i < node->nchildren; i++)
-       format_part_text (ctx, mime_node_child (node, i), indent, params);
+       format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
 
     if (GMIME_IS_MESSAGE (node->part))
        printf ("\fbody}\n");
@@ -559,7 +564,8 @@ format_part_text (const void *ctx, mime_node_t *node,
 }
 
 void
-format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
+format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,
+                 notmuch_bool_t first, notmuch_bool_t output_body)
 {
     /* Any changes to the JSON format should be reflected in the file
      * devel/schemata. */
@@ -571,10 +577,12 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
        printf ("\"headers\": ");
        format_headers_json (ctx, GMIME_MESSAGE (node->part), FALSE);
 
-       printf (", \"body\": [");
-       format_part_json (ctx, mime_node_child (node, 0), first);
-
-       printf ("]}");
+       if (output_body) {
+           printf (", \"body\": [");
+           format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE);
+           printf ("]");
+       }
+       printf ("}");
        return;
     }
 
@@ -652,16 +660,17 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
     talloc_free (local);
 
     for (i = 0; i < node->nchildren; i++)
-       format_part_json (ctx, mime_node_child (node, i), i == 0);
+       format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE);
 
     printf ("%s}", terminator);
 }
 
 static notmuch_status_t
-format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent),
-                       unused (const notmuch_show_params_t *params))
+format_part_json_entry (const void *ctx, sprinter_t *sp,
+                       mime_node_t *node, unused (int indent),
+                       const notmuch_show_params_t *params)
 {
-    format_part_json (ctx, node, TRUE);
+    format_part_json (ctx, sp, node, TRUE, params->output_body);
 
     return NOTMUCH_STATUS_SUCCESS;
 }
@@ -672,7 +681,8 @@ format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent),
  * http://qmail.org/qmail-manual-html/man5/mbox.html
  */
 static notmuch_status_t
-format_part_mbox (const void *ctx, mime_node_t *node, unused (int indent),
+format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
+                 unused (int indent),
                  unused (const notmuch_show_params_t *params))
 {
     notmuch_message_t *message = node->envelope_file;
@@ -723,8 +733,8 @@ format_part_mbox (const void *ctx, mime_node_t *node, unused (int indent),
 }
 
 static notmuch_status_t
-format_part_raw (unused (const void *ctx), mime_node_t *node,
-                unused (int indent),
+format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
+                mime_node_t *node, unused (int indent),
                 unused (const notmuch_show_params_t *params))
 {
     if (node->envelope_file) {
@@ -812,6 +822,7 @@ show_null_message (const notmuch_show_format_t *format)
 static notmuch_status_t
 show_message (void *ctx,
              const notmuch_show_format_t *format,
+             sprinter_t *sp,
              notmuch_message_t *message,
              int indent,
              notmuch_show_params_t *params)
@@ -825,7 +836,7 @@ show_message (void *ctx,
        goto DONE;
     part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
     if (part)
-       status = format->part (local, part, indent, params);
+       status = format->part (local, sp, part, indent, params);
   DONE:
     talloc_free (local);
     return status;
@@ -834,6 +845,7 @@ show_message (void *ctx,
 static notmuch_status_t
 show_messages (void *ctx,
               const notmuch_show_format_t *format,
+              sprinter_t *sp,
               notmuch_messages_t *messages,
               int indent,
               notmuch_show_params_t *params)
@@ -867,7 +879,7 @@ show_messages (void *ctx,
        next_indent = indent;
 
        if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
-           status = show_message (ctx, format, message, indent, params);
+           status = show_message (ctx, format, sp, message, indent, params);
            if (status && !res)
                res = status;
            next_indent = indent + 1;
@@ -879,7 +891,7 @@ show_messages (void *ctx,
            fputs (format->message_set_sep, stdout);
 
        status = show_messages (ctx,
-                               format,
+                               format, sp,
                                notmuch_message_get_replies (message),
                                next_indent,
                                params);
@@ -903,6 +915,7 @@ static int
 do_show_single (void *ctx,
                notmuch_query_t *query,
                const notmuch_show_format_t *format,
+               sprinter_t *sp,
                notmuch_show_params_t *params)
 {
     notmuch_messages_t *messages;
@@ -923,7 +936,8 @@ do_show_single (void *ctx,
 
     notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 
-    return show_message (ctx, format, message, 0, params) != NOTMUCH_STATUS_SUCCESS;
+    return show_message (ctx, format, sp, message, 0, params)
+       != NOTMUCH_STATUS_SUCCESS;
 }
 
 /* Formatted output of threads */
@@ -931,6 +945,7 @@ static int
 do_show (void *ctx,
         notmuch_query_t *query,
         const notmuch_show_format_t *format,
+        sprinter_t *sp,
         notmuch_show_params_t *params)
 {
     notmuch_threads_t *threads;
@@ -958,7 +973,7 @@ do_show (void *ctx,
            fputs (format->message_set_sep, stdout);
        first_toplevel = 0;
 
-       status = show_messages (ctx, format, messages, 0, params);
+       status = show_messages (ctx, format, sp, messages, 0, params);
        if (status && !res)
            res = status;
 
@@ -980,6 +995,12 @@ enum {
     NOTMUCH_FORMAT_RAW
 };
 
+enum {
+    ENTIRE_THREAD_DEFAULT,
+    ENTIRE_THREAD_TRUE,
+    ENTIRE_THREAD_FALSE,
+};
+
 /* The following is to allow future options to be added more easily */
 enum {
     EXCLUDE_TRUE,
@@ -995,9 +1016,11 @@ 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;
+    sprinter_t *sprinter;
     notmuch_show_params_t params = {
        .part = -1,
        .omit_excluded = TRUE,
+       .output_body = TRUE,
        .crypto = {
            .verify = FALSE,
            .decrypt = FALSE
@@ -1005,6 +1028,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     };
     int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
     int exclude = EXCLUDE_TRUE;
+    int entire_thread = ENTIRE_THREAD_DEFAULT;
 
     notmuch_opt_desc_t options[] = {
        { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
@@ -1013,14 +1037,19 @@ 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 },
-                                  { 0, 0 } } },
+       { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
+         (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
+                                 { "false", EXCLUDE_FALSE },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
+         (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
+                                 { "false", ENTIRE_THREAD_FALSE },
+                                 { "", ENTIRE_THREAD_TRUE },
+                                 { 0, 0 } } },
        { NOTMUCH_OPT_INT, &params.part, "part", 'p', 0 },
-       { NOTMUCH_OPT_BOOLEAN, &params.entire_thread, "entire-thread", 't', 0 },
        { NOTMUCH_OPT_BOOLEAN, &params.crypto.decrypt, "decrypt", 'd', 0 },
        { NOTMUCH_OPT_BOOLEAN, &params.crypto.verify, "verify", 'v', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &params.output_body, "body", 'b', 0 },
        { 0, 0, 0, 0, 0 }
     };
 
@@ -1045,7 +1074,6 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     switch (format_sel) {
     case NOTMUCH_FORMAT_JSON:
        format = &format_json;
-       params.entire_thread = TRUE;
        break;
     case NOTMUCH_FORMAT_TEXT:
        format = &format_text;
@@ -1068,6 +1096,29 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        break;
     }
 
+    /* Default is entire-thread = FALSE except for format=json. */
+    if (entire_thread == ENTIRE_THREAD_DEFAULT) {
+       if (format == &format_json)
+           entire_thread = ENTIRE_THREAD_TRUE;
+       else
+           entire_thread = ENTIRE_THREAD_FALSE;
+    }
+
+    if (!params.output_body) {
+       if (params.part > 0) {
+           fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
+           params.output_body = TRUE;
+       } else {
+           if (format != &format_json)
+               fprintf (stderr, "Warning: --body=false only implemented for format=json\n");
+       }
+    }
+
+    if (entire_thread == ENTIRE_THREAD_TRUE)
+       params.entire_thread = TRUE;
+    else
+       params.entire_thread = FALSE;
+
     config = notmuch_config_open (ctx, NULL, NULL);
     if (config == NULL)
        return 1;
@@ -1093,9 +1144,12 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        return 1;
     }
 
+    /* Create structure printer. */
+    sprinter = format->new_sprinter(ctx, stdout);
+
     /* If a single message is requested we do not use search_excludes. */
     if (params.part >= 0)
-       ret = do_show_single (ctx, query, format, &params);
+       ret = do_show_single (ctx, query, format, sprinter, &params);
     else {
        /* We always apply set the exclude flag. The
         * exclude=true|false option controls whether or not we return
@@ -1114,7 +1168,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
            params.omit_excluded = FALSE;
        }
 
-       ret = do_show (ctx, query, format, &params);
+       ret = do_show (ctx, query, format, sprinter, &params);
     }
 
     notmuch_crypto_cleanup (&params.crypto);