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