doc: fix documentation typos and copy/paste-os

[notmuch] / sprinter.h

diff --git a/sprinter.h b/sprinter.h
index 6680d41958e209e0e30705cb153297809833810f..9d2e9b6f7140ad4f2aa2eae6d9981cb858d56019 100644 (file)
--- a/sprinter.h
+++ b/sprinter.h
@@ -1,7 +1,7 @@
 #ifndef NOTMUCH_SPRINTER_H
 #define NOTMUCH_SPRINTER_H
 
-/* Necessary for notmuch_bool_t */
+/* Necessary for bool */
 #include "notmuch-client.h"
 
 /* Structure printer interface. This is used to create output
@@ -23,13 +23,18 @@ 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 (*boolean) (struct sprinter *, bool);
     void (*null) (struct sprinter *);
 
     /* Print the key of a map's key/value pair. The char * must be UTF-8
@@ -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 *);
 
@@ -52,7 +58,7 @@ typedef struct sprinter {
 
     /* True if this is the special-cased plain text printer.
      */
-    notmuch_bool_t is_text_printer;
+    bool is_text_printer;
 } sprinter_t;
 
 
@@ -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