From 36522fca1cac6ca23c2c4c0280e3e20e96f7bfbb Mon Sep 17 00:00:00 2001 From: "craven@gmx.net" Date: Mon, 23 Jul 2012 12:39:45 +0200 Subject: Add structured output formatter for JSON and plain text (but don't use them yet). Using the new structured printer support in sprinter.h, implement sprinter_json_create, which returns a new JSON structured output formatter. The formatter prints output similar to the existing JSON, but with differences in whitespace (mostly newlines, --output=summary prints the entire message summary on one line, not split across multiple lines). Also implement a "structured" formatter for plain text that prints prefixed strings, to be used with notmuch-search.c plain text output. --- sprinter-text.c | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 sprinter-text.c (limited to 'sprinter-text.c') diff --git a/sprinter-text.c b/sprinter-text.c new file mode 100644 index 0000000..b208840 --- /dev/null +++ b/sprinter-text.c @@ -0,0 +1,126 @@ +#include +#include +#include +#include "sprinter.h" + +/* "Structured printer" interface for unstructured text printing. + * Note that --output=summary is dispatched and formatted in + * notmuch-search.c, the code in this file is only used for all other + * output types. + */ + +struct sprinter_text { + struct sprinter vtable; + FILE *stream; + + /* The current prefix to be printed with string/integer/boolean + * data. + */ + const char *current_prefix; + + /* A flag to indicate if this is the first tag. Used in list of tags + * for summary. + */ + notmuch_bool_t first_tag; +}; + +static void +text_string (struct sprinter *sp, const char *val) +{ + struct sprinter_text *sptxt = (struct sprinter_text *) sp; + + if (sptxt->current_prefix != NULL) + fprintf (sptxt->stream, "%s:", sptxt->current_prefix); + + fputs(val, sptxt->stream); +} + +static void +text_integer (struct sprinter *sp, int val) +{ + struct sprinter_text *sptxt = (struct sprinter_text *) sp; + + fprintf (sptxt->stream, "%d", val); +} + +static void +text_boolean (struct sprinter *sp, notmuch_bool_t val) +{ + struct sprinter_text *sptxt = (struct sprinter_text *) sp; + + fputs (val ? "true" : "false", sptxt->stream); +} + +static void +text_separator (struct sprinter *sp) +{ + struct sprinter_text *sptxt = (struct sprinter_text *) sp; + + fputc ('\n', sptxt->stream); +} + +static void +text_set_prefix (struct sprinter *sp, const char *prefix) +{ + struct sprinter_text *sptxt = (struct sprinter_text *) sp; + + sptxt->current_prefix = prefix; +} + +/* The structure functions begin_map, begin_list, end and map_key + * don't do anything in the text formatter. + */ + +static void +text_begin_map (unused (struct sprinter *sp)) +{ +} + +static void +text_begin_list (unused (struct sprinter *sp)) +{ +} + +static void +text_end (unused (struct sprinter *sp)) +{ +} + +static void +text_null (unused (struct sprinter *sp)) +{ +} + +static void +text_map_key (unused (struct sprinter *sp), unused (const char *key)) +{ +} + +struct sprinter * +sprinter_text_create (const void *ctx, FILE *stream) +{ + static const struct sprinter_text template = { + .vtable = { + .begin_map = text_begin_map, + .begin_list = text_begin_list, + .end = text_end, + .string = text_string, + .integer = text_integer, + .boolean = text_boolean, + .null = text_null, + .map_key = text_map_key, + .separator = text_separator, + .set_prefix = text_set_prefix, + .is_text_printer = TRUE, + }, + }; + struct sprinter_text *res; + + res = talloc (ctx, struct sprinter_text); + if (! res) + return NULL; + + *res = template; + res->stream = stream; + return &res->vtable; +} -- cgit v1.2.3 From 14883b07003b9ed4223cd8f2c03b301fddae07bd Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Thu, 2 Aug 2012 21:14:49 -0400 Subject: sprinter: Add a string_len method This method allows callers to output strings with specific lengths. It's useful both for strings with embedded NULs (which JSON can represent, though parser support is apparently spotty), and non-terminated strings. --- sprinter-json.c | 16 ++++++++++++++-- sprinter-text.c | 11 +++++++++-- sprinter.h | 9 ++++++--- 3 files changed, 29 insertions(+), 7 deletions(-) (limited to 'sprinter-text.c') diff --git a/sprinter-json.c b/sprinter-json.c index 4649655..c9b6835 100644 --- a/sprinter-json.c +++ b/sprinter-json.c @@ -88,8 +88,13 @@ json_end (struct sprinter *sp) fputc ('\n', spj->stream); } +/* This implementation supports embedded NULs as allowed by the JSON + * specification and Unicode. Support for *parsing* embedded NULs + * varies, but is generally not a problem outside of C-based parsers + * (Python's json module and Emacs' json.el take embedded NULs in + * stride). */ static void -json_string (struct sprinter *sp, const char *val) +json_string_len (struct sprinter *sp, const char *val, size_t len) { static const char *const escapes[] = { ['\"'] = "\\\"", ['\\'] = "\\\\", ['\b'] = "\\b", @@ -98,7 +103,7 @@ json_string (struct sprinter *sp, const char *val) struct sprinter_json *spj = json_begin_value (sp); fputc ('"', spj->stream); - for (; *val; ++val) { + for (; len; ++val, --len) { unsigned char ch = *val; if (ch < ARRAY_SIZE (escapes) && escapes[ch]) fputs (escapes[ch], spj->stream); @@ -110,6 +115,12 @@ json_string (struct sprinter *sp, const char *val) fputc ('"', spj->stream); } +static void +json_string (struct sprinter *sp, const char *val) +{ + json_string_len (sp, val, strlen (val)); +} + static void json_integer (struct sprinter *sp, int val) { @@ -166,6 +177,7 @@ sprinter_json_create (const void *ctx, FILE *stream) .begin_list = json_begin_list, .end = json_end, .string = json_string, + .string_len = json_string_len, .integer = json_integer, .boolean = json_boolean, .null = json_null, diff --git a/sprinter-text.c b/sprinter-text.c index b208840..dfa54b5 100644 --- a/sprinter-text.c +++ b/sprinter-text.c @@ -25,14 +25,20 @@ struct sprinter_text { }; static void -text_string (struct sprinter *sp, const char *val) +text_string_len (struct sprinter *sp, const char *val, size_t len) { struct sprinter_text *sptxt = (struct sprinter_text *) sp; if (sptxt->current_prefix != NULL) fprintf (sptxt->stream, "%s:", sptxt->current_prefix); - fputs(val, sptxt->stream); + fwrite (val, len, 1, sptxt->stream); +} + +static void +text_string (struct sprinter *sp, const char *val) +{ + text_string_len (sp, val, strlen (val)); } static void @@ -105,6 +111,7 @@ sprinter_text_create (const void *ctx, FILE *stream) .begin_list = text_begin_list, .end = text_end, .string = text_string, + .string_len = text_string_len, .integer = text_integer, .boolean = text_boolean, .null = text_null, diff --git a/sprinter.h b/sprinter.h index 6680d41..5f43175 100644 --- a/sprinter.h +++ b/sprinter.h @@ -23,11 +23,14 @@ typedef struct sprinter { */ 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. + /* Print one string/integer/boolean/null element (possibly inside + * a list or map, followed or preceded by separators). For string + * and string_len, the char * must be UTF-8 encoded. string_len + * allows non-terminated strings and strings with embedded NULs + * (though the handling of the latter is format-dependent). */ void (*string) (struct sprinter *, const char *); + void (*string_len) (struct sprinter *, const char *, size_t); void (*integer) (struct sprinter *, int); void (*boolean) (struct sprinter *, notmuch_bool_t); void (*null) (struct sprinter *); -- cgit v1.2.3