configure: replace $(realpath emacs) with $(cd emacs && pwd -P)
[notmuch] / lib / notmuch-private.h
1 /* notmuch-private.h - Internal interfaces for notmuch.
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see https://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_PRIVATE_H
22 #define NOTMUCH_PRIVATE_H
23
24 #ifndef _GNU_SOURCE
25 #define _GNU_SOURCE /* For getline and asprintf */
26 #endif
27 #include <stdbool.h>
28 #include <stdio.h>
29
30 #include "compat.h"
31
32 #include "notmuch.h"
33
34 NOTMUCH_BEGIN_DECLS
35
36 #include <stdlib.h>
37 #include <stdarg.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <sys/mman.h>
41 #include <string.h>
42 #include <errno.h>
43 #include <fcntl.h>
44 #include <unistd.h>
45 #include <ctype.h>
46 #include <assert.h>
47
48 #include <talloc.h>
49
50 #include "gmime-extra.h"
51
52 #include "xutil.h"
53 #include "error_util.h"
54 #include "string-util.h"
55 #include "crypto.h"
56 #include "repair.h"
57
58 #ifdef DEBUG
59 # define DEBUG_DATABASE_SANITY 1
60 # define DEBUG_THREADING 1
61 # define DEBUG_QUERY 1
62 #endif
63
64 #define COMPILE_TIME_ASSERT(pred) ((void) sizeof (char[1 - 2 * ! (pred)]))
65
66 #define STRNCMP_LITERAL(var, literal) \
67     strncmp ((var), (literal), sizeof (literal) - 1)
68
69 /* Robust bit test/set/reset macros */
70 #define _NOTMUCH_VALID_BIT(bit) \
71     ((bit) >= 0 && ((unsigned long) bit) < CHAR_BIT * sizeof (unsigned long long))
72 #define NOTMUCH_TEST_BIT(val, bit) \
73     (_NOTMUCH_VALID_BIT (bit) ? ! ! ((val) & (1ull << (bit))) : 0)
74 #define NOTMUCH_SET_BIT(valp, bit) \
75     (_NOTMUCH_VALID_BIT (bit) ? (*(valp) |= (1ull << (bit))) : *(valp))
76 #define NOTMUCH_CLEAR_BIT(valp,  bit) \
77     (_NOTMUCH_VALID_BIT (bit) ? (*(valp) &= ~(1ull << (bit))) : *(valp))
78
79 #define unused(x) x __attribute__ ((unused))
80
81 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
82  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
83  */
84 /* these macros gain us a few percent of speed on gcc */
85 #if (__GNUC__ >= 3)
86 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
87  * as its first argument */
88 #ifndef likely
89 #define likely(x)   __builtin_expect (! ! (x), 1)
90 #endif
91 #ifndef unlikely
92 #define unlikely(x) __builtin_expect (! ! (x), 0)
93 #endif
94 #else
95 #ifndef likely
96 #define likely(x) (x)
97 #endif
98 #ifndef unlikely
99 #define unlikely(x) (x)
100 #endif
101 #endif
102
103 typedef enum {
104     NOTMUCH_VALUE_TIMESTAMP = 0,
105     NOTMUCH_VALUE_MESSAGE_ID,
106     NOTMUCH_VALUE_FROM,
107     NOTMUCH_VALUE_SUBJECT,
108     NOTMUCH_VALUE_LAST_MOD,
109 } notmuch_value_t;
110
111 /* Xapian (with flint backend) complains if we provide a term longer
112  * than this, but I haven't yet found a way to query the limit
113  * programmatically. */
114 #define NOTMUCH_TERM_MAX 245
115
116 #define NOTMUCH_METADATA_THREAD_ID_PREFIX "thread_id_"
117
118 /* For message IDs we have to be even more restrictive. Beyond fitting
119  * into the term limit, we also use message IDs to construct
120  * metadata-key values. And the documentation says that these should
121  * be restricted to about 200 characters. (The actual limit for the
122  * chert backend at least is 252.)
123  */
124 #define NOTMUCH_MESSAGE_ID_MAX (200 - sizeof (NOTMUCH_METADATA_THREAD_ID_PREFIX))
125
126 typedef enum _notmuch_private_status {
127     /* First, copy all the public status values. */
128     NOTMUCH_PRIVATE_STATUS_SUCCESS                      = NOTMUCH_STATUS_SUCCESS,
129     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY                = NOTMUCH_STATUS_OUT_OF_MEMORY,
130     NOTMUCH_PRIVATE_STATUS_READ_ONLY_DATABASE           = NOTMUCH_STATUS_READ_ONLY_DATABASE,
131     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION             = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
132     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL               = NOTMUCH_STATUS_FILE_NOT_EMAIL,
133     NOTMUCH_PRIVATE_STATUS_NULL_POINTER                 = NOTMUCH_STATUS_NULL_POINTER,
134     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG                 = NOTMUCH_STATUS_TAG_TOO_LONG,
135     NOTMUCH_PRIVATE_STATUS_UNBALANCED_FREEZE_THAW       = NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
136
137     /* Then add our own private values. */
138     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG                = NOTMUCH_STATUS_LAST_STATUS,
139     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
140     NOTMUCH_PRIVATE_STATUS_BAD_PREFIX,
141
142     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
143 } notmuch_private_status_t;
144
145 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
146  * value, generating an internal error if the private value is equal
147  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
148  * that the caller has previously handled any expected
149  * notmuch_private_status_t values.)
150  *
151  * Note that the function _internal_error does not return. Evaluating
152  * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
153  */
154 #define COERCE_STATUS(private_status, format, ...)                      \
155     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS) \
156      ?                                                                  \
157      _internal_error (format " (%s).\n",                                \
158                       ##__VA_ARGS__,                                    \
159                       __location__),                                    \
160      (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS                  \
161      :                                                                  \
162      (notmuch_status_t) private_status)
163
164 /* Flags shared by various lookup functions. */
165 typedef enum _notmuch_find_flags {
166     /* Lookup without creating any documents.  This is the default
167      * behavior. */
168     NOTMUCH_FIND_LOOKUP = 0,
169     /* If set, create the necessary document (or documents) if they
170      * are missing.  Requires a read/write database. */
171     NOTMUCH_FIND_CREATE = 1 << 0,
172 } notmuch_find_flags_t;
173
174 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
175
176 /* database.cc */
177
178 /* Lookup a prefix value by name.
179  *
180  * XXX: This should really be static inside of message.cc, and we can
181  * do that once we convert database.cc to use the
182  * _notmuch_message_add/remove_term functions. */
183 const char *
184 _find_prefix (const char *name);
185
186 /* Lookup a prefix value by name, including possibly user defined prefixes
187  */
188 const char *
189 _notmuch_database_prefix (notmuch_database_t *notmuch, const char *name);
190
191 char *
192 _notmuch_message_id_compressed (void *ctx, const char *message_id);
193
194 notmuch_status_t
195 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
196
197 notmuch_status_t
198 _notmuch_database_reopen (notmuch_database_t *notmuch);
199
200 void
201 _notmuch_database_log (notmuch_database_t *notmuch,
202                        const char *format, ...);
203
204 void
205 _notmuch_database_log_append (notmuch_database_t *notmuch,
206                               const char *format, ...);
207
208 unsigned long
209 _notmuch_database_new_revision (notmuch_database_t *notmuch);
210
211 const char *
212 _notmuch_database_relative_path (notmuch_database_t *notmuch,
213                                  const char *path);
214
215 notmuch_status_t
216 _notmuch_database_split_path (void *ctx,
217                               const char *path,
218                               const char **directory,
219                               const char **basename);
220
221 const char *
222 _notmuch_database_get_directory_db_path (const char *path);
223
224 unsigned int
225 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
226
227 notmuch_private_status_t
228 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
229                                       const char *prefix_name,
230                                       const char *value,
231                                       unsigned int *doc_id);
232
233 notmuch_status_t
234 _notmuch_database_find_directory_id (notmuch_database_t *database,
235                                      const char *path,
236                                      notmuch_find_flags_t flags,
237                                      unsigned int *directory_id);
238
239 const char *
240 _notmuch_database_get_directory_path (void *ctx,
241                                       notmuch_database_t *notmuch,
242                                       unsigned int doc_id);
243
244 notmuch_status_t
245 _notmuch_database_filename_to_direntry (void *ctx,
246                                         notmuch_database_t *notmuch,
247                                         const char *filename,
248                                         notmuch_find_flags_t flags,
249                                         char **direntry);
250
251 /* directory.cc */
252
253 notmuch_directory_t *
254 _notmuch_directory_find_or_create (notmuch_database_t *notmuch,
255                                    const char *path,
256                                    notmuch_find_flags_t flags,
257                                    notmuch_status_t *status_ret);
258
259 unsigned int
260 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
261
262 notmuch_database_mode_t
263 _notmuch_database_mode (notmuch_database_t *notmuch);
264
265 /* message.cc */
266
267 notmuch_message_t *
268 _notmuch_message_create (const void *talloc_owner,
269                          notmuch_database_t *notmuch,
270                          unsigned int doc_id,
271                          notmuch_private_status_t *status);
272
273 notmuch_message_t *
274 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
275                                         const char *message_id,
276                                         notmuch_private_status_t *status);
277
278 unsigned int
279 _notmuch_message_get_doc_id (notmuch_message_t *message);
280
281 const char *
282 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
283
284 notmuch_private_status_t
285 _notmuch_message_add_term (notmuch_message_t *message,
286                            const char *prefix_name,
287                            const char *value);
288
289 notmuch_private_status_t
290 _notmuch_message_remove_term (notmuch_message_t *message,
291                               const char *prefix_name,
292                               const char *value);
293
294 notmuch_private_status_t
295 _notmuch_message_has_term (notmuch_message_t *message,
296                            const char *prefix_name,
297                            const char *value,
298                            bool *result);
299
300 notmuch_private_status_t
301 _notmuch_message_gen_terms (notmuch_message_t *message,
302                             const char *prefix_name,
303                             const char *text);
304
305 void
306 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
307
308 void
309 _notmuch_message_upgrade_folder (notmuch_message_t *message);
310
311 notmuch_status_t
312 _notmuch_message_add_filename (notmuch_message_t *message,
313                                const char *filename);
314
315 notmuch_status_t
316 _notmuch_message_remove_filename (notmuch_message_t *message,
317                                   const char *filename);
318
319 notmuch_status_t
320 _notmuch_message_rename (notmuch_message_t *message,
321                          const char *new_filename);
322
323 void
324 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
325
326 void
327 _notmuch_message_set_header_values (notmuch_message_t *message,
328                                     const char *date,
329                                     const char *from,
330                                     const char *subject);
331
332 void
333 _notmuch_message_update_subject (notmuch_message_t *message,
334                                  const char *subject);
335
336 void
337 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
338
339 void
340 _notmuch_message_sync (notmuch_message_t *message);
341
342 notmuch_status_t
343 _notmuch_message_delete (notmuch_message_t *message);
344
345 notmuch_private_status_t
346 _notmuch_message_initialize_ghost (notmuch_message_t *message,
347                                    const char *thread_id);
348
349 void
350 _notmuch_message_close (notmuch_message_t *message);
351
352 /* Get a copy of the data in this message document.
353  *
354  * Caller should talloc_free the result when done.
355  *
356  * This function is intended to support database upgrade and really
357  * shouldn't be used otherwise. */
358 char *
359 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
360
361 /* Clear the data in this message document.
362  *
363  * This function is intended to support database upgrade and really
364  * shouldn't be used otherwise. */
365 void
366 _notmuch_message_clear_data (notmuch_message_t *message);
367
368 /* Set the author member of 'message' - this is the representation used
369  * when displaying the message */
370 void
371 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
372
373 /* Get the author member of 'message' */
374 const char *
375 _notmuch_message_get_author (notmuch_message_t *message);
376
377 /* message-file.c */
378
379 /* XXX: I haven't decided yet whether these will actually get exported
380  * into the public interface in notmuch.h
381  */
382
383 typedef struct _notmuch_message_file notmuch_message_file_t;
384
385 /* Open a file containing a single email message.
386  *
387  * The caller should call notmuch_message_close when done with this.
388  *
389  * Returns NULL if any error occurs.
390  */
391 notmuch_message_file_t *
392 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
393
394 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
395 notmuch_message_file_t *
396 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
397                                 void *ctx, const char *filename);
398
399 /* Close a notmuch message previously opened with notmuch_message_open. */
400 void
401 _notmuch_message_file_close (notmuch_message_file_t *message);
402
403 /* Parse the message.
404  *
405  * This will be done automatically as necessary on other calls
406  * depending on it, but an explicit call allows for better error
407  * status reporting.
408  */
409 notmuch_status_t
410 _notmuch_message_file_parse (notmuch_message_file_t *message);
411
412 /* Get the gmime message of a message file.
413  *
414  * The message file is parsed as necessary.
415  *
416  * The GMimeMessage* is set to *mime_message on success (which the
417  * caller must not unref).
418  *
419  * XXX: Would be nice to not have to expose GMimeMessage here.
420  */
421 notmuch_status_t
422 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
423                                         GMimeMessage **mime_message);
424
425 /* Get the value of the specified header from the message as a UTF-8 string.
426  *
427  * The message file is parsed as necessary.
428  *
429  * The header name is case insensitive.
430  *
431  * The Received: header is special - for it all Received: headers in
432  * the message are concatenated
433  *
434  * The returned value is owned by the notmuch message and is valid
435  * only until the message is closed. The caller should copy it if
436  * needing to modify the value or to hold onto it for longer.
437  *
438  * Returns NULL on errors, empty string if the message does not
439  * contain a header line matching 'header'.
440  */
441 const char *
442 _notmuch_message_file_get_header (notmuch_message_file_t *message,
443                                   const char *header);
444
445 notmuch_status_t
446 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
447                                    const char **from_out,
448                                    const char **subject_out,
449                                    const char **to_out,
450                                    const char **date_out,
451                                    char **message_id_out);
452
453 const char *
454 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
455
456 /* add-message.cc */
457 notmuch_status_t
458 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
459                                            notmuch_message_t *message,
460                                            notmuch_message_file_t *message_file,
461                                            const char **thread_id);
462 /* index.cc */
463
464 notmuch_status_t
465 _notmuch_message_index_file (notmuch_message_t *message,
466                              notmuch_indexopts_t *indexopts,
467                              notmuch_message_file_t *message_file);
468
469 /* messages.c */
470
471 typedef struct _notmuch_message_node {
472     notmuch_message_t *message;
473     struct _notmuch_message_node *next;
474 } notmuch_message_node_t;
475
476 typedef struct _notmuch_message_list {
477     notmuch_message_node_t *head;
478     notmuch_message_node_t **tail;
479 } notmuch_message_list_t;
480
481 /* There's a rumor that there's an alternate struct _notmuch_messages
482  * somewhere with some nasty C++ objects in it. We'll try to maintain
483  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
484  */
485 struct _notmuch_messages {
486     bool is_of_list_type;
487     notmuch_doc_id_set_t *excluded_doc_ids;
488     notmuch_message_node_t *iterator;
489 };
490
491 notmuch_message_list_t *
492 _notmuch_message_list_create (const void *ctx);
493
494 bool
495 _notmuch_message_list_empty (notmuch_message_list_t *list);
496
497 void
498 _notmuch_message_list_add_message (notmuch_message_list_t *list,
499                                    notmuch_message_t *message);
500
501 notmuch_messages_t *
502 _notmuch_messages_create (notmuch_message_list_t *list);
503
504 bool
505 _notmuch_messages_has_next (notmuch_messages_t *messages);
506
507 /* query.cc */
508
509 bool
510 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
511
512 notmuch_message_t *
513 _notmuch_mset_messages_get (notmuch_messages_t *messages);
514
515 void
516 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
517
518 bool
519 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
520                               unsigned int doc_id);
521
522 void
523 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
524                             unsigned int doc_id);
525
526 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
527 notmuch_status_t
528 _notmuch_query_search_documents (notmuch_query_t *query,
529                                  const char *type,
530                                  notmuch_messages_t **out);
531
532 notmuch_status_t
533 _notmuch_query_count_documents (notmuch_query_t *query,
534                                 const char *type,
535                                 unsigned *count_out);
536 /* message-id.c */
537
538 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
539  * comments, and the '<' and '>' delimiters.
540  *
541  * If not NULL, then *next will be made to point to the first character
542  * not parsed, (possibly pointing to the final '\0' terminator.
543  *
544  * Returns a newly talloc'ed string belonging to 'ctx'.
545  *
546  * Returns NULL if there is any error parsing the message-id. */
547 char *
548 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
549
550 /* Parse a message-id, discarding leading and trailing whitespace, and
551  * '<' and '>' delimiters.
552  *
553  * Apply a probably-stricter-than RFC definition of what is allowed in
554  * a message-id. In particular, forbid whitespace.
555  *
556  * Returns a newly talloc'ed string belonging to 'ctx'.
557  *
558  * Returns NULL if there is any error parsing the message-id.
559  */
560
561 char *
562 _notmuch_message_id_parse_strict (void *ctx, const char *message_id);
563
564
565 /* message.cc */
566
567 void
568 _notmuch_message_add_reply (notmuch_message_t *message,
569                             notmuch_message_t *reply);
570
571 void
572 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
573
574 const char *
575 _notmuch_message_get_thread_id_only (notmuch_message_t *message);
576
577 size_t _notmuch_message_get_thread_depth (notmuch_message_t *message);
578
579 void
580 _notmuch_message_label_depths (notmuch_message_t *message,
581                                size_t depth);
582
583 notmuch_message_list_t *
584 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list);
585
586 /* sha1.c */
587
588 char *
589 _notmuch_sha1_of_string (const char *str);
590
591 char *
592 _notmuch_sha1_of_file (const char *filename);
593
594 /* string-list.c */
595
596 typedef struct _notmuch_string_node {
597     char *string;
598     struct _notmuch_string_node *next;
599 } notmuch_string_node_t;
600
601 typedef struct _notmuch_string_list {
602     int length;
603     notmuch_string_node_t *head;
604     notmuch_string_node_t **tail;
605 } notmuch_string_list_t;
606
607 notmuch_string_list_t *
608 _notmuch_string_list_create (const void *ctx);
609
610 /*
611  * return the number of strings in 'list'
612  */
613 int
614 _notmuch_string_list_length (notmuch_string_list_t *list);
615
616 /* Add 'string' to 'list'.
617  *
618  * The list will create its own talloced copy of 'string'.
619  */
620 void
621 _notmuch_string_list_append (notmuch_string_list_t *list,
622                              const char *string);
623
624 void
625 _notmuch_string_list_sort (notmuch_string_list_t *list);
626
627 const notmuch_string_list_t *
628 _notmuch_message_get_references (notmuch_message_t *message);
629
630 /* string-map.c */
631 typedef struct _notmuch_string_map notmuch_string_map_t;
632 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
633 notmuch_string_map_t *
634 _notmuch_string_map_create (const void *ctx);
635
636 void
637 _notmuch_string_map_append (notmuch_string_map_t *map,
638                             const char *key,
639                             const char *value);
640
641 const char *
642 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
643
644 notmuch_string_map_iterator_t *
645 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
646                                      bool exact);
647
648 bool
649 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
650
651 void
652 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
653
654 const char *
655 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
656
657 const char *
658 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
659
660 void
661 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
662
663 /* Create an iterator for user headers. Destroy with
664  * _notmuch_string_map_iterator_destroy. Actually in database.cc*/
665 notmuch_string_map_iterator_t *
666 _notmuch_database_user_headers (notmuch_database_t *notmuch);
667
668 /* tags.c */
669
670 notmuch_tags_t *
671 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
672
673 /* filenames.c */
674
675 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
676  * file names */
677 notmuch_filenames_t *
678 _notmuch_filenames_create (const void *ctx,
679                            notmuch_string_list_t *list);
680
681 /* thread.cc */
682
683 notmuch_thread_t *
684 _notmuch_thread_create (void *ctx,
685                         notmuch_database_t *notmuch,
686                         unsigned int seed_doc_id,
687                         notmuch_doc_id_set_t *match_set,
688                         notmuch_string_list_t *excluded_terms,
689                         notmuch_exclude_t omit_exclude,
690                         notmuch_sort_t sort);
691
692 /* indexopts.c */
693
694 struct _notmuch_indexopts {
695     _notmuch_crypto_t crypto;
696 };
697
698 #define CONFIG_HEADER_PREFIX "index.header."
699
700 #define EMPTY_STRING(s) ((s)[0] == '\0')
701
702 NOTMUCH_END_DECLS
703
704 #ifdef __cplusplus
705 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
706  * C++. In talloc_steal, an explicit cast is provided for type safety
707  * in some GCC versions. Otherwise, a cast is required. Provide a
708  * template function for this to maintain type safety, and redefine
709  * talloc_steal to use it.
710  */
711 #if ! (__GNUC__ >= 3)
712 template <class T> T *
713 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
714 {
715     return static_cast<T *> (talloc_steal (new_ctx, ptr));
716 }
717 #undef talloc_steal
718 #define talloc_steal _notmuch_talloc_steal
719 #endif
720 #endif
721
722 #endif