--- /dev/null
+Return-Path: <amdragon@mit.edu>\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 10578431FAF\r
+ for <notmuch@notmuchmail.org>; Wed, 18 Jul 2012 12:48:24 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+ tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 usmcuWkLXBqJ for <notmuch@notmuchmail.org>;\r
+ Wed, 18 Jul 2012 12:48:22 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-4.mit.edu (DMZ-MAILSEC-SCANNER-4.MIT.EDU\r
+ [18.9.25.15])\r
+ by olra.theworths.org (Postfix) with ESMTP id 941E0431FAE\r
+ for <notmuch@notmuchmail.org>; Wed, 18 Jul 2012 12:48:22 -0700 (PDT)\r
+X-AuditID: 1209190f-b7f306d0000008b4-bf-500713062470\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+ by dmz-mailsec-scanner-4.mit.edu (Symantec Messaging Gateway) with SMTP\r
+ id 56.47.02228.60317005; Wed, 18 Jul 2012 15:48:22 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+ by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q6IJmLAM022316; \r
+ Wed, 18 Jul 2012 15:48:21 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+ (authenticated bits=0)\r
+ (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+ by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q6IJmKL5008295\r
+ (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+ Wed, 18 Jul 2012 15:48:20 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+ (envelope-from <amdragon@mit.edu>)\r
+ id 1SraEN-00014k-TM; Wed, 18 Jul 2012 15:48:19 -0400\r
+Date: Wed, 18 Jul 2012 15:48:19 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: craven@gmx.net\r
+Subject: Re: [PATCH v6 2/3] Add structured output formatter for JSON and\r
+ plain text.\r
+Message-ID: <20120718194819.GP31670@mit.edu>\r
+References: <20120714020954.GD31670@mit.edu>\r
+ <1342427702-23316-1-git-send-email-craven@gmx.net>\r
+ <1342427702-23316-3-git-send-email-craven@gmx.net>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <1342427702-23316-3-git-send-email-craven@gmx.net>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFprAKsWRmVeSWpSXmKPExsUixG6nrssmzB5g8Hwxl8XehnZGi+s3ZzI7\r
+ MHks3rSfzePZqlvMAUxRXDYpqTmZZalF+nYJXBnP965hKrgVV3Fj/nWWBsZ+jy5GTg4JAROJ\r
+ VR+mskPYYhIX7q1n62Lk4hAS2Mco8e3OJ0aQhJDABkaJQ08CIRInmSTWHm9mgXCWMEo8vdEJ\r
+ VsUioCqx//d5FhCbTUBDYtv+5WBxEQEhiUlfXoHFmQWkJb79bmYCsYUFwiRObXrNBmLzCuhI\r
+ XJu9khli6DRGiaZFZ6ASghInZz6BataSuPHvJVAzB9ig5f84QMKcAvYSF5/OBZspKqAiMeXk\r
+ NrYJjEKzkHTPQtI9C6F7ASPzKkbZlNwq3dzEzJzi1GTd4uTEvLzUIl0TvdzMEr3UlNJNjKDA\r
+ 5pTk38H47aDSIUYBDkYlHt4Hu1gDhFgTy4orcw8xSnIwKYnyqguwBwjxJeWnVGYkFmfEF5Xm\r
+ pBYfYpTgYFYS4X0gCJTjTUmsrEotyodJSXOwKInzXk256S8kkJ5YkpqdmlqQWgSTleHgUJLg\r
+ 5RQCahQsSk1PrUjLzClBSDNxcIIM5wEa/g9seHFBYm5xZjpE/hSjLse1h7duMQqx5OXnpUqJ\r
+ 88qCDBIAKcoozYObA0tIrxjFgd4ShhjFA0xmcJNeAS1hAlrCXcwGsqQkESEl1cAo8Cdt3Q6F\r
+ V1b/nrtce8ufG1j8pFLc+oibfK2qlegSPoWYE35akrc5Pu25c/iaocIbvzPfgy9fP8wQ+W3L\r
+ C87+JWv+JPB+YHjywnLtIubAeV13Fzq/PZX7Y9fM3MAbOv/vinqelf60faEcc8fbWbfr+W9/\r
+ O6Dxb+unKZeq30dE5VYc2nI1+5bVISWW4oxEQy3mouJEAMwu6NUjAwAA\r
+Cc: notmuch@notmuchmail.org\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: Wed, 18 Jul 2012 19:48:24 -0000\r
+\r
+Quoth craven@gmx.net on Jul 16 at 10:35 am:\r
+> Using the new structured printer support in sprinter.h, implement\r
+> sprinter_json_create, which returns a new JSON structured output\r
+> formatter. The formatter prints output similar to the existing JSON, but\r
+> with differences in whitespace (mostly newlines, --output=summary prints\r
+> the entire message summary on one line, not split across multiple lines).\r
+> \r
+> Also implement a "structured" formatter for plain text that prints\r
+> prefixed strings, to be used with notmuch-search.c plain text output.\r
+> ---\r
+> Makefile.local | 2 +\r
+> sprinter-json.c | 191 +++++++++++++++++++++++++++++++++++++++++++++++++\r
+> sprinter-text-search.c | 146 +++++++++++++++++++++++++++++++++++++\r
+> sprinter.h | 9 +++\r
+> 4 files changed, 348 insertions(+)\r
+> create mode 100644 sprinter-json.c\r
+> create mode 100644 sprinter-text-search.c\r
+> \r
+> diff --git a/Makefile.local b/Makefile.local\r
+> index a890df2..4f534f1 100644\r
+> --- a/Makefile.local\r
+> +++ b/Makefile.local\r
+> @@ -290,6 +290,8 @@ notmuch_client_srcs = \\r
+> notmuch-show.c \\r
+> notmuch-tag.c \\r
+> notmuch-time.c \\r
+> + sprinter-text-search.c \\r
+> + sprinter-json.c \\r
+> query-string.c \\r
+> mime-node.c \\r
+> crypto.c \\r
+> diff --git a/sprinter-json.c b/sprinter-json.c\r
+> new file mode 100644\r
+> index 0000000..a93a390\r
+> --- /dev/null\r
+> +++ b/sprinter-json.c\r
+> @@ -0,0 +1,191 @@\r
+> +#include <stdbool.h>\r
+> +#include <stdio.h>\r
+> +#include <talloc.h>\r
+> +#include "sprinter.h"\r
+> +\r
+> +struct sprinter_json {\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
+> + /* A flag to signify that a separator should be inserted in the\r
+> + * output as soon as possible.\r
+> + */\r
+> + notmuch_bool_t insert_separator;\r
+> +};\r
+> +\r
+> +struct json_state {\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
+> +\r
+> + if (spj->state) {\r
+> + if (! spj->state->first) {\r
+> + fputc (',', spj->stream);\r
+> + if (spj->insert_separator) {\r
+> + fputc ('\n', spj->stream);\r
+> + spj->insert_separator = FALSE;\r
+> + } else\r
+> + fputc (' ', 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
+> +\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
+> +\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
+> +\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
+> +\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
+> +\r
+> + json_string (sp, key);\r
+> + fputs (": ", spj->stream);\r
+> + spj->state->first = TRUE;\r
+> +}\r
+> +\r
+> +static void\r
+> +json_set_prefix (unused (struct sprinter *sp), unused (const char *name))\r
+> +{\r
+> +}\r
+> +\r
+> +static void\r
+> +json_separator (struct sprinter *sp)\r
+> +{\r
+> + struct sprinter_json *spj = (struct sprinter_json *) sp;\r
+> +\r
+> + spj->insert_separator = TRUE;\r
+> +}\r
+> +\r
+> +static notmuch_bool_t\r
+> +json_is_text_printer (unused (struct sprinter *sp))\r
+> +{\r
+> + return FALSE;\r
+> +}\r
+\r
+Seems like overkill to have a method for this. Why not just use some\r
+flag in notmuch-search.c? Or, if you really want it to be part of the\r
+sprinter abstraction, why not just put a flag in struct sprinter?\r
+This isn't going to change dynamically.\r
+\r
+> +\r
+> +struct sprinter *\r
+> +sprinter_json_create (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
+> + .separator = json_separator,\r
+> + .set_prefix = json_set_prefix,\r
+> + .is_text_printer = json_is_text_printer,\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
+> diff --git a/sprinter-text-search.c b/sprinter-text-search.c\r
+> new file mode 100644\r
+> index 0000000..b115722\r
+> --- /dev/null\r
+> +++ b/sprinter-text-search.c\r
+> @@ -0,0 +1,146 @@\r
+> +#include <stdbool.h>\r
+> +#include <stdio.h>\r
+> +#include <talloc.h>\r
+> +#include "sprinter.h"\r
+> +\r
+> +/* "Structured printer" interface for unstructured text printing.\r
+> + * Note that --output=summary is dispatched and formatted in\r
+> + * notmuch-search.c, the code in this file is only used for all other\r
+> + * output types.\r
+> + */\r
+> +\r
+> +struct sprinter_text_search {\r
+\r
+Why is this sprinter_text_search rather than just sprinter_text?\r
+\r
+> + struct sprinter vtable;\r
+> + FILE *stream;\r
+> +\r
+> + /* The current prefix to be printed with string/integer/boolean\r
+> + * data.\r
+> + */\r
+> + const char *current_prefix;\r
+> +\r
+> + /* A flag to indicate if this is the first tag. Used in list of tags\r
+> + * for summary.\r
+> + */\r
+> + notmuch_bool_t first_tag;\r
+> +};\r
+> +\r
+> +static void\r
+> +print_sanitized_string (FILE *stream, const char *str)\r
+> +{\r
+> + if (NULL == str)\r
+> + return;\r
+> +\r
+> + for (; *str; str++) {\r
+> + if ((unsigned char) (*str) < 32)\r
+> + fputc ('?', stream);\r
+> + else\r
+> + fputc (*str, stream);\r
+> + }\r
+> +}\r
+\r
+Either the text sprinter should be responsible for sanitization or the\r
+caller should be. Currently you have a text sanitizer in both. I\r
+think you should leave sanitization to the caller and output the\r
+string directly in text_search_string. For example, search\r
+--output=files should output file names untouched, but doing\r
+sanitization here means unusual (but legal) characters in file names\r
+will get sanitized.\r
+\r
+> +\r
+> +static void\r
+> +text_search_string (struct sprinter *sp, const char *val)\r
+> +{\r
+> + struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
+> +\r
+> + if (sptxt->current_prefix != NULL)\r
+> + fprintf (sptxt->stream, "%s:", sptxt->current_prefix);\r
+> +\r
+> + print_sanitized_string (sptxt->stream, val);\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_integer (struct sprinter *sp, int val)\r
+> +{\r
+> + struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
+> +\r
+> + fprintf (sptxt->stream, "%d", val);\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_boolean (struct sprinter *sp, notmuch_bool_t val)\r
+> +{\r
+> + struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
+> +\r
+> + fputs (val ? "true" : "false", sptxt->stream);\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_separator (struct sprinter *sp)\r
+> +{\r
+> + struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
+> +\r
+> + fputc ('\n', sptxt->stream);\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_set_prefix (struct sprinter *sp, const char *prefix)\r
+> +{\r
+> + struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
+> +\r
+> + sptxt->current_prefix = prefix;\r
+> +}\r
+> +\r
+> +static notmuch_bool_t\r
+> +text_search_is_text_printer (unused (struct sprinter *sp))\r
+> +{\r
+> + return TRUE;\r
+> +}\r
+> +\r
+> +/* The structure functions begin_map, begin_list, end and map_key\r
+> + * don't do anything in the text formatter.\r
+> + */\r
+> +\r
+> +static void\r
+> +text_search_begin_map (unused (struct sprinter *sp))\r
+> +{\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_begin_list (unused (struct sprinter *sp))\r
+> +{\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_end (unused (struct sprinter *sp))\r
+> +{\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_null (unused (struct sprinter *sp))\r
+> +{\r
+> +}\r
+> +\r
+> +static void\r
+> +text_search_map_key (unused (struct sprinter *sp), unused (const char *key))\r
+> +{\r
+> +}\r
+> +\r
+> +struct sprinter *\r
+> +sprinter_text_search_create (const void *ctx, FILE *stream)\r
+> +{\r
+> + static const struct sprinter_text_search template = {\r
+> + .vtable = {\r
+> + .begin_map = text_search_begin_map,\r
+> + .begin_list = text_search_begin_list,\r
+> + .end = text_search_end,\r
+> + .string = text_search_string,\r
+> + .integer = text_search_integer,\r
+> + .boolean = text_search_boolean,\r
+> + .null = text_search_null,\r
+> + .map_key = text_search_map_key,\r
+> + .separator = text_search_separator,\r
+> + .set_prefix = text_search_set_prefix,\r
+> + .is_text_printer = text_search_is_text_printer,\r
+> + }\r
+> + };\r
+> + struct sprinter_text_search *res;\r
+> +\r
+> + res = talloc (ctx, struct sprinter_text_search);\r
+> + if (! res)\r
+> + return NULL;\r
+> +\r
+> + *res = template;\r
+> + res->stream = stream;\r
+> + return &res->vtable;\r
+> +}\r
+> diff --git a/sprinter.h b/sprinter.h\r
+> index dc09a15..7ec6344 100644\r
+> --- a/sprinter.h\r
+> +++ b/sprinter.h\r
+> @@ -57,4 +57,13 @@ typedef struct sprinter {\r
+> notmuch_bool_t (*is_text_printer) (struct sprinter *);\r
+> } sprinter_t;\r
+> \r
+> +/* Create a new unstructured printer that emits the default text format\r
+> + * for "notmuch search". */\r
+> +struct sprinter *\r
+> +sprinter_text_search_create (const void *ctx, FILE *stream);\r
+> +\r
+> +/* Create a new structure printer that emits JSON. */\r
+> +struct sprinter *\r
+> +sprinter_json_create (const void *ctx, FILE *stream);\r
+> +\r
+> #endif // NOTMUCH_SPRINTER_H\r
projects / notmuch-archives.git / commitdiff