util: Factor out boolean term quoting routine

[notmuch] / util / string-util.h

diff --git a/util/string-util.h b/util/string-util.h
index ac7676c883d742febbbcc3614f2f6a35a57eefe1..719c276a1da908df967e392774f01cd0d6218683 100644 (file)
--- a/util/string-util.h
+++ b/util/string-util.h
@@ -19,4 +19,19 @@
 
 char *strtok_len (char *s, const char *delim, size_t *len);
 
+/* Construct a boolean term query with the specified prefix (e.g.,
+ * "id") and search term, quoting term as necessary.  Specifically, if
+ * term contains any non-printable ASCII characters, non-ASCII
+ * characters, close parenthesis or double quotes, it will be enclosed
+ * in double quotes and any internal double quotes will be doubled
+ * (e.g. a"b -> "a""b").  The result will be a valid notmuch query and
+ * can be parsed by parse_boolean_term.
+ *
+ * Output is into buf; it may be talloc_realloced.
+ * Return: 0 on success, -1 on error.  errno will be set to ENOMEM if
+ * there is an allocation failure.
+ */
+int make_boolean_term (void *talloc_ctx, const char *prefix, const char *term,
+                      char **buf, size_t *len);
+
 #endif