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 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 #ifndef _GNU_SOURCE
  25 #define _GNU_SOURCE /* For getline and asprintf */
  26 #endif
  27 #include <stdio.h>
  28
  29 #include "notmuch.h"
  30
  31 NOTMUCH_BEGIN_DECLS
  32
  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 #include <assert.h>
  44
  45 #include <talloc.h>
  46
  47 #include "xutil.h"
  48
  49 #ifdef DEBUG
  50 # define DEBUG_DATABASE_SANITY 1
  51 # define DEBUG_QUERY 1
  52 #endif
  53
  54 #define COMPILE_TIME_ASSERT(pred) ((void)sizeof(char[1 - 2*!(pred)]))
  55
  56 /* There's no point in continuing when we've detected that we've done
  57  * something wrong internally (as opposed to the user passing in a
  58  * bogus value).
  59  *
  60  * Note that PRINTF_ATTRIBUTE comes from talloc.h
  61  */
  62 int
  63 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2);
  64
  65 /* There's no point in continuing when we've detected that we've done
  66  * something wrong internally (as opposed to the user passing in a
  67  * bogus value).
  68  *
  69  * Note that __location__ comes from talloc.h.
  70  */
  71 #define INTERNAL_ERROR(format, ...)                     \
  72     _internal_error (format " (%s).\n",                 \
  73                      ##__VA_ARGS__, __location__)
  74
  75 #define unused(x) x __attribute__ ((unused))
  76
  77 /* Thanks to Andrew Tridgell's (SAMBA's) talloc for this definition of
  78  * unlikely. The talloc source code comes to us via the GNU LGPL v. 3.
  79  */
  80 /* these macros gain us a few percent of speed on gcc */
  81 #if (__GNUC__ >= 3)
  82 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
  83    as its first argument */
  84 #ifndef likely
  85 #define likely(x)   __builtin_expect(!!(x), 1)
  86 #endif
  87 #ifndef unlikely
  88 #define unlikely(x) __builtin_expect(!!(x), 0)
  89 #endif
  90 #else
  91 #ifndef likely
  92 #define likely(x) (x)
  93 #endif
  94 #ifndef unlikely
  95 #define unlikely(x) (x)
  96 #endif
  97 #endif
  98
  99 typedef enum {
 100     NOTMUCH_VALUE_TIMESTAMP = 0,
 101     NOTMUCH_VALUE_MESSAGE_ID
 102 } notmuch_value_t;
 103
 104 /* Xapian (with flint backend) complains if we provide a term longer
 105  * than this, but I haven't yet found a way to query the limit
 106  * programmatically. */
 107 #define NOTMUCH_TERM_MAX 245
 108
 109 typedef enum _notmuch_private_status {
 110     /* First, copy all the public status values. */
 111     NOTMUCH_PRIVATE_STATUS_SUCCESS = NOTMUCH_STATUS_SUCCESS,
 112     NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY = NOTMUCH_STATUS_OUT_OF_MEMORY,
 113     NOTMUCH_PRIVATE_STATUS_READONLY_DATABASE = NOTMUCH_STATUS_READONLY_DATABASE,
 114     NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION = NOTMUCH_STATUS_XAPIAN_EXCEPTION,
 115     NOTMUCH_PRIVATE_STATUS_FILE_NOT_EMAIL = NOTMUCH_STATUS_FILE_NOT_EMAIL,
 116     NOTMUCH_PRIVATE_STATUS_NULL_POINTER = NOTMUCH_STATUS_NULL_POINTER,
 117     NOTMUCH_PRIVATE_STATUS_TAG_TOO_LONG = NOTMUCH_STATUS_TAG_TOO_LONG,
 118
 119     /* Then add our own private values. */
 120     NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG,
 121     NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND,
 122
 123     NOTMUCH_PRIVATE_STATUS_LAST_STATUS
 124 } notmuch_private_status_t;
 125
 126 /* Coerce a notmuch_private_status_t value to a notmuch_status_t
 127  * value, generating an internal error if the private value is equal
 128  * to or greater than NOTMUCH_STATUS_LAST_STATUS. (The idea here is
 129  * that the caller has previously handled any expected
 130  * notmuch_private_status_t values.)
 131  */
 132 #define COERCE_STATUS(private_status, format, ...)                      \
 133     ((private_status >= (notmuch_private_status_t) NOTMUCH_STATUS_LAST_STATUS)\
 134      ?                                                                  \
 135      (notmuch_status_t) _internal_error (format " (%s).\n",             \
 136                                          ##__VA_ARGS__,                 \
 137                                          __location__)                  \
 138      :                                                                  \
 139      (notmuch_status_t) private_status)
 140
 141 /* database.cc */
 142
 143 /* Lookup a prefix value by name.
 144  *
 145  * XXX: This should really be static inside of message.cc, and we can
 146  * do that once we convert database.cc to use the
 147  * _notmuch_message_add/remove_term functions. */
 148 const char *
 149 _find_prefix (const char *name);
 150
 151 /* thread.cc */
 152
 153 notmuch_thread_t *
 154 _notmuch_thread_create (void *ctx,
 155                         notmuch_database_t *notmuch,
 156                         const char *thread_id,
 157                         const char *query_string);
 158
 159 /* message.cc */
 160
 161 notmuch_message_t *
 162 _notmuch_message_create (const void *talloc_owner,
 163                          notmuch_database_t *notmuch,
 164                          unsigned int doc_id,
 165                          notmuch_private_status_t *status);
 166
 167 notmuch_message_t *
 168 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 169                                         const char *message_id,
 170                                         notmuch_private_status_t *status);
 171
 172 const char *
 173 _notmuch_message_get_in_reply_to (notmuch_message_t *message);
 174
 175 notmuch_private_status_t
 176 _notmuch_message_add_term (notmuch_message_t *message,
 177                            const char *prefix_name,
 178                            const char *value);
 179
 180 notmuch_private_status_t
 181 _notmuch_message_remove_term (notmuch_message_t *message,
 182                               const char *prefix_name,
 183                               const char *value);
 184
 185 notmuch_private_status_t
 186 _notmuch_message_gen_terms (notmuch_message_t *message,
 187                             const char *prefix_name,
 188                             const char *text);
 189
 190 void
 191 _notmuch_message_set_filename (notmuch_message_t *message,
 192                                const char *filename);
 193
 194 void
 195 _notmuch_message_add_thread_id (notmuch_message_t *message,
 196                                 const char *thread_id);
 197
 198 void
 199 _notmuch_message_ensure_thread_id (notmuch_message_t *message);
 200
 201 void
 202 _notmuch_message_set_date (notmuch_message_t *message,
 203                            const char *date);
 204
 205 void
 206 _notmuch_message_sync (notmuch_message_t *message);
 207
 208 void
 209 _notmuch_message_close (notmuch_message_t *message);
 210
 211 /* index.cc */
 212
 213 notmuch_status_t
 214 _notmuch_message_index_file (notmuch_message_t *message,
 215                              const char *filename);
 216
 217 /* message-file.c */
 218
 219 /* XXX: I haven't decided yet whether these will actually get exported
 220  * into the public interface in notmuch.h
 221  */
 222
 223 typedef struct _notmuch_message_file notmuch_message_file_t;
 224
 225 /* Open a file containing a single email message.
 226  *
 227  * The caller should call notmuch_message_close when done with this.
 228  *
 229  * Returns NULL if any error occurs.
 230  */
 231 notmuch_message_file_t *
 232 notmuch_message_file_open (const char *filename);
 233
 234 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 235 notmuch_message_file_t *
 236 _notmuch_message_file_open_ctx (void *ctx, const char *filename);
 237
 238 /* Close a notmuch message previously opened with notmuch_message_open. */
 239 void
 240 notmuch_message_file_close (notmuch_message_file_t *message);
 241
 242 /* Restrict 'message' to only save the named headers.
 243  *
 244  * When the caller is only interested in a short list of headers,
 245  * known in advance, calling this function can avoid wasted time and
 246  * memory parsing/saving header values that will never be needed.
 247  *
 248  * The variable arguments should be a list of const char * with a
 249  * final '(const char *) NULL' to terminate the list.
 250  *
 251  * If this function is called, it must be called before any calls to
 252  * notmuch_message_get_header for this message.
 253  *
 254  * After calling this function, if notmuch_message_get_header is
 255  * called with a header name not in this list, then NULL will be
 256  * returned even if that header exists in the actual message.
 257  */
 258 void
 259 notmuch_message_file_restrict_headers (notmuch_message_file_t *message, ...);
 260
 261 /* Identical to notmuch_message_restrict_headers but accepting a va_list. */
 262 void
 263 notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
 264                                         va_list va_headers);
 265
 266 /* Get the value of the specified header from the message.
 267  *
 268  * The header name is case insensitive.
 269  *
 270  * The returned value is owned by the notmuch message and is valid
 271  * only until the message is closed. The caller should copy it if
 272  * needing to modify the value or to hold onto it for longer.
 273  *
 274  * Returns NULL if the message does not contain a header line matching
 275  * 'header'.
 276  */
 277 const char *
 278 notmuch_message_file_get_header (notmuch_message_file_t *message,
 279                                  const char *header);
 280
 281 /* messages.c */
 282
 283 typedef struct _notmuch_message_node {
 284     notmuch_message_t *message;
 285     struct _notmuch_message_node *next;
 286 } notmuch_message_node_t;
 287
 288 typedef struct _notmuch_message_list {
 289     notmuch_message_node_t *head;
 290     notmuch_message_node_t **tail;
 291 } notmuch_message_list_t;
 292
 293 /* There's a rumor that there's an alternate struct _notmuch_messages
 294  * somewhere with some nasty C++ objects in it. We'll try to maintain
 295  * ignorance of that here. (See notmuch_mset_messages_t in query.cc)
 296  */
 297 struct _notmuch_messages {
 298     notmuch_bool_t is_of_list_type;
 299     notmuch_message_node_t *iterator;
 300 };
 301
 302 notmuch_message_list_t *
 303 _notmuch_message_list_create (const void *ctx);
 304
 305 void
 306 _notmuch_message_list_append (notmuch_message_list_t *list,
 307                               notmuch_message_node_t *node);
 308
 309 void
 310 _notmuch_message_list_add_message (notmuch_message_list_t *list,
 311                                    notmuch_message_t *message);
 312
 313 notmuch_messages_t *
 314 _notmuch_messages_create (notmuch_message_list_t *list);
 315
 316 /* query.cc */
 317
 318 notmuch_bool_t
 319 _notmuch_mset_messages_has_more (notmuch_messages_t *messages);
 320
 321 notmuch_message_t *
 322 _notmuch_mset_messages_get (notmuch_messages_t *messages);
 323
 324 void
 325 _notmuch_mset_messages_advance (notmuch_messages_t *messages);
 326
 327 /* message.cc */
 328
 329 void
 330 _notmuch_message_add_reply (notmuch_message_t *message,
 331                             notmuch_message_node_t *reply);
 332
 333 /* date.c */
 334
 335 /* Parse an RFC 8222 date string to a time_t value.
 336  *
 337  * The tz_offset argument can be used to also obtain the time-zone
 338  * offset, (but can be NULL if the call is not interested in that).
 339  *
 340  * Returns 0 on error.
 341  */
 342 time_t
 343 notmuch_parse_date (const char *str, int *tz_offset);
 344
 345 /* sha1.c */
 346
 347 char *
 348 notmuch_sha1_of_string (const char *str);
 349
 350 char *
 351 notmuch_sha1_of_file (const char *filename);
 352
 353 /* tags.c */
 354
 355 notmuch_tags_t *
 356 _notmuch_tags_create (void *ctx);
 357
 358 void
 359 _notmuch_tags_add_tag (notmuch_tags_t *tags, const char *tag);
 360
 361 void
 362 _notmuch_tags_prepare_iterator (notmuch_tags_t *tags);
 363
 364 NOTMUCH_END_DECLS
 365
 366 #endif