git.notmuchmail.org Git - notmuch/blob - lib/database-private.h

   1 /* database-private.h - For peeking into the internals of notmuch_database_t
   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_DATABASE_PRIVATE_H
  22 #define NOTMUCH_DATABASE_PRIVATE_H
  23
  24 /* According to WG14/N1124, a C++ implementation won't provide us a
  25  * macro like PRIx64 (which gives a printf format string for
  26  * formatting a uint64_t as hexadecimal) unless we define
  27  * __STDC_FORMAT_MACROS before including inttypes.h. That's annoying,
  28  * but there it is.
  29  */
  30 #define __STDC_FORMAT_MACROS
  31 #include <inttypes.h>
  32
  33 #include "notmuch-private.h"
  34
  35 #include <xapian.h>
  36
  37 struct _notmuch_database {
  38     notmuch_bool_t exception_reported;
  39
  40     char *path;
  41
  42     notmuch_bool_t needs_upgrade;
  43     notmuch_database_mode_t mode;
  44     Xapian::Database *xapian_db;
  45
  46     unsigned int last_doc_id;
  47     uint64_t last_thread_id;
  48
  49     Xapian::QueryParser *query_parser;
  50     Xapian::TermGenerator *term_gen;
  51     Xapian::ValueRangeProcessor *value_range_processor;
  52
  53 };
  54
  55 /* Convert tags from Xapian internal format to notmuch format.
  56  *
  57  * The function gets a TermIterator as argument and uses that iterator to find
  58  * all tag terms in the object. The tags are then converted to a
  59  * notmuch_tags_t list and returned. The function needs to allocate memory for
  60  * the resulting list and it uses the argument ctx as talloc context.
  61  *
  62  * The function returns NULL on failure.
  63  */
  64 notmuch_tags_t *
  65 _notmuch_convert_tags (void *ctx, Xapian::TermIterator &i,
  66                        Xapian::TermIterator &end);
  67
  68 #endif