1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
#ifndef _TAG_UTIL_H
#define _TAG_UTIL_H
#include "notmuch-client.h"
typedef struct _tag_operation_t tag_operation_t;
typedef struct _tag_op_list_t tag_op_list_t;
/* Use powers of 2 */
typedef enum {
TAG_FLAG_NONE = 0,
/* Operations are synced to maildir, if possible.
*/
TAG_FLAG_MAILDIR_SYNC = (1 << 0),
/* Remove all tags from message before applying list.
*/
TAG_FLAG_REMOVE_ALL = (1 << 1),
/* Don't try to avoid database operations. Useful when we
* know that message passed needs these operations.
*/
TAG_FLAG_PRE_OPTIMIZED = (1 << 2),
/* Accept strange tags that might be user error;
* intended for use by notmuch-restore.
*/
TAG_FLAG_BE_GENEROUS = (1 << 3)
} tag_op_flag_t;
/* These should obey the convention that fatal errors are negative,
* skipped lines are positive.
*/
typedef enum {
TAG_PARSE_OUT_OF_MEMORY = -1,
/* Line parsed successfully. */
TAG_PARSE_SUCCESS = 0,
/* Line has a syntax error */
TAG_PARSE_INVALID = 1,
/* Line was blank or a comment */
TAG_PARSE_SKIPPED = 2
} tag_parse_status_t;
/* Parse a string of the following format:
*
* +<tag>|-<tag> [...] [--] <search-terms>
*
* Each line is interpreted similarly to "notmuch tag" command line
* arguments. The delimiter is one or more spaces ' '. Any characters
* in <tag> and <search-terms> MAY be hex encoded with %NN where NN is
* the hexadecimal value of the character. Any ' ' and '%' characters
* in <tag> and <search-terms> MUST be hex encoded (using %20 and %25,
* respectively). Any characters that are not part of <tag> or
* <search-terms> MUST NOT be hex encoded.
*
* Leading and trailing space ' ' is ignored. Empty lines and lines
* beginning with '#' are ignored.
*
*
* Output Parameters:
* ops contains a list of tag operations
* query_str the search terms.
*/
tag_parse_status_t
parse_tag_line (void *ctx, char *line,
tag_op_flag_t flags,
char **query_str, tag_op_list_t *ops);
/* Parse a command line of the following format:
*
* +<tag>|-<tag> [...] [--] <search-terms>
*
* Output Parameters:
* ops contains a list of tag operations
* query_str the search terms.
*
* The ops argument is not cleared.
*/
tag_parse_status_t
parse_tag_command_line (void *ctx, int argc, char **argv,
char **query_str, tag_op_list_t *ops);
/*
* Test tags for some forbidden cases.
*
* Relax the checks if 'remove' is true to allow removal of previously
* added forbidden tags.
*
* return: NULL if OK,
* explanatory message otherwise.
*/
const char *
illegal_tag (const char *tag, bool remove);
/*
* Create an empty list of tag operations
*
* ctx is passed to talloc
*/
tag_op_list_t *
tag_op_list_create (void *ctx);
/*
* Add a tag operation (delete iff remove == true) to a list.
* The list is expanded as necessary.
*/
int
tag_op_list_append (tag_op_list_t *list,
const char *tag,
bool remove);
/*
* Apply a list of tag operations, in order, to a given message.
*
* Flags can be bitwise ORed; see enum above for possibilities.
*/
notmuch_status_t
tag_op_list_apply (notmuch_message_t *message,
tag_op_list_t *tag_ops,
tag_op_flag_t flags);
/*
* Return the number of operations in a list
*/
size_t
tag_op_list_size (const tag_op_list_t *list);
/*
* Reset a list to contain no operations
*/
void
tag_op_list_reset (tag_op_list_t *list);
/*
* return the i'th tag in the list
*/
const char *
tag_op_list_tag (const tag_op_list_t *list, size_t i);
/*
* Is the i'th tag operation a remove?
*/
bool
tag_op_list_isremove (const tag_op_list_t *list, size_t i);
#endif
|
