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 /* Lookup a prefix value by name.
112 * XXX: This should really be static inside of message.cc, and we can
113 * do that once we convert database.cc to use the
114 * _notmuch_message_add/remove_term functions. */
116 _find_prefix (const char *name);
118 notmuch_private_status_t
119 _notmuch_message_add_term (notmuch_message_t *message,
120 const char *prefix_name,
123 notmuch_private_status_t
124 _notmuch_message_remove_term (notmuch_message_t *message,
125 const char *prefix_name,
129 _notmuch_message_set_filename (notmuch_message_t *message,
130 const char *filename);
133 _notmuch_message_add_thread_id (notmuch_message_t *message,
134 const char *thread_id);
137 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
140 _notmuch_message_set_date (notmuch_message_t *message,
144 _notmuch_message_sync (notmuch_message_t *message);
148 /* XXX: I haven't decided yet whether these will actually get exported
149 * into the public interface in notmuch.h
152 typedef struct _notmuch_message_file notmuch_message_file_t;
154 /* Open a file containing a single email message.
156 * The caller should call notmuch_message_close when done with this.
158 * Returns NULL if any error occurs.
160 notmuch_message_file_t *
161 notmuch_message_file_open (const char *filename);
163 /* Close a notmuch message preivously opened with notmuch_message_open. */
165 notmuch_message_file_close (notmuch_message_file_t *message);
167 /* Restrict 'message' to only save the named headers.
169 * When the caller is only interested in a short list of headers,
170 * known in advance, calling this function can avoid wasted time and
171 * memory parsing/saving header values that will never be needed.
173 * The variable arguments should be a list of const char * with a
174 * final '(const char *) NULL' to terminate the list.
176 * If this function is called, it must be called before any calls to
177 * notmuch_message_get_header for this message.
179 * After calling this function, if notmuch_message_get_header is
180 * called with a header name not in this list, then NULL will be
181 * returned even if that header exists in the actual message.
184 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
186 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
188 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
191 /* Get the value of the specified header from the message.
193 * The header name is case insensitive.
195 * The returned value is owned by the notmuch message and is valid
196 * only until the message is closed. The caller should copy it if
197 * needing to modify the value or to hold onto it for longer.
199 * Returns NULL if the message does not contain a header line matching
203 notmuch_message_file_get_header (notmuch_message_file_t *message,
208 /* Parse an RFC 8222 date string to a time_t value.
210 * The tz_offset argument can be used to also obtain the time-zone
211 * offset, (but can be NULL if the call is not interested in that).
213 * Returns 0 on error.
216 notmuch_parse_date (const char *str, int *tz_offset);
220 /* Create a hexadecimal string version of the SHA-1 digest of the
223 * This function returns a newly allocated string which the caller
224 * should free() when finished.
226 * If any error occurs while reading the file, (permission denied,
227 * file not found, etc.), this function returns NULL.
230 notmuch_sha1_of_file (const char *filename);