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 #include "notmuch-private.h"
  25
  26 #include <xapian.h>
  27
  28 struct _notmuch_database {
  29     notmuch_bool_t exception_reported;
  30     char *path;
  31     notmuch_database_mode_t mode;
  32     Xapian::Database *xapian_db;
  33     Xapian::QueryParser *query_parser;
  34     Xapian::TermGenerator *term_gen;
  35     Xapian::ValueRangeProcessor *value_range_processor;
  36 };
  37
  38 /* Convert tags from Xapian internal format to notmuch format.
  39  *
  40  * The function gets a TermIterator as argument and uses that iterator to find
  41  * all tag terms in the object. The tags are then converted to a
  42  * notmuch_tags_t list and returned. The function needs to allocate memory for
  43  * the resulting list and it uses the argument ctx as talloc context.
  44  *
  45  * The function returns NULL on failure.
  46  */
  47 notmuch_tags_t *
  48 _notmuch_convert_tags (void *ctx, Xapian::TermIterator &i,
  49                        Xapian::TermIterator &end);
  50
  51 #endif