From: Austin Clements Date: Thu, 12 Jul 2012 22:07:04 +0000 (+2000) Subject: Re: [PATCH v4 2/3] Add structured output formatter for JSON. X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=560131f3bd8bc1a84942c2db2531c8a1d2e27fa3;p=notmuch-archives.git Re: [PATCH v4 2/3] Add structured output formatter for JSON. --- diff --git a/05/ea0a953804a7e91620d0bda1e19cae8d8fadd5 b/05/ea0a953804a7e91620d0bda1e19cae8d8fadd5 new file mode 100644 index 000000000..38da7f787 --- /dev/null +++ b/05/ea0a953804a7e91620d0bda1e19cae8d8fadd5 @@ -0,0 +1,300 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id CBB7F429E25 + for ; Thu, 12 Jul 2012 15:07:09 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id jEGa1-+WJEDK for ; + Thu, 12 Jul 2012 15:07:08 -0700 (PDT) +Received: from dmz-mailsec-scanner-8.mit.edu (DMZ-MAILSEC-SCANNER-8.MIT.EDU + [18.7.68.37]) + by olra.theworths.org (Postfix) with ESMTP id 4F29C431FC4 + for ; Thu, 12 Jul 2012 15:07:08 -0700 (PDT) +X-AuditID: 12074425-b7f9b6d0000008c4-2d-4fff4a8a9e35 +Received: from mailhub-auth-4.mit.edu ( [18.7.62.39]) + by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP + id F6.63.02244.A8A4FFF4; Thu, 12 Jul 2012 18:07:06 -0400 (EDT) +Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) + by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q6CM75Jq002528; + Thu, 12 Jul 2012 18:07:05 -0400 +Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91]) + (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q6CM744i028805 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Thu, 12 Jul 2012 18:07:05 -0400 (EDT) +Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77) + (envelope-from ) + id 1SpRXM-0004sD-2W; Thu, 12 Jul 2012 18:07:04 -0400 +Date: Thu, 12 Jul 2012 18:07:04 -0400 +From: Austin Clements +To: craven@gmx.net +Subject: Re: [PATCH v4 2/3] Add structured output formatter for JSON. +Message-ID: <20120712220703.GI7332@mit.edu> +References: <87d34hsdx8.fsf@awakening.csail.mit.edu> + <1342079004-5300-1-git-send-email-craven@gmx.net> + <1342079004-5300-3-git-send-email-craven@gmx.net> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +Content-Disposition: inline +In-Reply-To: <1342079004-5300-3-git-send-email-craven@gmx.net> +User-Agent: Mutt/1.5.21 (2010-09-15) +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFmplleLIzCtJLcpLzFFi42IRYrdT1+3y+u9v8H82q8XehnZGi+s3ZzI7 + MHks3rSfzePZqlvMAUxRXDYpqTmZZalF+nYJXBm7G3ewF0zTrzj09xRzA+M+5S5GTg4JAROJ + 49s+sUDYYhIX7q1n62Lk4hAS2McoseX9GXYIZwOjxMtt/1ghnJNMErP+wDhLGCX+Lv0D1s8i + oCpx4c9GMJtNQENi2/7ljCC2iICQxKQvr8DizALSEt9+NzOB2MICrhKtT9+A2bwC2hKLL/yF + 2j2HUaL1+RtWiISgxMmZT6CatSRu/HsJ1MABNmj5Pw6QMKeAncSdGz3sILaogIrElJPb2CYw + Cs1C0j0LSfcshO4FjMyrGGVTcqt0cxMzc4pTk3WLkxPz8lKLdC30cjNL9FJTSjcxgkPbRXUH + 44RDSocYBTgYlXh4d6776y/EmlhWXJl7iFGSg0lJlNfa9b+/EF9SfkplRmJxRnxRaU5q8SFG + CQ5mJRHedfZAOd6UxMqq1KJ8mJQ0B4uSOO+NlJv+QgLpiSWp2ampBalFMFkZDg4lCd4tnkCN + gkWp6akVaZk5JQhpJg5OkOE8QMNngdTwFhck5hZnpkPkTzEqSonzzgdJCIAkMkrz4HphqecV + ozjQK8K8C0CqeIBpC677FdBgJpDBP/+BDC5JREhJNTBuWqHr58561eXNtkO/rv+vbjIIFJvN + 3nm1RiDCT6dtwuNlZ9Yp3xMvjhe/9CfIO818+45t/947TI+oDfywMqJX8cakN7P3Se2ebuIz + wfrJ9V8MEqVLduX/k/auDZ/xl8/5zZq1dTVvl/qnSa0VLN6uJuDWtjY+z9lmS0LM6WexBXZS + a/4f/2ekxFKckWioxVxUnAgAfQM9CRgDAAA= +Cc: notmuch@notmuchmail.org +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Thu, 12 Jul 2012 22:07:10 -0000 + +Quoth craven@gmx.net on Jul 12 at 9:43 am: +> Using the new structured printer support in sprinter.h, implement +> sprinter_json_new, which returns a new JSON structured output +> formatter. +> +> The formatter prints output similar to the existing JSON, but with +> differences in whitespace (mostly newlines). +> --- +> Makefile.local | 1 + +> sprinter.c | 172 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +> 2 files changed, 173 insertions(+) +> create mode 100644 sprinter.c +> +> diff --git a/Makefile.local b/Makefile.local +> index a890df2..8baf0c2 100644 +> --- a/Makefile.local +> +++ b/Makefile.local +> @@ -290,6 +290,7 @@ notmuch_client_srcs = \ +> notmuch-show.c \ +> notmuch-tag.c \ +> notmuch-time.c \ +> + sprinter.c \ +> query-string.c \ +> mime-node.c \ +> crypto.c \ +> diff --git a/sprinter.c b/sprinter.c +> new file mode 100644 +> index 0000000..649f79a +> --- /dev/null +> +++ b/sprinter.c +> @@ -0,0 +1,172 @@ +> +#include +> +#include +> +#include +> +#include "sprinter.h" +> + +> +#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) +> + +> +struct sprinter * +> +sprinter_text = NULL; +> + +> +/* +> + * Every below here is the implementation of the JSON printer. + +s/Every/Everything/ + +Or this can be shortened to just + +/* + * JSON printer + */ + +If we wind up with separate files for the JSON and S-exp printers, I +don't think this comment is necessary at all. + +> + */ +> + +> +struct sprinter_json +> +{ +> + struct sprinter vtable; +> + FILE *stream; +> + /* Top of the state stack, or NULL if the printer is not currently +> + * inside any aggregate types. */ +> + struct json_state *state; +> +}; +> + +> +struct json_state +> +{ +> + struct json_state *parent; +> + /* True if nothing has been printed in this aggregate yet. +> + * Suppresses the comma before a value. */ +> + notmuch_bool_t first; +> + /* The character that closes the current aggregate. */ +> + char close; +> +}; +> + +> +/* Helper function to set up the stream to print a value. If this +> + * value follows another value, prints a comma. */ +> +static struct sprinter_json * +> +json_begin_value(struct sprinter *sp) + +As Tomi pointed out, there should be spaces before the parameter +lists (sorry). + +> +{ +> + struct sprinter_json *spj = (struct sprinter_json*)sp; +> + if (spj->state) { +> + if (!spj->state->first) +> + fputs (", ", spj->stream); +> + else +> + spj->state->first = false; +> + } +> + return spj; +> +} +> + +> +/* Helper function to begin an aggregate type. Prints the open +> + * character and pushes a new state frame. */ +> +static void +> +json_begin_aggregate(struct sprinter *sp, char open, char close) +> +{ +> + struct sprinter_json *spj = json_begin_value (sp); +> + struct json_state *state = talloc (spj, struct json_state); +> + +> + fputc (open, spj->stream); +> + state->parent = spj->state; +> + state->first = true; +> + state->close = close; +> + spj->state = state; +> +} +> + +> +static void +> +json_begin_map(struct sprinter *sp) +> +{ +> + json_begin_aggregate (sp, '{', '}'); +> +} +> + +> +static void +> +json_begin_list(struct sprinter *sp) +> +{ +> + json_begin_aggregate (sp, '[', ']'); +> +} +> + +> +static void +> +json_end(struct sprinter *sp) +> +{ +> + struct sprinter_json *spj = (struct sprinter_json*)sp; +> + struct json_state *state = spj->state; +> + +> + fputc (spj->state->close, spj->stream); +> + spj->state = state->parent; +> + talloc_free (state); +> + if(spj->state == NULL) + +Ah, another missing space. + +> + fputc ('\n', spj->stream); +> +} +> + +> +static void +> +json_string(struct sprinter *sp, const char *val) +> +{ +> + static const char * const escapes[] = { +> + ['\"'] = "\\\"", ['\\'] = "\\\\", ['\b'] = "\\b", +> + ['\f'] = "\\f", ['\n'] = "\\n", ['\t'] = "\\t" +> + }; +> + struct sprinter_json *spj = json_begin_value (sp); +> + fputc ('"', spj->stream); +> + for (; *val; ++val) { +> + unsigned char ch = *val; +> + if (ch < ARRAY_SIZE(escapes) && escapes[ch]) +> + fputs (escapes[ch], spj->stream); +> + else if (ch >= 32) +> + fputc (ch, spj->stream); +> + else +> + fprintf (spj->stream, "\\u%04x", ch); +> + } +> + fputc ('"', spj->stream); +> +} +> + +> +static void +> +json_integer(struct sprinter *sp, int val) +> +{ +> + struct sprinter_json *spj = json_begin_value (sp); +> + fprintf (spj->stream, "%d", val); +> +} +> + +> +static void +> +json_boolean(struct sprinter *sp, notmuch_bool_t val) +> +{ +> + struct sprinter_json *spj = json_begin_value (sp); +> + fputs (val ? "true" : "false", spj->stream); +> +} +> + +> +static void +> +json_null(struct sprinter *sp) +> +{ +> + struct sprinter_json *spj = json_begin_value (sp); +> + fputs ("null", spj->stream); +> +} +> + +> +static void +> +json_map_key(struct sprinter *sp, const char *key) +> +{ +> + struct sprinter_json *spj = (struct sprinter_json*)sp; +> + json_string (sp, key); +> + fputs (": ", spj->stream); +> + spj->state->first = true; +> +} +> + +> +static void +> +json_frame(struct sprinter *sp) +> +{ +> + struct sprinter_json *spj = (struct sprinter_json*)sp; +> + fputc ('\n', spj->stream); +> +} +> + +> +struct sprinter * +> +sprinter_json_new(const void *ctx, FILE *stream) +> +{ +> + static const struct sprinter_json template = { +> + .vtable = { +> + .begin_map = json_begin_map, +> + .begin_list = json_begin_list, +> + .end = json_end, +> + .string = json_string, +> + .integer = json_integer, +> + .boolean = json_boolean, +> + .null = json_null, +> + .map_key = json_map_key, +> + .frame = json_frame, +> + } +> + }; +> + struct sprinter_json *res; +> + +> + res = talloc (ctx, struct sprinter_json); +> + if (!res) +> + return NULL; +> + +> + *res = template; +> + res->stream = stream; +> + return &res->vtable; +> +}