[PATCH v3 1/2] cli: make --entire-thread=false work for format=json.

[Austin Clements]

Quoth Mark Walters on Apr 21 at 10:15 am:
> The --entire-thread option in notmuch-show.c defaults to true when
> format=json. Previously there was no way to turn this off. This patch
> makes it respect --entire-thread=false.
> 
> The one subtlety is that we initialise a notmuch_bool_t to -1 to
> indicate that the option parsing has not set it. This allows the code
> to distinguish between the option being omitted from the command line,
> and the option being set to false on the command line.
> 
> Finally, all formats except Json can output empty messages for non
> entire-thread, but in Json format we need to output {} to keep the
> other elements (e.g. the replies to this message) in the correct
> place.
> ---
>  notmuch-show.c |   34 +++++++++++++++++++++++++++++-----
>  1 files changed, 29 insertions(+), 5 deletions(-)
> 
> diff --git a/notmuch-show.c b/notmuch-show.c
> index da4a797..327c263 100644
> --- a/notmuch-show.c
> +++ b/notmuch-show.c
> @@ -800,6 +800,16 @@ format_part_raw (unused (const void *ctx), mime_node_t *node,
>  }
>  
>  static notmuch_status_t
> +show_null_message (const notmuch_show_format_t *format)
> +{
> +    /* For all formats except json an empty message output is valid;
> +     * for json we need the braces.*/
> +    if (format == &format_json)

This should probably be specified as a field in the format, rather
than using a hard-coded dispatch.  It could even be a plain string
field that you could fputs in show_messages.

> +	printf ("{}");

This is a definite improvement over the current strangeness, but I
think 'null' would be better than an empty object.  null is a clearly
distinguished value, rather than something that initially has a
message-like type, but then isn't a message.

You should also update devel/schemata to reflect this change.

> +    return NOTMUCH_STATUS_SUCCESS;
> +}
> +
> +static notmuch_status_t
>  show_message (void *ctx,
>  	      const notmuch_show_format_t *format,
>  	      notmuch_message_t *message,
> @@ -862,11 +872,13 @@ show_messages (void *ctx,
>  	    if (status && !res)
>  		res = status;
>  	    next_indent = indent + 1;
> -
> -	    if (!status && format->message_set_sep)
> -		fputs (format->message_set_sep, stdout);
> +	} else {
> +	    status = show_null_message (format);
>  	}
>  
> +	if (!status && format->message_set_sep)
> +	    fputs (format->message_set_sep, stdout);
> +
>  	status = show_messages (ctx,
>  				format,
>  				notmuch_message_get_replies (message),

I believe the stuff above could be a separate patch from the stuff
below.

> @@ -984,7 +996,13 @@ 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, .omit_excluded = TRUE };
> +
> +    /* We abuse the notmuch_bool_t variable params.entire-thread by
> +     * setting it to -1 to denote that the command line parsing has
> +     * not set it. We ensure it is set to TRUE or FALSE before passing
> +     * it to any other function.*/
> +    notmuch_show_params_t params = { .part = -1, .entire_thread = -1 };
> +
>      int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
>      notmuch_bool_t verify = FALSE;
>      int exclude = EXCLUDE_TRUE;
> @@ -1024,7 +1042,9 @@ 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;
> +	/* JSON defaults to entire-thread TRUE */
> +	if (params.entire_thread == -1)
> +	    params.entire_thread = TRUE;
>  	break;
>      case NOTMUCH_FORMAT_TEXT:
>  	format = &format_text;
> @@ -1046,6 +1066,10 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
>  	params.raw = TRUE;
>  	break;
>      }
> +    /* Default is entire-thread = FALSE except for format=json which
> +     * is dealt with above. */
> +    if (params.entire_thread == -1)
> +	params.entire_thread = FALSE;
>  
>      if (params.decrypt || verify) {
>  #ifdef GMIME_ATLEAST_26