]> git.cworth.org Git - obsolete/notmuch-old/blob - util/string-util.h
contrib: pick: make help close the message pane first
[obsolete/notmuch-old] / util / string-util.h
1 #ifndef _STRING_UTIL_H
2 #define _STRING_UTIL_H
3
4 #include <string.h>
5
6 /* like strtok(3), but without state, and doesn't modify s.  Return
7  * value is indicated by pointer and length, not null terminator.
8  *
9  * Usage pattern:
10  *
11  * const char *tok = input;
12  * const char *delim = " \t";
13  * size_t tok_len = 0;
14  *
15  * while ((tok = strtok_len (tok + tok_len, delim, &tok_len)) != NULL) {
16  *     // do stuff with string tok of length tok_len
17  * }
18  */
19
20 char *strtok_len (char *s, const char *delim, size_t *len);
21
22 /* Construct a boolean term query with the specified prefix (e.g.,
23  * "id") and search term, quoting term as necessary.  Specifically, if
24  * term contains any non-printable ASCII characters, non-ASCII
25  * characters, close parenthesis or double quotes, it will be enclosed
26  * in double quotes and any internal double quotes will be doubled
27  * (e.g. a"b -> "a""b").  The result will be a valid notmuch query and
28  * can be parsed by parse_boolean_term.
29  *
30  * Output is into buf; it may be talloc_realloced.
31  * Return: 0 on success, -1 on error.  errno will be set to ENOMEM if
32  * there is an allocation failure.
33  */
34 int make_boolean_term (void *talloc_ctx, const char *prefix, const char *term,
35                        char **buf, size_t *len);
36
37 /* Parse a boolean term query consisting of a prefix, a colon, and a
38  * term that may be quoted as described for make_boolean_term.  If the
39  * term is not quoted, then it ends at the first whitespace or close
40  * parenthesis.  str may containing leading or trailing whitespace,
41  * but anything else is considered a parse error.  This is compatible
42  * with anything produced by make_boolean_term, and supports a subset
43  * of the quoting styles supported by Xapian (and hence notmuch).
44  * *prefix_out and *term_out will be talloc'd with context ctx.
45  *
46  * Return: 0 on success, -1 on error.  errno will be set to EINVAL if
47  * there is a parse error or ENOMEM if there is an allocation failure.
48  */
49 int
50 parse_boolean_term (void *ctx, const char *str,
51                     char **prefix_out, char **term_out);
52
53 #endif