1 /* notmuch-private.h - Internal interfaces for notmuch.
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #ifndef NOTMUCH_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
25 #define _GNU_SOURCE /* For getline and asprintf */
35 #include <sys/types.h>
50 # define DEBUG_DATABASE_SANITY 1
51 # define DEBUG_QUERY 1
54 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
56 /* There's no point in continuing when we've detected that we've done
57 * something wrong internally (as opposed to the user passing in a
60 * Note that PRINTF_ATTRIBUTE comes from talloc.h
63 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
65 /* There's no point in continuing when we've detected that we've done
66 * something wrong internally (as opposed to the user passing in a
69 * Note that __location__ comes from talloc.h.
71 #define INTERNAL_ERROR(format, ...) \
72 _internal_error (format " (%s).\n", \
73 ##__VA_ARGS__, __location__)
75 #define unused(x) x __attribute__ ((unused))
77 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
78 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
80 /* these macros gain us a few percent of speed on gcc */
82 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
83 as its first argument */
85 #define likely(x) __builtin_expect(!!(x), 1)
88 #define unlikely(x) __builtin_expect(!!(x), 0)
95 #define unlikely(x) (x)
100 NOTMUCH_VALUE_TIMESTAMP = 0,
101 NOTMUCH_VALUE_MESSAGE_ID
104 /* Xapian (with flint backend) complains if we provide a term longer
105 * than this, but I haven't yet found a way to query the limit
106 * programmatically. */
107 #define NOTMUCH_TERM_MAX 245
109 typedef enum _notmuch_private_status {
110 /* First, copy all the public status values. */
111 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
112 NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
113 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
114 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
115 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
116 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
118 /* Then add our own private values. */
119 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG,
120 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
122 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
123 } notmuch_private_status_t;
125 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
126 * value, generating an internal error if the private value is equal
127 * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
128 * that the caller has previously handled any expected
129 * notmuch_private_status_t values.)
131 #define COERCE_STATUS(private_status, format, ...) \
132 ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
134 (notmuch_status_t) _internal_error (format " (%s).\n", \
138 (notmuch_status_t) private_status)
142 /* Lookup a prefix value by name.
144 * XXX: This should really be static inside of message.cc, and we can
145 * do that once we convert database.cc to use the
146 * _notmuch_message_add/remove_term functions. */
148 _find_prefix (const char *name);
153 _notmuch_thread_create (void *ctx,
154 notmuch_database_t *notmuch,
155 const char *thread_id,
156 const char *query_string);
161 _notmuch_message_create (const void *talloc_owner,
162 notmuch_database_t *notmuch,
164 notmuch_private_status_t *status);
167 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
168 const char *message_id,
169 notmuch_private_status_t *status);
172 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
174 notmuch_private_status_t
175 _notmuch_message_add_term (notmuch_message_t *message,
176 const char *prefix_name,
179 notmuch_private_status_t
180 _notmuch_message_remove_term (notmuch_message_t *message,
181 const char *prefix_name,
184 notmuch_private_status_t
185 _notmuch_message_gen_terms (notmuch_message_t *message,
186 const char *prefix_name,
190 _notmuch_message_set_filename (notmuch_message_t *message,
191 const char *filename);
194 _notmuch_message_add_thread_id (notmuch_message_t *message,
195 const char *thread_id);
198 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
201 _notmuch_message_set_date (notmuch_message_t *message,
205 _notmuch_message_sync (notmuch_message_t *message);
208 _notmuch_message_close (notmuch_message_t *message);
213 _notmuch_message_index_file (notmuch_message_t *message,
214 const char *filename);
218 /* XXX: I haven't decided yet whether these will actually get exported
219 * into the public interface in notmuch.h
222 typedef struct _notmuch_message_file notmuch_message_file_t;
224 /* Open a file containing a single email message.
226 * The caller should call notmuch_message_close when done with this.
228 * Returns NULL if any error occurs.
230 notmuch_message_file_t *
231 notmuch_message_file_open (const char *filename);
233 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
234 notmuch_message_file_t *
235 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
237 /* Close a notmuch message previously opened with notmuch_message_open. */
239 notmuch_message_file_close (notmuch_message_file_t *message);
241 /* Restrict 'message' to only save the named headers.
243 * When the caller is only interested in a short list of headers,
244 * known in advance, calling this function can avoid wasted time and
245 * memory parsing/saving header values that will never be needed.
247 * The variable arguments should be a list of const char * with a
248 * final '(const char *) NULL' to terminate the list.
250 * If this function is called, it must be called before any calls to
251 * notmuch_message_get_header for this message.
253 * After calling this function, if notmuch_message_get_header is
254 * called with a header name not in this list, then NULL will be
255 * returned even if that header exists in the actual message.
258 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
260 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
262 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
265 /* Get the value of the specified header from the message.
267 * The header name is case insensitive.
269 * The returned value is owned by the notmuch message and is valid
270 * only until the message is closed. The caller should copy it if
271 * needing to modify the value or to hold onto it for longer.
273 * Returns NULL if the message does not contain a header line matching
277 notmuch_message_file_get_header (notmuch_message_file_t *message,
282 typedef struct _notmuch_message_node {
283 notmuch_message_t *message;
284 struct _notmuch_message_node *next;
285 } notmuch_message_node_t;
287 typedef struct _notmuch_message_list {
288 notmuch_message_node_t *head;
289 notmuch_message_node_t **tail;
290 } notmuch_message_list_t;
292 notmuch_message_list_t *
293 _notmuch_message_list_create (const void *ctx);
296 _notmuch_message_list_append (notmuch_message_list_t *list,
297 notmuch_message_node_t *node);
300 _notmuch_message_list_add_message (notmuch_message_list_t *list,
301 notmuch_message_t *message);
304 _notmuch_messages_create (notmuch_message_list_t *list);
309 _notmuch_message_add_reply (notmuch_message_t *message,
310 notmuch_message_node_t *reply);
314 /* Parse an RFC 8222 date string to a time_t value.
316 * The tz_offset argument can be used to also obtain the time-zone
317 * offset, (but can be NULL if the call is not interested in that).
319 * Returns 0 on error.
322 notmuch_parse_date (const char *str, int *tz_offset);
327 notmuch_sha1_of_string (const char *str);
330 notmuch_sha1_of_file (const char *filename);
335 _notmuch_tags_create (void *ctx);
338 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
341 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);