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
27 #define _GNU_SOURCE /* For getline */
33 #include <sys/types.h>
47 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
48 * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
50 /* these macros gain us a few percent of speed on gcc */
52 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
53 as its first argument */
55 #define likely(x) __builtin_expect(!!(x), 1)
58 #define unlikely(x) __builtin_expect(!!(x), 0)
65 #define unlikely(x) (x)
69 /* These value numbers are chosen to be sup compatible (for now at
73 NOTMUCH_VALUE_MESSAGE_ID = 0,
74 NOTMUCH_VALUE_THREAD = 1,
75 NOTMUCH_VALUE_DATE = 2
80 xcalloc (size_t nmemb, size_t size);
83 xmalloc (size_t size);
86 xrealloc (void *ptrr, size_t size);
89 xstrdup (const char *s);
92 xstrndup (const char *s, size_t n);
97 _notmuch_message_create (notmuch_results_t *owner,
98 notmuch_database_t *notmuch,
103 /* XXX: I haven't decided yet whether these will actually get exported
104 * into the public interface in notmuch.h
107 typedef struct _notmuch_message_file notmuch_message_file_t;
109 /* Open a file containing a single email message.
111 * The caller should call notmuch_message_close when done with this.
113 * Returns NULL if any error occurs.
115 notmuch_message_file_t *
116 notmuch_message_file_open (const char *filename);
118 /* Close a notmuch message preivously opened with notmuch_message_open. */
120 notmuch_message_file_close (notmuch_message_file_t *message);
122 /* Restrict 'message' to only save the named headers.
124 * When the caller is only interested in a short list of headers,
125 * known in advance, calling this function can avoid wasted time and
126 * memory parsing/saving header values that will never be needed.
128 * The variable arguments should be a list of const char * with a
129 * final '(const char *) NULL' to terminate the list.
131 * If this function is called, it must be called before any calls to
132 * notmuch_message_get_header for this message.
134 * After calling this function, if notmuch_message_get_header is
135 * called with a header name not in this list, then NULL will be
136 * returned even if that header exists in the actual message.
139 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
141 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
143 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
146 /* Get the value of the specified header from the message.
148 * The header name is case insensitive.
150 * The returned value is owned by the notmuch message and is valid
151 * only until the message is closed. The caller should copy it if
152 * needing to modify the value or to hold onto it for longer.
154 * Returns NULL if the message does not contain a header line matching
158 notmuch_message_file_get_header (notmuch_message_file_t *message,
163 /* Parse an RFC 8222 date string to a time_t value.
165 * The tz_offset argument can be used to also obtain the time-zone
166 * offset, (but can be NULL if the call is not interested in that).
168 * Returns 0 on error.
171 notmuch_parse_date (const char *str, int *tz_offset);