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 #ifndef _GNU_SOURCE
  27 #define _GNU_SOURCE /* For getline */
  28 #endif
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <stdarg.h>
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <sys/mman.h>
  36 #include <string.h>
  37 #include <errno.h>
  38 #include <fcntl.h>
  39 #include <unistd.h>
  40 #include <ctype.h>
  41
  42 NOTMUCH_BEGIN_DECLS
  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 complains if we provide a term longer than this. */
  80 #define NOTMUCH_MAX_TERM 245
  81
  82 /* message.cc */
  83
  84 notmuch_message_t *
  85 _notmuch_message_create (notmuch_results_t *owner,
  86                          notmuch_database_t *notmuch,
  87                          unsigned int doc_id);
  88
  89 /* Lookup a prefix value by name. */
  90 const char *
  91 _find_prefix (const char *name);
  92
  93 /* message-file.c */
  94
  95 /* XXX: I haven't decided yet whether these will actually get exported
  96  * into the public interface in notmuch.h
  97  */
  98
  99 typedef struct _notmuch_message_file notmuch_message_file_t;
 100
 101 /* Open a file containing a single email message.
 102  *
 103  * The caller should call notmuch_message_close when done with this.
 104  *
 105  * Returns NULL if any error occurs.
 106  */
 107 notmuch_message_file_t *
 108 notmuch_message_file_open (const char *filename);
 109
 110 /* Close a notmuch message preivously opened with notmuch_message_open. */
 111 void
 112 notmuch_message_file_close (notmuch_message_file_t *message);
 113
 114 /* Restrict 'message' to only save the named headers.
 115  *
 116  * When the caller is only interested in a short list of headers,
 117  * known in advance, calling this function can avoid wasted time and
 118  * memory parsing/saving header values that will never be needed.
 119  *
 120  * The variable arguments should be a list of const char * with a
 121  * final '(const char *) NULL' to terminate the list.
 122  *
 123  * If this function is called, it must be called before any calls to
 124  * notmuch_message_get_header for this message.
 125  *
 126  * After calling this function, if notmuch_message_get_header is
 127  * called with a header name not in this list, then NULL will be
 128  * returned even if that header exists in the actual message.
 129  */
 130 void
 131 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
 132
 133 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
 134 void
 135 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
 136                                         va_list va_headers);
 137
 138 /* Get the value of the specified header from the message.
 139  *
 140  * The header name is case insensitive.
 141  *
 142  * The returned value is owned by the notmuch message and is valid
 143  * only until the message is closed. The caller should copy it if
 144  * needing to modify the value or to hold onto it for longer.
 145  *
 146  * Returns NULL if the message does not contain a header line matching
 147  * 'header'.
 148  */
 149 const char *
 150 notmuch_message_file_get_header (notmuch_message_file_t *message,
 151                                  const char *header);
 152
 153 /* date.c */
 154
 155 /* Parse an RFC 8222 date string to a time_t value.
 156  *
 157  * The tz_offset argument can be used to also obtain the time-zone
 158  * offset, (but can be NULL if the call is not interested in that).
 159  *
 160  * Returns 0 on error.
 161  */
 162 time_t
 163 notmuch_parse_date (const char *str, int *tz_offset);
 164
 165 NOTMUCH_END_DECLS
 166
 167 #endif