Re: [PATCH 1/3] Adding an S-expression structured output printer.
authorMark Walters <markwalters1009@gmail.com>
Sat, 1 Dec 2012 12:24:41 +0000 (12:24 +0000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:51:15 +0000 (09:51 -0800)
55/e2f3c185474208cc73b37bd2562f701122807b [new file with mode: 0644]

diff --git a/55/e2f3c185474208cc73b37bd2562f701122807b b/55/e2f3c185474208cc73b37bd2562f701122807b
new file mode 100644 (file)
index 0000000..db961dd
--- /dev/null
@@ -0,0 +1,426 @@
+Return-Path: <m.walters@qmul.ac.uk>\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 8D701431FAF\r
+       for <notmuch@notmuchmail.org>; Sat,  1 Dec 2012 04:24:51 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+       tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+       NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 7F0MUf3xfwVN for <notmuch@notmuchmail.org>;\r
+       Sat,  1 Dec 2012 04:24:47 -0800 (PST)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 7E194431FAE\r
+       for <notmuch@notmuchmail.org>; Sat,  1 Dec 2012 04:24:47 -0800 (PST)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+       by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1Tem7e-0002WG-NU; Sat, 01 Dec 2012 12:24:43 +0000\r
+Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
+       by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1Tem7e-0000LH-1u; Sat, 01 Dec 2012 12:24:42 +0000\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Tomi Ollila <tomi.ollila@iki.fi>, Peter Feigl <craven@gmx.net>,\r
+       notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 1/3] Adding an S-expression structured output printer.\r
+In-Reply-To: <m2txs6vwdy.fsf@guru.guru-group.fi>\r
+References: <1354264143-30173-1-git-send-email-craven@gmx.net>\r
+       <871ufa9jpm.fsf@qmul.ac.uk> <m2txs6vwdy.fsf@guru.guru-group.fi>\r
+User-Agent: Notmuch/0.14+81~g9730584 (http://notmuchmail.org) Emacs/23.4.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sat, 01 Dec 2012 12:24:41 +0000\r
+Message-ID: <87d2yu559y.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 93.97.24.31\r
+X-QM-SPAM-Info: Sender has good ham record.  :)\r
+X-QM-Body-MD5: 5553d8decc91db96e731e5c4c01d264b (of first 20000 bytes)\r
+X-SpamAssassin-Score: -1.7\r
+X-SpamAssassin-SpamBar: -\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+       determine if it is\r
+       spam. We require at least 5.0 points to mark a message as spam.\r
+       This message scored -1.7 points.\r
+       Summary of the scoring: \r
+       * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
+       *      medium trust\r
+       *      [138.37.6.40 listed in list.dnswl.org]\r
+       * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+       provider *      (markwalters1009[at]gmail.com)\r
+       *  0.6 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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: Sat, 01 Dec 2012 12:24:51 -0000\r
+\r
+\r
+On Sat, 01 Dec 2012, Tomi Ollila <tomi.ollila@iki.fi> wrote:\r
+> On Sat, Dec 01 2012, Mark Walters wrote:\r
+>\r
+>> Hi\r
+>>\r
+>> Overall I like the series: I think I agree with all of Jani's\r
+>> comments. \r
+>>\r
+>> My one extra comment is that I think we should decide on whether we also\r
+>> want a sexp plist version. I think we might want one for the emacs\r
+>> front-end as that currently uses plists for everything.\r
+>>\r
+>> If we do we might want to change the names a little, both for functions\r
+>> and options (eg sexp_a and sexp_p or something). Probably a lot of\r
+>> sprinter-sexp would be common to both versions.\r
+>\r
+> This is an important question that needs to be addressed fast: options\r
+> are:\r
+>\r
+> 1) have options to spit both alist & plist formats\r
+> 2) when converting emacs to use s-expressions, convert it to use alists\r
+> 3) start using plists instead of alists in Peter's android client\r
+\r
+Ok I have looked at this and the changes needed to output plist (or\r
+both) are pretty small: the only functions from sprinter-sexp.c that\r
+need to be changed are sexp_end and sexp_map_key. The total diff from\r
+alist to plist is about 10 lines. I have a version which allows both\r
+(the same sprinter file creates both possibilities) and have hooked it\r
+into emacs/notmuch-show.el and it all seems to work. \r
+\r
+(Search is more difficult as that uses the async parser; indeed even for\r
+show I used sexp-at-point as suggested by Tomi which seems rather\r
+underdocumented but does seem to work)\r
+\r
+Given the ease with which we can allow both I think that would be my\r
+preference: the biggest problem is that slightly more cluttered option\r
+list (i.e., we have to allow both --format=sexpa and --format=sexpp or\r
+similar).\r
+\r
+(I can post the patch doing the above but almost all of it is modifying the\r
+commands to choose alist or plist rather than modifying the\r
+sprinter-sexp itself)\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+\r
+\r
+>\r
+>\r
+> In case (1) is chosen then we just need to support one more format.\r
+>\r
+> How much work would it involve to convert emacs to receive content in\r
+> alists (and how feasible would that be)?\r
+>\r
+> How much work would it require in Peter's client to use plists (and how\r
+> feasible would that be)?\r
+>\r
+>>\r
+>> Best wishes\r
+>>\r
+>> Mark\r
+>\r
+> Tomi\r
+>\r
+>\r
+>>\r
+>>\r
+>> On Fri, 30 Nov 2012, Peter Feigl <craven@gmx.net> wrote:\r
+>>> This commit adds an sprinter for Lisp S-Expressions. Later commits will\r
+>>> use this printer.\r
+>>>\r
+>>> The structure is the same as json, but:\r
+>>> - arrays are written as lists: ("foo" "bar" "baaz" 1 2 3)\r
+>>> - maps are written as a-lists: ((key "value") (other-key "other-value"))\r
+>>> - true is written as t\r
+>>> - false is written as nil\r
+>>> - null is written as nil\r
+>>> ---\r
+>>>  Makefile.local  |   1 +\r
+>>>  sprinter-sexp.c | 235 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+>>>  2 files changed, 236 insertions(+)\r
+>>>  create mode 100644 sprinter-sexp.c\r
+>>>\r
+>>> diff --git a/Makefile.local b/Makefile.local\r
+>>> index 2b91946..0db1713 100644\r
+>>> --- a/Makefile.local\r
+>>> +++ b/Makefile.local\r
+>>> @@ -270,6 +270,7 @@ notmuch_client_srcs =          \\r
+>>>    notmuch-tag.c           \\r
+>>>    notmuch-time.c          \\r
+>>>    sprinter-json.c         \\r
+>>> +  sprinter-sexp.c         \\r
+>>>    sprinter-text.c         \\r
+>>>    query-string.c          \\r
+>>>    mime-node.c             \\r
+>>> diff --git a/sprinter-sexp.c b/sprinter-sexp.c\r
+>>> new file mode 100644\r
+>>> index 0000000..8401c52\r
+>>> --- /dev/null\r
+>>> +++ b/sprinter-sexp.c\r
+>>> @@ -0,0 +1,235 @@\r
+>>> +#include <stdbool.h>\r
+>>> +#include <stdio.h>\r
+>>> +#include <talloc.h>\r
+>>> +#include "sprinter.h"\r
+>>> +\r
+>>> +struct sprinter_sexp {\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 sexp_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 sexp_state {\r
+>>> +    struct sexp_state *parent;\r
+>>> +\r
+>>> +    /* True if nothing has been printed in this aggregate yet.\r
+>>> +     * Suppresses the space before a value. */\r
+>>> +    notmuch_bool_t first;\r
+>>> +\r
+>>> +    /* True if the state is a map state.\r
+>>> +       Used to add a space between key/value pairs. */\r
+>>> +    notmuch_bool_t in_map;\r
+>>> +\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 space. */\r
+>>> +static struct sprinter_sexp *\r
+>>> +sexp_begin_value (struct sprinter *sp)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = (struct sprinter_sexp *) sp;\r
+>>> +\r
+>>> +    if (sps->state) {\r
+>>> +        if (! sps->state->first) {\r
+>>> +            if (sps->insert_separator) {\r
+>>> +                fputc ('\n', sps->stream);\r
+>>> +                sps->insert_separator = FALSE;\r
+>>> +            } else {\r
+>>> +                if( ! sps->state->in_map)\r
+>>> +                    fputc (' ', sps->stream);\r
+>>> +            }\r
+>>> +        } else {\r
+>>> +            sps->state->first = FALSE;\r
+>>> +        }\r
+>>> +    }\r
+>>> +    return sps;\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
+>>> +sexp_begin_aggregate (struct sprinter *sp, char open, char close)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = sexp_begin_value (sp);\r
+>>> +    struct sexp_state *state = talloc (sps, struct sexp_state);\r
+>>> +    fputc (open, sps->stream);\r
+>>> +    state->parent = sps->state;\r
+>>> +    state->first = TRUE;\r
+>>> +    state->in_map = FALSE;\r
+>>> +    state->close = close;\r
+>>> +    sps->state = state;\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_begin_map (struct sprinter *sp)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = (struct sprinter_sexp *) sp;\r
+>>> +    sexp_begin_aggregate (sp, '(', ')');\r
+>>> +    sps->state->in_map = TRUE;\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_begin_list (struct sprinter *sp)\r
+>>> +{\r
+>>> +    sexp_begin_aggregate (sp, '(', ')');\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_end (struct sprinter *sp)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = (struct sprinter_sexp *) sp;\r
+>>> +    struct sexp_state *state = sps->state;\r
+>>> +\r
+>>> +    if (sps->state->in_map)\r
+>>> +        fputc (')', sps->stream);\r
+>>> +    fputc (sps->state->close, sps->stream);\r
+>>> +    sps->state = state->parent;\r
+>>> +    talloc_free (state);\r
+>>> +    if (sps->state == NULL)\r
+>>> +        fputc ('\n', sps->stream);\r
+>>> +}\r
+>>> +\r
+>>> +/* This implementation supports embedded NULs as allowed by the JSON\r
+>>> + * specification and Unicode.  Support for *parsing* embedded NULs\r
+>>> + * varies, but is generally not a problem outside of C-based parsers\r
+>>> + * (Python's json module and Emacs' json.el take embedded NULs in\r
+>>> + * stride). */\r
+>>> +static void\r
+>>> +sexp_string_len_internal (struct sprinter *sp, const char *val, size_t len, notmuch_bool_t quote)\r
+>>> +{\r
+>>> +    static const char *const escapes[] = {\r
+>>> +        ['\"'] = "\\\"", ['\\'] = "\\\\", ['\b'] = "\\b",\r
+>>> +        ['\f'] = "\\f",  ['\n'] = "\\n",  ['\t'] = "\\t"\r
+>>> +    };\r
+>>> +    struct sprinter_sexp *sps = sexp_begin_value (sp);\r
+>>> +\r
+>>> +    if(quote)\r
+>>> +        fputc ('"', sps->stream);\r
+>>> +    for (; len; ++val, --len) {\r
+>>> +        unsigned char ch = *val;\r
+>>> +        if (ch < ARRAY_SIZE (escapes) && escapes[ch])\r
+>>> +            fputs (escapes[ch], sps->stream);\r
+>>> +        else if (ch >= 32)\r
+>>> +            fputc (ch, sps->stream);\r
+>>> +        else\r
+>>> +            fprintf (sps->stream, "\\u%04x", ch);\r
+>>> +    }\r
+>>> +    if(quote)\r
+>>> +        fputc ('"', sps->stream);\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_string_len (struct sprinter *sp, const char *val, size_t len)\r
+>>> +{\r
+>>> +    sexp_string_len_internal (sp, val, len, TRUE); /* print quoted */\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_symbol_len (struct sprinter *sp, const char *val, size_t len)\r
+>>> +{\r
+>>> +    sexp_string_len_internal (sp, val, len, FALSE); /* print unquoted */\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_string (struct sprinter *sp, const char *val)\r
+>>> +{\r
+>>> +    if (val == NULL)\r
+>>> +        val = "";\r
+>>> +    sexp_string_len (sp, val, strlen (val));\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_symbol (struct sprinter *sp, const char *val)\r
+>>> +{\r
+>>> +    if (val == NULL)\r
+>>> +        val = "";\r
+>>> +    sexp_symbol_len (sp, val, strlen (val));\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_integer (struct sprinter *sp, int val)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = sexp_begin_value (sp);\r
+>>> +\r
+>>> +    fprintf (sps->stream, "%d", val);\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_boolean (struct sprinter *sp, notmuch_bool_t val)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = sexp_begin_value (sp);\r
+>>> +\r
+>>> +    fputs (val ? "t" : "nil", sps->stream);\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_null (struct sprinter *sp)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = sexp_begin_value (sp);\r
+>>> +\r
+>>> +    fputs ("nil", sps->stream);\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_map_key (struct sprinter *sp, const char *key)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = (struct sprinter_sexp *) sp;\r
+>>> +\r
+>>> +    if( sps->state->in_map && ! sps->state->first)\r
+>>> +        fputs (") ", sps->stream);\r
+>>> +    fputc ('(', sps->stream);\r
+>>> +    sexp_symbol (sp, key);\r
+>>> +    fputc (' ', sps->stream);\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_set_prefix (unused (struct sprinter *sp), unused (const char *name))\r
+>>> +{\r
+>>> +}\r
+>>> +\r
+>>> +static void\r
+>>> +sexp_separator (struct sprinter *sp)\r
+>>> +{\r
+>>> +    struct sprinter_sexp *sps = (struct sprinter_sexp *) sp;\r
+>>> +\r
+>>> +    sps->insert_separator = TRUE;\r
+>>> +}\r
+>>> +\r
+>>> +struct sprinter *\r
+>>> +sprinter_sexp_create (const void *ctx, FILE *stream)\r
+>>> +{\r
+>>> +    static const struct sprinter_sexp template = {\r
+>>> +        .vtable = {\r
+>>> +            .begin_map = sexp_begin_map,\r
+>>> +            .begin_list = sexp_begin_list,\r
+>>> +            .end = sexp_end,\r
+>>> +            .string = sexp_string,\r
+>>> +            .string_len = sexp_string_len,\r
+>>> +            .integer = sexp_integer,\r
+>>> +            .boolean = sexp_boolean,\r
+>>> +            .null = sexp_null,\r
+>>> +            .map_key = sexp_map_key,\r
+>>> +            .separator = sexp_separator,\r
+>>> +            .set_prefix = sexp_set_prefix,\r
+>>> +            .is_text_printer = FALSE,\r
+>>> +        }\r
+>>> +    };\r
+>>> +    struct sprinter_sexp *res;\r
+>>> +\r
+>>> +    res = talloc (ctx, struct sprinter_sexp);\r
+>>> +    if (! res)\r
+>>> +        return NULL;\r
+>>> +\r
+>>> +    *res = template;\r
+>>> +    res->stream = stream;\r
+>>> +    return &res->vtable;\r
+>>> +}\r
+>>> -- \r
+>>> 1.8.0\r
+>>>\r
+>>> _______________________________________________\r
+>>> notmuch mailing list\r
+>>> notmuch@notmuchmail.org\r
+>>> http://notmuchmail.org/mailman/listinfo/notmuch\r
+>> _______________________________________________\r
+>> notmuch mailing list\r
+>> notmuch@notmuchmail.org\r
+>> http://notmuchmail.org/mailman/listinfo/notmuch\r