X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=sprinter.h;h=f859672f8b3f23342c25b5d50f6e64437c03dac7;hp=6680d41958e209e0e30705cb153297809833810f;hb=60ac94fe58635f9c40724afa0f35965fc9ff1afc;hpb=36522fca1cac6ca23c2c4c0280e3e20e96f7bfbb diff --git a/sprinter.h b/sprinter.h index 6680d419..f859672f 100644 --- a/sprinter.h +++ b/sprinter.h @@ -23,11 +23,16 @@ 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). For + * string (but not string_len) the string pointer passed may be + * NULL. */ 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 *); @@ -37,10 +42,11 @@ typedef struct sprinter { */ 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. + /* Insert a separator (usually extra whitespace). For the text + * printers, this is a syntactic separator. For the structured + * printers, this is 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 *); @@ -61,8 +67,18 @@ typedef struct sprinter { struct sprinter * sprinter_text_create (const void *ctx, FILE *stream); +/* Create a new unstructured printer that emits the text format for + * "notmuch search", with each field separated by a null character + * instead of the newline character. */ +struct sprinter * +sprinter_text0_create (const void *ctx, FILE *stream); + /* Create a new structure printer that emits JSON. */ struct sprinter * sprinter_json_create (const void *ctx, FILE *stream); +/* Create a new structure printer that emits S-Expressions. */ +struct sprinter * +sprinter_sexp_create (const void *ctx, FILE *stream); + #endif // NOTMUCH_SPRINTER_H