--- /dev/null
+Return-Path: <craven@gmx.net>\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 B4B78431FAE\r
+ for <notmuch@notmuchmail.org>; Fri, 13 Jul 2012 01:13:45 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.001\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.001 tagged_above=-999 required=5\r
+ tests=[FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001]\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 QEqTQsT8bffN for <notmuch@notmuchmail.org>;\r
+ Fri, 13 Jul 2012 01:13:42 -0700 (PDT)\r
+Received: from mailout-de.gmx.net (mailout-de.gmx.net [213.165.64.23])\r
+ by olra.theworths.org (Postfix) with SMTP id 33915431FC4\r
+ for <notmuch@notmuchmail.org>; Fri, 13 Jul 2012 01:13:41 -0700 (PDT)\r
+Received: (qmail invoked by alias); 13 Jul 2012 08:13:38 -0000\r
+Received: from cm56-137-203.liwest.at (EHLO nexork.localdomain)\r
+ [86.56.137.203] by mail.gmx.net (mp019) with SMTP; 13 Jul 2012 10:13:38 +0200\r
+X-Authenticated: #201305\r
+X-Provags-ID: V01U2FsdGVkX1/1LBN6uRX16FYH/ks8KYjbl0uzKhUbcIT8wucqYT\r
+ RWNNvnA9tM0Dn7\r
+Received: by nexork.localdomain (Postfix, from userid 1000)\r
+ id CCBFF4527803; Fri, 13 Jul 2012 10:11:42 +0200 (CEST)\r
+From: Peter Feigl <craven@gmx.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v5 2/3] Add structured output formatter for JSON and text.\r
+Date: Fri, 13 Jul 2012 10:11:36 +0200\r
+Message-Id: <1342167097-25012-3-git-send-email-craven@gmx.net>\r
+X-Mailer: git-send-email 1.7.11.1\r
+In-Reply-To: <1342167097-25012-1-git-send-email-craven@gmx.net>\r
+References: <20120710191331.GE7332@mit.edu>\r
+ <1342167097-25012-1-git-send-email-craven@gmx.net>\r
+X-Y-GMX-Trusted: 0\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: Fri, 13 Jul 2012 08:13:46 -0000\r
+\r
+From: <craven@gmx.net>\r
+\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 that prints the current plain\r
+text format. This passes all tests, but the exact formatting is probably\r
+specific to notmuch-search and cannot easily (if at all) be adapted to\r
+be used across all of notmuch-{search,reply,show,...}.\r
+---\r
+ Makefile.local | 2 +\r
+ sprinter-json.c | 184 +++++++++++++++++++++++++++++++++++++++++++++++\r
+ sprinter-text-search.c | 190 +++++++++++++++++++++++++++++++++++++++++++++++++\r
+ sprinter.h | 8 +++\r
+ 4 files changed, 384 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..b6c7e0c 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-json.c \\r
++ sprinter-text-search.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..215151d\r
+--- /dev/null\r
++++ b/sprinter-json.c\r
+@@ -0,0 +1,184 @@\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
++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
++ }\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..95ed9cb\r
+--- /dev/null\r
++++ b/sprinter-text-search.c\r
+@@ -0,0 +1,190 @@\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
++ * This is at best a misuse of the interface, but it simplifies the code\r
++ * in notmuch-search.c considerably.\r
++ */\r
++\r
++struct sprinter_text_search {\r
++ struct sprinter vtable;\r
++ FILE *stream;\r
++\r
++ /* The current name or prefix to be printed with string/integer/boolean\r
++ * data.\r
++ */\r
++ const char *current_name;\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
++/* struct text_search_state { */\r
++/* struct text_search_state *parent; */\r
++/* }; */\r
++\r
++static notmuch_bool_t\r
++current_context (struct sprinter_text_search *sptxt, const char *marker)\r
++{\r
++ return (sptxt->current_name != NULL\r
++ && ! strncmp (marker, sptxt->current_name, strlen (marker)));\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
++static void\r
++text_search_begin_map (unused (struct sprinter *sp))\r
++{\r
++}\r
++\r
++static void\r
++text_search_begin_list (struct sprinter *sp)\r
++{\r
++ struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
++\r
++ if (current_context (sptxt, "tags")) {\r
++ fputs (" (", sptxt->stream);\r
++ sptxt->first_tag = TRUE;\r
++ }\r
++}\r
++\r
++static void\r
++text_search_end (struct sprinter *sp)\r
++{\r
++ struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
++\r
++ if (current_context (sptxt, "tags")) {\r
++ fputc (')', sptxt->stream);\r
++ sptxt->current_name = NULL;\r
++ }\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_name != NULL) {\r
++ if (current_context (sptxt, "thread"))\r
++ fprintf ( sptxt->stream, "thread:%s ", val);\r
++ else if (current_context (sptxt, "date_relative"))\r
++ fprintf ( sptxt->stream, "%12s ", val);\r
++ else if (current_context (sptxt, "authors")) {\r
++ print_sanitized_string (sptxt->stream, val);\r
++ fputs ("; ", sptxt->stream);\r
++ } else if (current_context (sptxt, "subject"))\r
++ print_sanitized_string (sptxt->stream, val);\r
++ else if (current_context (sptxt, "tags")) {\r
++ if (! sptxt->first_tag)\r
++ fputc (' ', sptxt->stream);\r
++ else\r
++ sptxt->first_tag = FALSE;\r
++\r
++ fputs (val, sptxt->stream);\r
++ } else {\r
++ fputs (sptxt->current_name, sptxt->stream);\r
++ fputc (':', sptxt->stream);\r
++ fputs (val, sptxt->stream);\r
++ }\r
++ } else {\r
++ fputs (val, sptxt->stream);\r
++ }\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
++ if (sptxt->current_name != NULL) {\r
++ if (current_context (sptxt, "matched"))\r
++ fprintf ( sptxt->stream, "[%d/", val);\r
++ else if (current_context (sptxt, "total"))\r
++ fprintf ( sptxt->stream, "%d] ", val);\r
++ } else\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_null (struct sprinter *sp)\r
++{\r
++ struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
++\r
++ fputs ("null", sptxt->stream);\r
++}\r
++\r
++static void\r
++text_search_map_key (struct sprinter *sp, const char *key)\r
++{\r
++ struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
++\r
++ sptxt->current_name = key;\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 *name)\r
++{\r
++ struct sprinter_text_search *sptxt = (struct sprinter_text_search *) sp;\r
++\r
++ sptxt->current_name = name;\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
++ }\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 c9cd6a6..4241d65 100644\r
+--- a/sprinter.h\r
++++ b/sprinter.h\r
+@@ -47,4 +47,12 @@ typedef struct sprinter {\r
+ void (*separator)(struct sprinter *);\r
+ } sprinter_t;\r
+ \r
++/* Create a new unstructured printer that emits the default Text format for 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
+-- \r
+1.7.11.1\r
+\r
projects / notmuch-archives.git / commitdiff