unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob eec00cf43a932f40748ecc46b11bfe3fbe8d7034 3580 bytes (raw)
name: tag-util.h 	 # note: path name is non-authoritative(*)

  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
 
#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),

    /* Directly look up messages by hex-decoded message-id, rather
     * than parsing a general query. The query MUST be of the form
     * id:$message-id. */
    TAG_FLAG_ID_DIRECT = (1 << 4)

} 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 successfuly. */
    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.
 */

tag_parse_status_t
parse_tag_command_line (void *ctx, int argc, char **argv,
			char **query_str, tag_op_list_t *ops);

/*
 * 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 (void *ctx,
		    tag_op_list_t *list,
		    const char *tag,
		    notmuch_bool_t remove);

/*
 * Apply a list of tag operations, in order, to a given message.
 *
 * Flags can be bitwise ORed; see enum above for possibilies.
 */

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?
 */

notmuch_bool_t
tag_op_list_isremove (const tag_op_list_t *list, size_t i);

#endif

debug log:

solving eec00cf ...
found eec00cf in https://yhetil.org/notmuch/1355599269-31503-1-git-send-email-david@tethera.net/ ||
	https://yhetil.org/notmuch/87sj6z7ctm.fsf@zancas.localnet/ ||
	https://yhetil.org/notmuch/1356095307-22895-8-git-send-email-david@tethera.net/
found 7674051 in https://yhetil.org/notmuch/1355492062-7546-7-git-send-email-david@tethera.net/
found 2889736 in https://yhetil.org/notmuch/1356095307-22895-3-git-send-email-david@tethera.net/ ||
	https://yhetil.org/notmuch/1355492062-7546-4-git-send-email-david@tethera.net/ ||
	https://yhetil.org/notmuch/1355492062-7546-1-git-send-email-david@tethera.net/
found 99b0fa0 in https://yhetil.org/notmuch.git/
preparing index
index prepared:
100644 99b0fa0b41636dc162214f16aa9b0a0888bfa0c4	tag-util.h

applying [1/3] https://yhetil.org/notmuch/1356095307-22895-3-git-send-email-david@tethera.net/
diff --git a/tag-util.h b/tag-util.h
index 99b0fa0..2889736 100644

Checking patch tag-util.h...
Applied patch tag-util.h cleanly.

skipping https://yhetil.org/notmuch/1355492062-7546-4-git-send-email-david@tethera.net/ for 2889736
skipping https://yhetil.org/notmuch/1355492062-7546-1-git-send-email-david@tethera.net/ for 2889736
index at:
100644 2889736061c12db8fb511447ea17ec52f33439a7	tag-util.h

applying [2/3] https://yhetil.org/notmuch/1355492062-7546-7-git-send-email-david@tethera.net/
diff --git a/tag-util.h b/tag-util.h
index 2889736..7674051 100644


applying [3/3] https://yhetil.org/notmuch/1355599269-31503-1-git-send-email-david@tethera.net/
diff --git a/tag-util.h b/tag-util.h
index 7674051..eec00cf 100644

Checking patch tag-util.h...
Applied patch tag-util.h cleanly.
Checking patch tag-util.h...
Applied patch tag-util.h cleanly.

skipping https://yhetil.org/notmuch/87sj6z7ctm.fsf@zancas.localnet/ for eec00cf
skipping https://yhetil.org/notmuch/1356095307-22895-8-git-send-email-david@tethera.net/ for eec00cf
index at:
100644 eec00cf43a932f40748ecc46b11bfe3fbe8d7034	tag-util.h

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).