git.notmuchmail.org Git - notmuch/blob - 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 http://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 #include "notmuch.h"
  25
  26 NOTMUCH_BEGIN_DECLS
  27
  28 #ifndef _GNU_SOURCE
  29 #define _GNU_SOURCE /* For getline */
  30 #endif
  31
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <stdarg.h>
  35 #include <sys/types.h>
  36 #include <sys/stat.h>
  37 #include <sys/mman.h>
  38 #include <string.h>
  39 #include <errno.h>
  40 #include <fcntl.h>
  41 #include <unistd.h>
  42 #include <ctype.h>
  43
  44 #include <talloc.h>
  45
  46 #include "xutil.h"
  47
  48 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
  49  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
  50  */
  51 /* these macros gain us a few percent of speed on gcc */
  52 #if (__GNUC__ >= 3)
  53 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
  54    as its first argument */
  55 #ifndef likely
  56 #define likely(x)   __builtin_expect(!!(x), 1)
  57 #endif
  58 #ifndef unlikely
  59 #define unlikely(x) __builtin_expect(!!(x), 0)
  60 #endif
  61 #else
  62 #ifndef likely
  63 #define likely(x) (x)
  64 #endif
  65 #ifndef unlikely
  66 #define unlikely(x) (x)
  67 #endif
  68 #endif
  69
  70 /* These value numbers are chosen to be sup compatible (for now at
  71  * least). */
  72
  73 typedef enum {
  74     NOTMUCH_VALUE_MESSAGE_ID = 0,
  75     NOTMUCH_VALUE_THREAD = 1,
  76     NOTMUCH_VALUE_DATE = 2
  77 } notmuch_value_t;
  78
  79 /* Xapian (with flint backend) complains if we provide a term longer
  80  * than this, but I haven't yet found a way to query the limit
  81  * programmatically. */
  82 #define NOTMUCH_TERM_MAX 245
  83
  84 /* message.cc */
  85
  86 notmuch_message_t *
  87 _notmuch_message_create (const void *talloc_owner,
  88                          notmuch_database_t *notmuch,
  89                          unsigned int doc_id);
  90
  91 /* Lookup a prefix value by name. */
  92 const char *
  93 _find_prefix (const char *name);
  94
  95 /* message-file.c */
  96
  97 /* XXX: I haven't decided yet whether these will actually get exported
  98  * into the public interface in notmuch.h
  99  */
 100
 101 typedef struct _notmuch_message_file notmuch_message_file_t;
 102
 103 /* Open a file containing a single email message.
 104  *
 105  * The caller should call notmuch_message_close when done with this.
 106  *
 107  * Returns NULL if any error occurs.
 108  */
 109 notmuch_message_file_t *
 110 notmuch_message_file_open (const char *filename);
 111
 112 /* Close a notmuch message preivously opened with notmuch_message_open. */
 113 void
 114 notmuch_message_file_close (notmuch_message_file_t *message);
 115
 116 /* Restrict 'message' to only save the named headers.
 117  *
 118  * When the caller is only interested in a short list of headers,
 119  * known in advance, calling this function can avoid wasted time and
 120  * memory parsing/saving header values that will never be needed.
 121  *
 122  * The variable arguments should be a list of const char * with a
 123  * final '(const char *) NULL' to terminate the list.
 124  *
 125  * If this function is called, it must be called before any calls to
 126  * notmuch_message_get_header for this message.
 127  *
 128  * After calling this function, if notmuch_message_get_header is
 129  * called with a header name not in this list, then NULL will be
 130  * returned even if that header exists in the actual message.
 131  */
 132 void
 133 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
 134
 135 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
 136 void
 137 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
 138                                         va_list va_headers);
 139
 140 /* Get the value of the specified header from the message.
 141  *
 142  * The header name is case insensitive.
 143  *
 144  * The returned value is owned by the notmuch message and is valid
 145  * only until the message is closed. The caller should copy it if
 146  * needing to modify the value or to hold onto it for longer.
 147  *
 148  * Returns NULL if the message does not contain a header line matching
 149  * 'header'.
 150  */
 151 const char *
 152 notmuch_message_file_get_header (notmuch_message_file_t *message,
 153                                  const char *header);
 154
 155 /* date.c */
 156
 157 /* Parse an RFC 8222 date string to a time_t value.
 158  *
 159  * The tz_offset argument can be used to also obtain the time-zone
 160  * offset, (but can be NULL if the call is not interested in that).
 161  *
 162  * Returns 0 on error.
 163  */
 164 time_t
 165 notmuch_parse_date (const char *str, int *tz_offset);
 166
 167 NOTMUCH_END_DECLS
 168
 169 #endif