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