Re: [PATCH v4 2/3] Add structured output formatter for JSON.
authorTomi Ollila <tomi.ollila@iki.fi>
Thu, 12 Jul 2012 10:10:27 +0000 (13:10 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:48:12 +0000 (09:48 -0800)
cb/3eed81a6b0743fa367886d39a2755faad8135d [new file with mode: 0644]

diff --git a/cb/3eed81a6b0743fa367886d39a2755faad8135d b/cb/3eed81a6b0743fa367886d39a2755faad8135d
new file mode 100644 (file)
index 0000000..c9a7242
--- /dev/null
@@ -0,0 +1,274 @@
+Return-Path: <tomi.ollila@iki.fi>\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 BBB41429E25\r
+       for <notmuch@notmuchmail.org>; Thu, 12 Jul 2012 03:10:16 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 GjXzP1qn9fnk for <notmuch@notmuchmail.org>;\r
+       Thu, 12 Jul 2012 03:10:16 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id ACAC8431FAE\r
+       for <notmuch@notmuchmail.org>; Thu, 12 Jul 2012 03:10:15 -0700 (PDT)\r
+Received: by guru.guru-group.fi (Postfix, from userid 501)\r
+       id 14508100386; Thu, 12 Jul 2012 13:10:27 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: craven@gmx.net, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v4 2/3] Add structured output formatter for JSON.\r
+In-Reply-To: <1342079004-5300-3-git-send-email-craven@gmx.net>\r
+References: <87d34hsdx8.fsf@awakening.csail.mit.edu>\r
+       <1342079004-5300-1-git-send-email-craven@gmx.net>\r
+       <1342079004-5300-3-git-send-email-craven@gmx.net>\r
+User-Agent: Notmuch/0.13.2+74~g65b26b0 (http://notmuchmail.org) Emacs/23.1.1\r
+       (x86_64-redhat-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Thu, 12 Jul 2012 13:10:27 +0300\r
+Message-ID: <m2vchtthm4.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\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: Thu, 12 Jul 2012 10:10:16 -0000\r
+\r
+On Thu, Jul 12 2012, craven@gmx.net wrote:\r
+\r
+> Using the new structured printer support in sprinter.h, implement\r
+> sprinter_json_new, which returns a new JSON structured output\r
+> formatter.\r
+>\r
+> The formatter prints output similar to the existing JSON, but with\r
+> differences in whitespace (mostly newlines).\r
+> ---\r
+>  Makefile.local |   1 +\r
+>  sprinter.c     | 172 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+>  2 files changed, 173 insertions(+)\r
+>  create mode 100644 sprinter.c\r
+>\r
+> diff --git a/Makefile.local b/Makefile.local\r
+> index a890df2..8baf0c2 100644\r
+> --- a/Makefile.local\r
+> +++ b/Makefile.local\r
+> @@ -290,6 +290,7 @@ notmuch_client_srcs =            \\r
+>      notmuch-show.c          \\r
+>      notmuch-tag.c           \\r
+>      notmuch-time.c          \\r
+> +    sprinter.c              \\r
+>      query-string.c          \\r
+>      mime-node.c             \\r
+>      crypto.c                \\r
+> diff --git a/sprinter.c b/sprinter.c\r
+> new file mode 100644\r
+> index 0000000..649f79a\r
+> --- /dev/null\r
+> +++ b/sprinter.c\r
+> @@ -0,0 +1,172 @@\r
+> +#include <stdbool.h>\r
+> +#include <stdio.h>\r
+> +#include <talloc.h>\r
+> +#include "sprinter.h"\r
+> +\r
+> +#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))\r
+\r
+You're including sprinter.h which includes notmuch-client.h which\r
+defines ARRAY_SIZE (Interesting that you did not get error(/warning?)\r
+about this)\r
+\r
+Rest looks good -- except the whitespace -- as I looked through Austin's\r
+code yesterday you're just replicated the same lines :D. Easiest\r
+to fix is probably just running \r
+uncrustify -c devel/uncrustify.cfg --replace sprinter.c \r
+\r
+Tomi\r
+\r
+> +\r
+> +struct sprinter *\r
+> +sprinter_text = NULL;\r
+> +\r
+> +/*\r
+> + * Every below here is the implementation of the JSON printer.\r
+> + */\r
+> +\r
+> +struct sprinter_json\r
+> +{\r
+> +    struct sprinter vtable;\r
+> +    FILE *stream;\r
+> +    /* Top of the state stack, or NULL if the printer is not currently\r
+> +     * inside any aggregate types. */\r
+> +    struct json_state *state;\r
+> +};\r
+> +\r
+> +struct json_state\r
+> +{\r
+> +    struct json_state *parent;\r
+> +    /* True if nothing has been printed in this aggregate yet.\r
+> +     * Suppresses the comma before a value. */\r
+> +    notmuch_bool_t first;\r
+> +    /* The character that closes the current aggregate. */\r
+> +    char close;\r
+> +};\r
+> +\r
+> +/* Helper function to set up the stream to print a value.  If this\r
+> + * value follows another value, prints a comma. */\r
+> +static struct sprinter_json *\r
+> +json_begin_value(struct sprinter *sp)\r
+> +{\r
+> +    struct sprinter_json *spj = (struct sprinter_json*)sp;\r
+> +    if (spj->state) {\r
+> +    if (!spj->state->first)\r
+> +        fputs (", ", spj->stream);\r
+> +    else\r
+> +        spj->state->first = false;\r
+> +    }\r
+> +    return spj;\r
+> +}\r
+> +\r
+> +/* Helper function to begin an aggregate type.  Prints the open\r
+> + * character and pushes a new state frame. */\r
+> +static void\r
+> +json_begin_aggregate(struct sprinter *sp, char open, char close)\r
+> +{\r
+> +    struct sprinter_json *spj = json_begin_value (sp);\r
+> +    struct json_state *state = talloc (spj, struct json_state);\r
+> +\r
+> +    fputc (open, spj->stream);\r
+> +    state->parent = spj->state;\r
+> +    state->first = true;\r
+> +    state->close = close;\r
+> +    spj->state = state;\r
+> +}\r
+> +\r
+> +static void\r
+> +json_begin_map(struct sprinter *sp)\r
+> +{\r
+> +    json_begin_aggregate (sp, '{', '}');\r
+> +}\r
+> +\r
+> +static void\r
+> +json_begin_list(struct sprinter *sp)\r
+> +{\r
+> +    json_begin_aggregate (sp, '[', ']');\r
+> +}\r
+> +\r
+> +static void\r
+> +json_end(struct sprinter *sp)\r
+> +{\r
+> +    struct sprinter_json *spj = (struct sprinter_json*)sp;\r
+> +    struct json_state *state = spj->state;\r
+> +\r
+> +    fputc (spj->state->close, spj->stream);\r
+> +    spj->state = state->parent;\r
+> +    talloc_free (state);\r
+> +    if(spj->state == NULL)\r
+> +    fputc ('\n', spj->stream);\r
+> +}\r
+> +\r
+> +static void\r
+> +json_string(struct sprinter *sp, const char *val)\r
+> +{\r
+> +    static const char * const escapes[] = {\r
+> +    ['\"'] = "\\\"", ['\\'] = "\\\\", ['\b'] = "\\b",\r
+> +    ['\f'] = "\\f",  ['\n'] = "\\n",  ['\t'] = "\\t"\r
+> +    };\r
+> +    struct sprinter_json *spj = json_begin_value (sp);\r
+> +    fputc ('"', spj->stream);\r
+> +    for (; *val; ++val) {\r
+> +    unsigned char ch = *val;\r
+> +    if (ch < ARRAY_SIZE(escapes) && escapes[ch])\r
+> +        fputs (escapes[ch], spj->stream);\r
+> +    else if (ch >= 32)\r
+> +        fputc (ch, spj->stream);\r
+> +    else\r
+> +        fprintf (spj->stream, "\\u%04x", ch);\r
+> +    }\r
+> +    fputc ('"', spj->stream);\r
+> +}\r
+> +\r
+> +static void\r
+> +json_integer(struct sprinter *sp, int val)\r
+> +{\r
+> +    struct sprinter_json *spj = json_begin_value (sp);\r
+> +    fprintf (spj->stream, "%d", val);\r
+> +}\r
+> +\r
+> +static void\r
+> +json_boolean(struct sprinter *sp, notmuch_bool_t val)\r
+> +{\r
+> +    struct sprinter_json *spj = json_begin_value (sp);\r
+> +    fputs (val ? "true" : "false", spj->stream);\r
+> +}\r
+> +\r
+> +static void\r
+> +json_null(struct sprinter *sp)\r
+> +{\r
+> +    struct sprinter_json *spj = json_begin_value (sp);\r
+> +    fputs ("null", spj->stream);\r
+> +}\r
+> +\r
+> +static void\r
+> +json_map_key(struct sprinter *sp, const char *key)\r
+> +{\r
+> +    struct sprinter_json *spj = (struct sprinter_json*)sp;\r
+> +    json_string (sp, key);\r
+> +    fputs (": ", spj->stream);\r
+> +    spj->state->first = true;\r
+> +}\r
+> +\r
+> +static void\r
+> +json_frame(struct sprinter *sp)\r
+> +{\r
+> +    struct sprinter_json *spj = (struct sprinter_json*)sp;\r
+> +    fputc ('\n', spj->stream);\r
+> +}\r
+> +\r
+> +struct sprinter *\r
+> +sprinter_json_new(const void *ctx, FILE *stream)\r
+> +{\r
+> +    static const struct sprinter_json template = {\r
+> +    .vtable = {\r
+> +        .begin_map = json_begin_map,\r
+> +        .begin_list = json_begin_list,\r
+> +        .end = json_end,\r
+> +        .string = json_string,\r
+> +        .integer = json_integer,\r
+> +        .boolean = json_boolean,\r
+> +        .null = json_null,\r
+> +        .map_key = json_map_key,\r
+> +        .frame = json_frame,\r
+> +    }\r
+> +    };\r
+> +    struct sprinter_json *res;\r
+> +\r
+> +    res = talloc (ctx, struct sprinter_json);\r
+> +    if (!res)\r
+> +    return NULL;\r
+> +\r
+> +    *res = template;\r
+> +    res->stream = stream;\r
+> +    return &res->vtable;\r
+> +}\r
+> -- \r
+> 1.7.11.1\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r