X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=sprinter.h;h=f859672f8b3f23342c25b5d50f6e64437c03dac7;hp=5f4317570a059814922402bbe89643e6c7db00b0;hb=3fed6736a7ef8b8b1f05d0fabb136bdd3b5917ee;hpb=14883b07003b9ed4223cd8f2c03b301fddae07bd diff --git a/sprinter.h b/sprinter.h index 5f431757..f859672f 100644 --- a/sprinter.h +++ b/sprinter.h @@ -27,7 +27,9 @@ typedef struct sprinter { * 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). + * (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); @@ -40,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 *); @@ -64,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