git.cworth.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 ## _unused __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 {
 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_ERROR                   = NOTMUCH_STATUS_FILE_ERROR,
 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     NOTMUCH_PRIVATE_STATUS_UNBALANCED_ATOMIC            = NOTMUCH_STATUS_UNBALANCED_ATOMIC,
 136     NOTMUCH_PRIVATE_STATUS_UNSUPPORTED_OPERATION        = NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
 137     NOTMUCH_PRIVATE_STATUS_UPGRADE_REQUIRED             = NOTMUCH_STATUS_UPGRADE_REQUIRED,
 138     NOTMUCH_PRIVATE_STATUS_PATH_ERROR                   = NOTMUCH_STATUS_PATH_ERROR,
 139     NOTMUCH_PRIVATE_STATUS_IGNORED                      = NOTMUCH_STATUS_IGNORED,
 140     NOTMUCH_PRIVATE_STATUS_ILLEGAL_ARGUMENT             = NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
 141     NOTMUCH_PRIVATE_STATUS_MALFORMED_CRYPTO_PROTOCOL            = NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
 142     NOTMUCH_PRIVATE_STATUS_FAILED_CRYPTO_CONTEXT_CREATION       = NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
 143     NOTMUCH_PRIVATE_STATUS_UNKNOWN_CRYPTO_PROTOCOL              = NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
 144     NOTMUCH_PRIVATE_STATUS_NO_CONFIG                            = NOTMUCH_STATUS_NO_CONFIG,
 145     NOTMUCH_PRIVATE_STATUS_NO_DATABASE                          = NOTMUCH_STATUS_NO_DATABASE,
 146     NOTMUCH_PRIVATE_STATUS_DATABASE_EXISTS                      = NOTMUCH_STATUS_DATABASE_EXISTS,
 147     NOTMUCH_PRIVATE_STATUS_NO_MAIL_ROOT                         = NOTMUCH_STATUS_NO_MAIL_ROOT,
 148     NOTMUCH_PRIVATE_STATUS_BAD_QUERY_SYNTAX                     = NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
 149
 150     /* Then add our own private values. */
 151     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG                = NOTMUCH_STATUS_LAST_STATUS,
 152     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
 153     NOTMUCH_PRIVATE_STATUS_BAD_PREFIX,
 154
 155     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
 156 } notmuch_private_status_t;
 157
 158 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
 159  * value, generating an internal error if the private value is equal
 160  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
 161  * that the caller has previously handled any expected
 162  * notmuch_private_status_t values.)
 163  *
 164  * Note that the function _internal_error does not return. Evaluating
 165  * to NOTMUCH_STATUS_SUCCESS is done purely to appease the compiler.
 166  */
 167 #define COERCE_STATUS(private_status, format, ...)                      \
 168     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS) \
 169      ?                                                                  \
 170      _internal_error (format " (%s).\n",                                \
 171                       ##__VA_ARGS__,                                    \
 172                       __location__),                                    \
 173      (notmuch_status_t) NOTMUCH_PRIVATE_STATUS_SUCCESS                  \
 174      :                                                                  \
 175      (notmuch_status_t) private_status)
 176
 177 /* Flags shared by various lookup functions. */
 178 typedef enum {
 179     /* Lookup without creating any documents.  This is the default
 180      * behavior. */
 181     NOTMUCH_FIND_LOOKUP = 0,
 182     /* If set, create the necessary document (or documents) if they
 183      * are missing.  Requires a read/write database. */
 184     NOTMUCH_FIND_CREATE = 1 << 0,
 185 } notmuch_find_flags_t;
 186
 187 typedef struct _notmuch_doc_id_set notmuch_doc_id_set_t;
 188
 189 /* database.cc */
 190
 191 /* Lookup a prefix value by name.
 192  *
 193  * XXX: This should really be static inside of message.cc, and we can
 194  * do that once we convert database.cc to use the
 195  * _notmuch_message_add/remove_term functions. */
 196 const char *
 197 _find_prefix (const char *name);
 198
 199 /* Lookup a prefix value by name, including possibly user defined prefixes
 200  */
 201 const char *
 202 _notmuch_database_prefix (notmuch_database_t *notmuch, const char *name);
 203
 204 char *
 205 _notmuch_message_id_compressed (void *ctx, const char *message_id);
 206
 207 notmuch_status_t
 208 _notmuch_database_ensure_writable (notmuch_database_t *notmuch);
 209
 210 void
 211 _notmuch_database_log (notmuch_database_t *notmuch,
 212                        const char *format, ...);
 213
 214 void
 215 _notmuch_database_log_append (notmuch_database_t *notmuch,
 216                               const char *format, ...);
 217
 218 unsigned long
 219 _notmuch_database_new_revision (notmuch_database_t *notmuch);
 220
 221 const char *
 222 _notmuch_database_relative_path (notmuch_database_t *notmuch,
 223                                  const char *path);
 224
 225 notmuch_status_t
 226 _notmuch_database_split_path (void *ctx,
 227                               const char *path,
 228                               const char **directory,
 229                               const char **basename);
 230
 231 const char *
 232 _notmuch_database_get_directory_db_path (const char *path);
 233
 234 unsigned int
 235 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch);
 236
 237 notmuch_private_status_t
 238 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
 239                                       const char *prefix_name,
 240                                       const char *value,
 241                                       unsigned int *doc_id);
 242
 243 notmuch_status_t
 244 _notmuch_database_find_directory_id (notmuch_database_t *database,
 245                                      const char *path,
 246                                      notmuch_find_flags_t flags,
 247                                      unsigned int *directory_id);
 248
 249 const char *
 250 _notmuch_database_get_directory_path (void *ctx,
 251                                       notmuch_database_t *notmuch,
 252                                       unsigned int doc_id);
 253
 254 notmuch_status_t
 255 _notmuch_database_filename_to_direntry (void *ctx,
 256                                         notmuch_database_t *notmuch,
 257                                         const char *filename,
 258                                         notmuch_find_flags_t flags,
 259                                         char **direntry);
 260
 261 /* directory.cc */
 262
 263 notmuch_directory_t *
 264 _notmuch_directory_find_or_create (notmuch_database_t *notmuch,
 265                                    const char *path,
 266                                    notmuch_find_flags_t flags,
 267                                    notmuch_status_t *status_ret);
 268
 269 unsigned int
 270 _notmuch_directory_get_document_id (notmuch_directory_t *directory);
 271
 272 notmuch_database_mode_t
 273 _notmuch_database_mode (notmuch_database_t *notmuch);
 274
 275 /* message.cc */
 276
 277 notmuch_message_t *
 278 _notmuch_message_create (const void *talloc_owner,
 279                          notmuch_database_t *notmuch,
 280                          unsigned int doc_id,
 281                          notmuch_private_status_t *status);
 282
 283 notmuch_message_t *
 284 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 285                                         const char *message_id,
 286                                         notmuch_private_status_t *status);
 287
 288 unsigned int
 289 _notmuch_message_get_doc_id (notmuch_message_t *message);
 290
 291 const char *
 292 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
 293
 294 notmuch_private_status_t
 295 _notmuch_message_add_term (notmuch_message_t *message,
 296                            const char *prefix_name,
 297                            const char *value);
 298
 299 notmuch_private_status_t
 300 _notmuch_message_remove_term (notmuch_message_t *message,
 301                               const char *prefix_name,
 302                               const char *value);
 303
 304 notmuch_private_status_t
 305 _notmuch_message_has_term (notmuch_message_t *message,
 306                            const char *prefix_name,
 307                            const char *value,
 308                            bool *result);
 309
 310 notmuch_private_status_t
 311 _notmuch_message_gen_terms (notmuch_message_t *message,
 312                             const char *prefix_name,
 313                             const char *text);
 314
 315 void
 316 _notmuch_message_upgrade_filename_storage (notmuch_message_t *message);
 317
 318 void
 319 _notmuch_message_upgrade_folder (notmuch_message_t *message);
 320
 321 notmuch_status_t
 322 _notmuch_message_add_filename (notmuch_message_t *message,
 323                                const char *filename);
 324
 325 notmuch_status_t
 326 _notmuch_message_remove_filename (notmuch_message_t *message,
 327                                   const char *filename);
 328
 329 notmuch_status_t
 330 _notmuch_message_rename (notmuch_message_t *message,
 331                          const char *new_filename);
 332
 333 void
 334 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
 335
 336 void
 337 _notmuch_message_set_header_values (notmuch_message_t *message,
 338                                     const char *date,
 339                                     const char *from,
 340                                     const char *subject);
 341
 342 void
 343 _notmuch_message_update_subject (notmuch_message_t *message,
 344                                  const char *subject);
 345
 346 void
 347 _notmuch_message_upgrade_last_mod (notmuch_message_t *message);
 348
 349 void
 350 _notmuch_message_sync (notmuch_message_t *message);
 351
 352 notmuch_status_t
 353 _notmuch_message_delete (notmuch_message_t *message);
 354
 355 notmuch_private_status_t
 356 _notmuch_message_initialize_ghost (notmuch_message_t *message,
 357                                    const char *thread_id);
 358
 359 void
 360 _notmuch_message_close (notmuch_message_t *message);
 361
 362 /* Get a copy of the data in this message document.
 363  *
 364  * Caller should talloc_free the result when done.
 365  *
 366  * This function is intended to support database upgrade and really
 367  * shouldn't be used otherwise. */
 368 char *
 369 _notmuch_message_talloc_copy_data (notmuch_message_t *message);
 370
 371 /* Clear the data in this message document.
 372  *
 373  * This function is intended to support database upgrade and really
 374  * shouldn't be used otherwise. */
 375 void
 376 _notmuch_message_clear_data (notmuch_message_t *message);
 377
 378 /* Set the author member of 'message' - this is the representation used
 379  * when displaying the message */
 380 void
 381 _notmuch_message_set_author (notmuch_message_t *message, const char *author);
 382
 383 /* Get the author member of 'message' */
 384 const char *
 385 _notmuch_message_get_author (notmuch_message_t *message);
 386
 387 /* message-file.c */
 388
 389 /* XXX: I haven't decided yet whether these will actually get exported
 390  * into the public interface in notmuch.h
 391  */
 392
 393 typedef struct _notmuch_message_file notmuch_message_file_t;
 394
 395 /* Open a file containing a single email message.
 396  *
 397  * The caller should call notmuch_message_close when done with this.
 398  *
 399  * Returns NULL if any error occurs.
 400  */
 401 notmuch_message_file_t *
 402 _notmuch_message_file_open (notmuch_database_t *notmuch, const char *filename);
 403
 404 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 405 notmuch_message_file_t *
 406 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
 407                                 void *ctx, const char *filename);
 408
 409 /* Close a notmuch message previously opened with notmuch_message_open. */
 410 void
 411 _notmuch_message_file_close (notmuch_message_file_t *message);
 412
 413 /* Parse the message.
 414  *
 415  * This will be done automatically as necessary on other calls
 416  * depending on it, but an explicit call allows for better error
 417  * status reporting.
 418  */
 419 notmuch_status_t
 420 _notmuch_message_file_parse (notmuch_message_file_t *message);
 421
 422 /* Get the gmime message of a message file.
 423  *
 424  * The message file is parsed as necessary.
 425  *
 426  * The GMimeMessage* is set to *mime_message on success (which the
 427  * caller must not unref).
 428  *
 429  * XXX: Would be nice to not have to expose GMimeMessage here.
 430  */
 431 notmuch_status_t
 432 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
 433                                         GMimeMessage **mime_message);
 434
 435 /* Get the value of the specified header from the message as a UTF-8 string.
 436  *
 437  * The message file is parsed as necessary.
 438  *
 439  * The header name is case insensitive.
 440  *
 441  * The Received: header is special - for it all Received: headers in
 442  * the message are concatenated
 443  *
 444  * The returned value is owned by the notmuch message and is valid
 445  * only until the message is closed. The caller should copy it if
 446  * needing to modify the value or to hold onto it for longer.
 447  *
 448  * Returns NULL on errors, empty string if the message does not
 449  * contain a header line matching 'header'.
 450  */
 451 const char *
 452 _notmuch_message_file_get_header (notmuch_message_file_t *message,
 453                                   const char *header);
 454
 455 notmuch_status_t
 456 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
 457                                    const char **from_out,
 458                                    const char **subject_out,
 459                                    const char **to_out,
 460                                    const char **date_out,
 461                                    char **message_id_out);
 462
 463 const char *
 464 _notmuch_message_file_get_filename (notmuch_message_file_t *message);
 465
 466 /* add-message.cc */
 467 notmuch_status_t
 468 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
 469                                            notmuch_message_t *message,
 470                                            notmuch_message_file_t *message_file,
 471                                            const char **thread_id);
 472 /* index.cc */
 473
 474 void
 475 _notmuch_filter_init ();
 476
 477 notmuch_status_t
 478 _notmuch_message_index_file (notmuch_message_t *message,
 479                              notmuch_indexopts_t *indexopts,
 480                              notmuch_message_file_t *message_file);
 481
 482 /* init.cc */
 483 void
 484 _notmuch_init ();
 485
 486 /* messages.c */
 487
 488 typedef struct _notmuch_message_node {
 489     notmuch_message_t *message;
 490     struct _notmuch_message_node *next;
 491 } notmuch_message_node_t;
 492
 493 typedef struct _notmuch_message_list {
 494     notmuch_message_node_t *head;
 495     notmuch_message_node_t **tail;
 496 } notmuch_message_list_t;
 497
 498 /* There's a rumor that there's an alternate struct _notmuch_messages
 499  * somewhere with some nasty C++ objects in it. We'll try to maintain
 500  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
 501  */
 502 struct _notmuch_messages {
 503     bool is_of_list_type;
 504     notmuch_doc_id_set_t *excluded_doc_ids;
 505     notmuch_message_node_t *iterator;
 506 };
 507
 508 notmuch_message_list_t *
 509 _notmuch_message_list_create (const void *ctx);
 510
 511 bool
 512 _notmuch_message_list_empty (notmuch_message_list_t *list);
 513
 514 void
 515 _notmuch_message_list_add_message (notmuch_message_list_t *list,
 516                                    notmuch_message_t *message);
 517
 518 notmuch_messages_t *
 519 _notmuch_messages_create (notmuch_message_list_t *list);
 520
 521 bool
 522 _notmuch_messages_has_next (notmuch_messages_t *messages);
 523
 524 /* query.cc */
 525
 526 bool
 527 _notmuch_mset_messages_valid (notmuch_messages_t *messages);
 528
 529 notmuch_message_t *
 530 _notmuch_mset_messages_get (notmuch_messages_t *messages);
 531
 532 void
 533 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages);
 534
 535 bool
 536 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
 537                               unsigned int doc_id);
 538
 539 void
 540 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
 541                             unsigned int doc_id);
 542
 543 /* querying xapian documents by type (e.g. "mail" or "ghost"): */
 544 notmuch_status_t
 545 _notmuch_query_search_documents (notmuch_query_t *query,
 546                                  const char *type,
 547                                  notmuch_messages_t **out);
 548
 549 notmuch_status_t
 550 _notmuch_query_count_documents (notmuch_query_t *query,
 551                                 const char *type,
 552                                 unsigned *count_out);
 553 /* message-id.c */
 554
 555 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
 556  * comments, and the '<' and '>' delimiters.
 557  *
 558  * If not NULL, then *next will be made to point to the first character
 559  * not parsed, (possibly pointing to the final '\0' terminator.
 560  *
 561  * Returns a newly talloc'ed string belonging to 'ctx'.
 562  *
 563  * Returns NULL if there is any error parsing the message-id. */
 564 char *
 565 _notmuch_message_id_parse (void *ctx, const char *message_id, const char **next);
 566
 567 /* Parse a message-id, discarding leading and trailing whitespace, and
 568  * '<' and '>' delimiters.
 569  *
 570  * Apply a probably-stricter-than RFC definition of what is allowed in
 571  * a message-id. In particular, forbid whitespace.
 572  *
 573  * Returns a newly talloc'ed string belonging to 'ctx'.
 574  *
 575  * Returns NULL if there is any error parsing the message-id.
 576  */
 577
 578 char *
 579 _notmuch_message_id_parse_strict (void *ctx, const char *message_id);
 580
 581
 582 /* message.cc */
 583
 584 void
 585 _notmuch_message_add_reply (notmuch_message_t *message,
 586                             notmuch_message_t *reply);
 587
 588 void
 589 _notmuch_message_remove_unprefixed_terms (notmuch_message_t *message);
 590
 591 size_t _notmuch_message_get_thread_depth (notmuch_message_t *message);
 592
 593 void
 594 _notmuch_message_label_depths (notmuch_message_t *message,
 595                                size_t depth);
 596
 597 notmuch_message_list_t *
 598 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list);
 599
 600 /* sha1.c */
 601
 602 char *
 603 _notmuch_sha1_of_string (const char *str);
 604
 605 char *
 606 _notmuch_sha1_of_file (const char *filename);
 607
 608 /* string-list.c */
 609
 610 typedef struct _notmuch_string_node {
 611     char *string;
 612     struct _notmuch_string_node *next;
 613 } notmuch_string_node_t;
 614
 615 typedef struct _notmuch_string_list {
 616     int length;
 617     notmuch_string_node_t *head;
 618     notmuch_string_node_t **tail;
 619 } notmuch_string_list_t;
 620
 621 notmuch_string_list_t *
 622 _notmuch_string_list_create (const void *ctx);
 623
 624 /*
 625  * return the number of strings in 'list'
 626  */
 627 int
 628 _notmuch_string_list_length (notmuch_string_list_t *list);
 629
 630 /* Add 'string' to 'list'.
 631  *
 632  * The list will create its own talloced copy of 'string'.
 633  */
 634 void
 635 _notmuch_string_list_append (notmuch_string_list_t *list,
 636                              const char *string);
 637
 638 void
 639 _notmuch_string_list_sort (notmuch_string_list_t *list);
 640
 641 const notmuch_string_list_t *
 642 _notmuch_message_get_references (notmuch_message_t *message);
 643
 644 /* string-map.c */
 645 typedef struct _notmuch_string_map notmuch_string_map_t;
 646 typedef struct _notmuch_string_map_iterator notmuch_string_map_iterator_t;
 647 notmuch_string_map_t *
 648 _notmuch_string_map_create (const void *ctx);
 649
 650 void
 651 _notmuch_string_map_append (notmuch_string_map_t *map,
 652                             const char *key,
 653                             const char *value);
 654
 655 void
 656 _notmuch_string_map_set (notmuch_string_map_t *map,
 657                          const char *key,
 658                          const char *value);
 659
 660 const char *
 661 _notmuch_string_map_get (notmuch_string_map_t *map, const char *key);
 662
 663 notmuch_string_map_iterator_t *
 664 _notmuch_string_map_iterator_create (notmuch_string_map_t *map, const char *key,
 665                                      bool exact);
 666
 667 bool
 668 _notmuch_string_map_iterator_valid (notmuch_string_map_iterator_t *iter);
 669
 670 void
 671 _notmuch_string_map_iterator_move_to_next (notmuch_string_map_iterator_t *iter);
 672
 673 const char *
 674 _notmuch_string_map_iterator_key (notmuch_string_map_iterator_t *iterator);
 675
 676 const char *
 677 _notmuch_string_map_iterator_value (notmuch_string_map_iterator_t *iterator);
 678
 679 void
 680 _notmuch_string_map_iterator_destroy (notmuch_string_map_iterator_t *iterator);
 681
 682 /* Create an iterator for user headers. Destroy with
 683  * _notmuch_string_map_iterator_destroy. Actually in database.cc*/
 684 notmuch_string_map_iterator_t *
 685 _notmuch_database_user_headers (notmuch_database_t *notmuch);
 686
 687 /* tags.c */
 688
 689 notmuch_tags_t *
 690 _notmuch_tags_create (const void *ctx, notmuch_string_list_t *list);
 691
 692 /* filenames.c */
 693
 694 /* The notmuch_filenames_t iterates over a notmuch_string_list_t of
 695  * file names */
 696 notmuch_filenames_t *
 697 _notmuch_filenames_create (const void *ctx,
 698                            notmuch_string_list_t *list);
 699
 700 /* thread.cc */
 701
 702 notmuch_thread_t *
 703 _notmuch_thread_create (void *ctx,
 704                         notmuch_database_t *notmuch,
 705                         unsigned int seed_doc_id,
 706                         notmuch_doc_id_set_t *match_set,
 707                         notmuch_string_list_t *excluded_terms,
 708                         notmuch_exclude_t omit_exclude,
 709                         notmuch_sort_t sort);
 710
 711 /* indexopts.c */
 712
 713 struct _notmuch_indexopts;
 714
 715 #define CONFIG_HEADER_PREFIX "index.header."
 716
 717 #define EMPTY_STRING(s) ((s)[0] == '\0')
 718
 719 /* config.cc */
 720 notmuch_status_t
 721 _notmuch_config_load_from_database (notmuch_database_t *db);
 722
 723 notmuch_status_t
 724 _notmuch_config_load_from_file (notmuch_database_t *db, GKeyFile *file);
 725
 726 notmuch_status_t
 727 _notmuch_config_load_defaults (notmuch_database_t *db);
 728
 729 void
 730 _notmuch_config_cache (notmuch_database_t *db, notmuch_config_key_t key, const char *val);
 731
 732 /* open.cc */
 733 notmuch_status_t
 734 _notmuch_choose_xapian_path (void *ctx, const char *database_path, const char **xapian_path,
 735                              char **message);
 736
 737 NOTMUCH_END_DECLS
 738
 739 #ifdef __cplusplus
 740 /* Implicit typecast from 'void *' to 'T *' is okay in C, but not in
 741  * C++. In talloc_steal, an explicit cast is provided for type safety
 742  * in some GCC versions. Otherwise, a cast is required. Provide a
 743  * template function for this to maintain type safety, and redefine
 744  * talloc_steal to use it.
 745  */
 746 #if ! (__GNUC__ >= 3)
 747 template <class T> T *
 748 _notmuch_talloc_steal (const void *new_ctx, const T *ptr)
 749 {
 750     return static_cast<T *> (talloc_steal (new_ctx, ptr));
 751 }
 752 #undef talloc_steal
 753 #define talloc_steal _notmuch_talloc_steal
 754 #endif
 755
 756 #if __cplusplus >= 201703L || __cppcheck__
 757 #define NODISCARD [[nodiscard]]
 758 #else
 759 #define NODISCARD /**/
 760 #endif
 761 #endif
 762
 763 #endif