From: craven Date: Thu, 12 Jul 2012 07:43:22 +0000 (+0200) Subject: [PATCH v4 1/3] Add support for structured output formatters. X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=f975d558f3bbce52f4515197b2c1944fec80bea8;p=notmuch-archives.git [PATCH v4 1/3] Add support for structured output formatters. --- diff --git a/f1/5570a49071ba698c6ab2d9c914d2749082d965 b/f1/5570a49071ba698c6ab2d9c914d2749082d965 new file mode 100644 index 000000000..91c731e4b --- /dev/null +++ b/f1/5570a49071ba698c6ab2d9c914d2749082d965 @@ -0,0 +1,172 @@ +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 29153431FC9 + for ; Thu, 12 Jul 2012 00:42:21 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0.001 +X-Spam-Level: +X-Spam-Status: No, score=0.001 tagged_above=-999 required=5 + tests=[FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001] + 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 kH1GQ0bvk8eU for ; + Thu, 12 Jul 2012 00:42:19 -0700 (PDT) +Received: from mailout-de.gmx.net (mailout-de.gmx.net [213.165.64.22]) + by olra.theworths.org (Postfix) with SMTP id E8F5B429E4B + for ; Thu, 12 Jul 2012 00:42:15 -0700 (PDT) +Received: (qmail invoked by alias); 12 Jul 2012 07:42:03 -0000 +Received: from gw.arelion.cust.net.lagis.at (EHLO dodekanex.arelion.at) + [83.164.197.182] + by mail.gmx.net (mp030) with SMTP; 12 Jul 2012 09:42:03 +0200 +X-Authenticated: #201305 +X-Provags-ID: V01U2FsdGVkX1/sUeJEZpbsAZ2RhLXfCrmVKmhokI92GbzUxdJC3b + 1C2Le4WrIjDPca +Received: by dodekanex.arelion.at (Postfix, from userid 1000) + id 1F6593011A8; Thu, 12 Jul 2012 09:43:30 +0200 (CEST) +From: +To: notmuch@notmuchmail.org +Subject: [PATCH v4 1/3] Add support for structured output formatters. +Date: Thu, 12 Jul 2012 09:43:22 +0200 +Message-Id: <1342079004-5300-2-git-send-email-craven@gmx.net> +X-Mailer: git-send-email 1.7.11.1 +In-Reply-To: <1342079004-5300-1-git-send-email-craven@gmx.net> +References: <87d34hsdx8.fsf@awakening.csail.mit.edu> + <1342079004-5300-1-git-send-email-craven@gmx.net> +X-Y-GMX-Trusted: 0 +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 07:42:21 -0000 + +This patch adds a new type sprinter_t, which is used for structured +formatting, e.g. JSON or S-Expressions. The structure printer is the +code from Austin Clements (id:87d34hsdx8.fsf@awakening.csail.mit.edu). + +The structure printer contains the following function pointers: + +/* start a new map/dictionary structure. + */ +void (*begin_map) (struct sprinter *); + +/* start a new list/array structure + */ +void (*begin_list) (struct sprinter *); + +/* end the last opened list or map structure + */ +void (*end) (struct sprinter *); + +/* print one string/integer/boolean/null element (possibly inside a + * list or map + */ +void (*string) (struct sprinter *, const char *); +void (*integer) (struct sprinter *, int); +void (*boolean) (struct sprinter *, notmuch_bool_t); +void (*null) (struct sprinter *); + +/* print the key of a map's key/value pair. + */ +void (*map_key) (struct sprinter *, const char *); + +/* print a frame delimiter (such as a newline or extra whitespace) + */ +void (*frame) (struct sprinter *); + +The printer can (and should) use internal state to insert delimiters and +syntax at the correct places. + +Example: + +format->begin_map(format); +format->map_key(format, "foo"); +format->begin_list(format); +format->integer(format, 1); +format->integer(format, 2); +format->integer(format, 3); +format->end(format); +format->map_key(format, "bar"); +format->begin_map(format); +format->map_key(format, "baaz"); +format->string(format, "hello world"); +format->end(format); +format->end(format); + +would output JSON as follows: + +{"foo": [1, 2, 3], "bar": { "baaz": "hello world"}} +--- + sprinter.h | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ + 1 file changed, 49 insertions(+) + create mode 100644 sprinter.h + +diff --git a/sprinter.h b/sprinter.h +new file mode 100644 +index 0000000..1dad9a0 +--- /dev/null ++++ b/sprinter.h +@@ -0,0 +1,49 @@ ++#ifndef NOTMUCH_SPRINTER_H ++#define NOTMUCH_SPRINTER_H ++ ++/* for notmuch_bool_t */ ++#include "notmuch-client.h" ++ ++/* Structure printer interface */ ++typedef struct sprinter ++{ ++ /* start a new map/dictionary structure. ++ */ ++ void (*begin_map) (struct sprinter *); ++ ++ /* start a new list/array structure ++ */ ++ void (*begin_list) (struct sprinter *); ++ ++ /* end the last opened list or map structure ++ */ ++ void (*end) (struct sprinter *); ++ ++ /* print one string/integer/boolean/null element (possibly inside a ++ * list or map ++ */ ++ void (*string) (struct sprinter *, const char *); ++ void (*integer) (struct sprinter *, int); ++ void (*boolean) (struct sprinter *, notmuch_bool_t); ++ void (*null) (struct sprinter *); ++ ++ /* print the key of a map's key/value pair. ++ */ ++ void (*map_key) (struct sprinter *, const char *); ++ ++ /* print a frame delimiter (such as a newline or extra whitespace) ++ */ ++ void (*frame) (struct sprinter *); ++} sprinter_t; ++ ++/* Create a new structure printer that emits JSON */ ++struct sprinter * ++sprinter_json_new(const void *ctx, FILE *stream); ++ ++/* A dummy structure printer that signifies that standard text output is ++ * to be used instead of any structured format. ++ */ ++struct sprinter * ++sprinter_text; ++ ++#endif // NOTMUCH_SPRINTER_H +-- +1.7.11.1 +