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
29 #define _GNU_SOURCE /* For getline */
35 #include <sys/types.h>
48 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
49 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
51 /* these macros gain us a few percent of speed on gcc */
53 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
54 as its first argument */
56 #define likely(x) __builtin_expect(!!(x), 1)
59 #define unlikely(x) __builtin_expect(!!(x), 0)
66 #define unlikely(x) (x)
70 /* These value numbers are chosen to be sup compatible (for now at
74 NOTMUCH_VALUE_MESSAGE_ID = 0,
75 NOTMUCH_VALUE_THREAD = 1,
76 NOTMUCH_VALUE_DATE = 2
79 /* Xapian (with flint backend) complains if we provide a term longer
80 * than this, but I haven't yet found a way to query the limit
81 * programmatically. */
82 #define NOTMUCH_TERM_MAX 245
84 typedef enum _notmuch_private_status {
85 /* First, copy all the public status values. */
86 NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
87 NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
88 NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
89 NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
90 NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
92 /* Then add our own private values. */
93 NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG,
95 NOTMUCH_PRIVATE_STATUS_LAST_STATUS
96 } notmuch_private_status_t;
101 _notmuch_message_create (const void *talloc_owner,
102 notmuch_database_t *notmuch,
103 unsigned int doc_id);
106 _notmuch_message_create_for_message_id (const void *talloc_owner,
107 notmuch_database_t *notmuch,
108 const char *message_id);
110 /* XXX: Here temporarily during code movement only. */
111 /* "128 bits of thread-id ought to be enough for anybody" */
112 #define NOTMUCH_THREAD_ID_BITS 128
113 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
114 typedef struct _thread_id {
115 char str[NOTMUCH_THREAD_ID_DIGITS + 1];
120 thread_id_generate (thread_id_t *thread_id);
122 /* Lookup a prefix value by name.
124 * XXX: This should really be static inside of message.cc, and we can
125 * do that once we convert database.cc to use the
126 * _notmuch_message_add/remove_term functions. */
128 _find_prefix (const char *name);
130 notmuch_private_status_t
131 _notmuch_message_add_term (notmuch_message_t *message,
132 const char *prefix_name,
135 notmuch_private_status_t
136 _notmuch_message_remove_term (notmuch_message_t *message,
137 const char *prefix_name,
141 _notmuch_message_set_filename (notmuch_message_t *message,
142 const char *filename);
145 _notmuch_message_add_thread_id (notmuch_message_t *message,
146 const char *thread_id);
149 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
152 _notmuch_message_set_date (notmuch_message_t *message,
156 _notmuch_message_sync (notmuch_message_t *message);
160 /* XXX: I haven't decided yet whether these will actually get exported
161 * into the public interface in notmuch.h
164 typedef struct _notmuch_message_file notmuch_message_file_t;
166 /* Open a file containing a single email message.
168 * The caller should call notmuch_message_close when done with this.
170 * Returns NULL if any error occurs.
172 notmuch_message_file_t *
173 notmuch_message_file_open (const char *filename);
175 /* Close a notmuch message preivously opened with notmuch_message_open. */
177 notmuch_message_file_close (notmuch_message_file_t *message);
179 /* Restrict 'message' to only save the named headers.
181 * When the caller is only interested in a short list of headers,
182 * known in advance, calling this function can avoid wasted time and
183 * memory parsing/saving header values that will never be needed.
185 * The variable arguments should be a list of const char * with a
186 * final '(const char *) NULL' to terminate the list.
188 * If this function is called, it must be called before any calls to
189 * notmuch_message_get_header for this message.
191 * After calling this function, if notmuch_message_get_header is
192 * called with a header name not in this list, then NULL will be
193 * returned even if that header exists in the actual message.
196 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
198 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
200 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
203 /* Get the value of the specified header from the message.
205 * The header name is case insensitive.
207 * The returned value is owned by the notmuch message and is valid
208 * only until the message is closed. The caller should copy it if
209 * needing to modify the value or to hold onto it for longer.
211 * Returns NULL if the message does not contain a header line matching
215 notmuch_message_file_get_header (notmuch_message_file_t *message,
220 /* Parse an RFC 8222 date string to a time_t value.
222 * The tz_offset argument can be used to also obtain the time-zone
223 * offset, (but can be NULL if the call is not interested in that).
225 * Returns 0 on error.
228 notmuch_parse_date (const char *str, int *tz_offset);
232 /* Create a hexadecimal string version of the SHA-1 digest of the
235 * This function returns a newly allocated string which the caller
236 * should free() when finished.
238 * If any error occurs while reading the file, (permission denied,
239 * file not found, etc.), this function returns NULL.
242 notmuch_sha1_of_file (const char *filename);