From 9e51e61f2f5df5a2ed2a9266b1ba8321a9ed80d6 Mon Sep 17 00:00:00 2001 From: craven Date: Mon, 23 Jul 2012 12:39:44 +0200 Subject: [PATCH] [PATCH v8 1/3] Add support for structured output formatters. --- f4/2a5d31fcffc224ac739ed1006d8d2b6732a94a | 211 ++++++++++++++++++++++ 1 file changed, 211 insertions(+) create mode 100644 f4/2a5d31fcffc224ac739ed1006d8d2b6732a94a diff --git a/f4/2a5d31fcffc224ac739ed1006d8d2b6732a94a b/f4/2a5d31fcffc224ac739ed1006d8d2b6732a94a new file mode 100644 index 000000000..afb2966ed --- /dev/null +++ b/f4/2a5d31fcffc224ac739ed1006d8d2b6732a94a @@ -0,0 +1,211 @@ +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 B887D431FB6 + for ; Mon, 23 Jul 2012 03:38:18 -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 toMiaExP9dnR for ; + Mon, 23 Jul 2012 03:38:17 -0700 (PDT) +Received: from mailout-de.gmx.net (mailout-de.gmx.net [213.165.64.22]) + by olra.theworths.org (Postfix) with SMTP id 35BDD431FAF + for ; Mon, 23 Jul 2012 03:38:17 -0700 (PDT) +Received: (qmail invoked by alias); 23 Jul 2012 10:38:15 -0000 +Received: from gw.arelion.cust.net.lagis.at (EHLO dodekanex.arelion.at) + [83.164.197.182] + by mail.gmx.net (mp030) with SMTP; 23 Jul 2012 12:38:15 +0200 +X-Authenticated: #201305 +X-Provags-ID: V01U2FsdGVkX1+YUQ8honOYuWCeL42Obr4DGJgqN+GyHAr6k0icdC + 4TVSVY4y4htGHU +Received: by dodekanex.arelion.at (Postfix, from userid 1000) + id B5B3F3034D2; Mon, 23 Jul 2012 12:39:50 +0200 (CEST) +From: craven@gmx.net +To: notmuch@notmuchmail.org +Subject: [PATCH v8 1/3] Add support for structured output formatters. +Date: Mon, 23 Jul 2012 12:39:44 +0200 +Message-Id: <1343039986-2732-2-git-send-email-craven@gmx.net> +X-Mailer: git-send-email 1.7.11.2 +In-Reply-To: <1343039986-2732-1-git-send-email-craven@gmx.net> +References: <1343039986-2732-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: Mon, 23 Jul 2012 10:38:18 -0000 + +From: + +This patch adds a new struct type sprinter_t, which is used for +structured formatting, e.g. JSON or S-Expressions. The structure printer +is heavily based on code from Austin Clements +(id:87d34hsdx8.fsf@awakening.csail.mit.edu). + +It includes the following functions: + + /* Start a new map/dictionary structure. This should be followed by + * a sequence of alternating calls to map_key and one of the + * value-printing functions until the map is ended by end. + */ + 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, followed or preceded by separators). + * For string, the char * must be UTF-8 encoded. + */ + 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. The char * must be UTF-8 + * encoded. + */ + void (*map_key) (struct sprinter *, const char *); + + /* Insert a separator (usually extra whitespace) for improved + * readability without affecting the abstract syntax of the + * structure being printed. + * For JSON, this could simply be a line break. + */ + void (*separator) (struct sprinter *); + + /* Set the current string prefix. This only affects the text + * printer, which will print this string, followed by a colon, + * before any string. For other printers, this does nothing. + */ + void (*set_prefix) (struct sprinter *, const char *); + +To support the plain text format properly, the following additional +function must also be implemented: + + /* Set the current string prefix. This only affects the text + * printer, which will print this string, followed by a colon, + * before any string. For other printers, this does nothing. + */ + void (*set_prefix) (struct sprinter *, const char *); + +The structure also contains a flag that should be set to FALSE in all +custom printers and to TRUE in the plain text formatter. + + /* True if this is the special-cased plain text printer. + */ + notmuch_bool_t is_text_printer; + +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 | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + 1 file changed, 58 insertions(+) + +diff --git a/sprinter.h b/sprinter.h +new file mode 100644 +index 0000000..77dc26f +--- /dev/null ++++ b/sprinter.h +@@ -0,0 +1,58 @@ ++#ifndef NOTMUCH_SPRINTER_H ++#define NOTMUCH_SPRINTER_H ++ ++/* Necessary for notmuch_bool_t */ ++#include "notmuch-client.h" ++ ++/* Structure printer interface. This is used to create output ++ * structured as maps (with key/value pairs), lists and primitives ++ * (strings, integers and booleans). ++ */ ++typedef struct sprinter { ++ /* Start a new map/dictionary structure. This should be followed by ++ * a sequence of alternating calls to map_key and one of the ++ * value-printing functions until the map is ended by end. ++ */ ++ 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, followed or preceded by separators). ++ * For string, the char * must be UTF-8 encoded. ++ */ ++ 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. The char * must be UTF-8 ++ * encoded. ++ */ ++ void (*map_key) (struct sprinter *, const char *); ++ ++ /* Insert a separator (usually extra whitespace) for improved ++ * readability without affecting the abstract syntax of the ++ * structure being printed. ++ * For JSON, this could simply be a line break. ++ */ ++ void (*separator) (struct sprinter *); ++ ++ /* Set the current string prefix. This only affects the text ++ * printer, which will print this string, followed by a colon, ++ * before any string. For other printers, this does nothing. ++ */ ++ void (*set_prefix) (struct sprinter *, const char *); ++ ++ /* True if this is the special-cased plain text printer. ++ */ ++ notmuch_bool_t is_text_printer; ++} sprinter_t; ++ ++#endif // NOTMUCH_SPRINTER_H +-- +1.7.11.2 + -- 2.26.2