2010-08-25 20:40:07 +02:00
|
|
|
/*
|
2011-05-17 22:24:29 +02:00
|
|
|
** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
2010-08-25 20:40:07 +02:00
|
|
|
**
|
|
|
|
** This program is free software; you can redistribute it and/or modify
|
|
|
|
** it under the terms of the GNU General Public License as published by
|
|
|
|
** the Free Software Foundation; either version 3 of the License, or
|
|
|
|
** (at your option) any later version.
|
|
|
|
**
|
|
|
|
** This program is distributed in the hope that it will be useful,
|
|
|
|
** but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
** GNU General Public License for more details.
|
|
|
|
**
|
|
|
|
** You should have received a copy of the GNU General Public License
|
|
|
|
** along with this program; if not, write to the Free Software Foundation,
|
|
|
|
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
**
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __MU_MSG_ITER_H__
|
|
|
|
#define __MU_MSG_ITER_H__
|
|
|
|
|
2010-11-30 07:32:59 +01:00
|
|
|
#include <glib.h>
|
|
|
|
#include <mu-msg.h>
|
2010-08-25 20:40:07 +02:00
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
2011-05-01 14:00:28 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* MuMsgIter is a structure to iterate over the results of a
|
|
|
|
* query. You can iterate only in one-direction, and you can do it
|
|
|
|
* only once.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2010-08-25 20:40:07 +02:00
|
|
|
struct _MuMsgIter;
|
|
|
|
typedef struct _MuMsgIter MuMsgIter;
|
|
|
|
|
2011-05-18 22:51:52 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* create a new MuMsgIter -- basically, an iterator over the search
|
|
|
|
* results
|
|
|
|
*
|
|
|
|
* @param enq a Xapian::Enquire* cast to XapianEnquire* (because this
|
|
|
|
* is C, not C++),providing access to search results
|
|
|
|
* @param batchsize how many results to retrieve at once
|
2011-06-19 20:04:40 +02:00
|
|
|
* @param threads whether to calculate threads
|
2011-05-18 22:51:52 +02:00
|
|
|
*
|
|
|
|
* @return a new MuMsgIter, or NULL in case of error
|
|
|
|
*/
|
|
|
|
MuMsgIter *mu_msg_iter_new (XapianEnquire *enq,
|
2011-06-19 20:04:40 +02:00
|
|
|
size_t batchsize, gboolean threads) G_GNUC_WARN_UNUSED_RESULT;
|
2011-05-18 22:51:52 +02:00
|
|
|
|
2010-08-25 20:40:07 +02:00
|
|
|
/**
|
2010-11-25 20:49:25 +01:00
|
|
|
* get the next message (which you got from
|
2010-08-25 20:40:07 +02:00
|
|
|
* e.g. mu_query_run)
|
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
*
|
|
|
|
* @return TRUE if it succeeded, FALSE otherwise (e.g., because there
|
|
|
|
* are no more messages in the query result)
|
|
|
|
*/
|
|
|
|
gboolean mu_msg_iter_next (MuMsgIter *iter);
|
|
|
|
|
|
|
|
|
2011-06-02 17:13:17 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* reset the iterator to the beginning
|
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
*
|
|
|
|
* @return TRUE if it succeeded, FALSE otherwise
|
|
|
|
*/
|
|
|
|
gboolean mu_msg_iter_reset (MuMsgIter *iter);
|
|
|
|
|
2010-08-25 20:40:07 +02:00
|
|
|
/**
|
2010-09-08 23:09:00 +02:00
|
|
|
* does this iterator point past the end of the list?
|
2010-08-25 20:40:07 +02:00
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
*
|
2010-09-08 23:09:00 +02:00
|
|
|
* @return TRUE if the iter points past end of the list, FALSE
|
|
|
|
* otherwise
|
2010-08-25 20:40:07 +02:00
|
|
|
*/
|
2010-09-08 23:09:00 +02:00
|
|
|
gboolean mu_msg_iter_is_done (MuMsgIter *iter);
|
2010-08-25 20:40:07 +02:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* destroy the sequence of messages; ie. /all/ of them
|
|
|
|
*
|
|
|
|
* @param msg a valid MuMsgIter message or NULL
|
|
|
|
*/
|
|
|
|
void mu_msg_iter_destroy (MuMsgIter *iter);
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
2011-05-18 23:26:14 +02:00
|
|
|
* get the corresponding MuMsg for this iter; this instance is owned
|
|
|
|
* by MuMsgIter, and becomes invalid after either mu_msg_iter_destroy
|
|
|
|
* or mu_msg_iter_next. _do not_ unref it.
|
2010-08-25 20:40:07 +02:00
|
|
|
*
|
2010-11-25 20:49:25 +01:00
|
|
|
* @param iter a valid MuMsgIter instance
|
|
|
|
* @param err which receives error info or NULL. err is only filled
|
|
|
|
* when the function returns NULL
|
2010-08-25 20:40:07 +02:00
|
|
|
*
|
2011-05-18 23:26:14 +02:00
|
|
|
* @return a MuMsg instance, or NULL in case of error
|
2010-08-25 20:40:07 +02:00
|
|
|
*/
|
2010-11-30 07:32:59 +01:00
|
|
|
MuMsg* mu_msg_iter_get_msg (MuMsgIter *iter, GError **err)
|
2011-05-18 23:26:14 +02:00
|
|
|
G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
|
2011-03-21 00:55:11 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
2010-08-25 20:40:07 +02:00
|
|
|
/**
|
|
|
|
* get the document id for the current message
|
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
*
|
2010-12-18 09:44:27 +01:00
|
|
|
* @return the docid or (unsigned int)-1 in case of error
|
2010-08-25 20:40:07 +02:00
|
|
|
*/
|
|
|
|
unsigned int mu_msg_iter_get_docid (MuMsgIter *iter);
|
|
|
|
|
|
|
|
|
2011-06-19 20:04:40 +02:00
|
|
|
/**
|
|
|
|
* calculate the message threads
|
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
*
|
|
|
|
* @return TRUE if it worked, FALSE otherwsie.
|
|
|
|
*/
|
|
|
|
gboolean mu_msg_iter_calculate_threads (MuMsgIter *iter);
|
|
|
|
|
2011-06-18 17:47:46 +02:00
|
|
|
|
2011-06-23 23:21:54 +02:00
|
|
|
enum _MuMsgIterThreadProp {
|
|
|
|
MU_MSG_ITER_THREAD_PROP_ROOT = 1 << 0,
|
|
|
|
MU_MSG_ITER_THREAD_PROP_FIRST_CHILD = 1 << 1,
|
|
|
|
MU_MSG_ITER_THREAD_PROP_EMPTY_PARENT = 1 << 2,
|
|
|
|
MU_MSG_ITER_THREAD_PROP_DUP = 1 << 3
|
|
|
|
};
|
|
|
|
typedef guint8 MuMsgIterThreadProp;
|
|
|
|
|
|
|
|
struct _MuMsgIterThreadInfo {
|
|
|
|
gchar *threadpath;
|
|
|
|
MuMsgIterThreadProp prop;
|
|
|
|
};
|
|
|
|
typedef struct _MuMsgIterThreadInfo MuMsgIterThreadInfo;
|
|
|
|
|
2011-06-19 20:04:40 +02:00
|
|
|
/**
|
2011-06-23 23:21:54 +02:00
|
|
|
* get a the MuMsgThreaderInfo struct for this message
|
2011-06-19 20:04:40 +02:00
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
*
|
2011-06-23 23:21:54 +02:00
|
|
|
* @return an info struct
|
2011-06-19 20:04:40 +02:00
|
|
|
*/
|
2011-06-23 23:21:54 +02:00
|
|
|
const MuMsgIterThreadInfo* mu_msg_iter_get_thread_info (MuMsgIter *iter);
|
2011-06-18 17:47:46 +02:00
|
|
|
|
2010-08-25 20:40:07 +02:00
|
|
|
/**
|
|
|
|
* get some message field
|
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
* @param field the string field to retrieve
|
|
|
|
*
|
|
|
|
* @return the field value, or NULL
|
|
|
|
*/
|
|
|
|
const gchar* mu_msg_iter_get_field (MuMsgIter *iter,
|
2010-11-20 13:43:04 +01:00
|
|
|
MuMsgFieldId mfid);
|
2010-08-25 20:40:07 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* get some numeric message field
|
|
|
|
*
|
|
|
|
* @param iter a valid MuMsgIter iterator
|
|
|
|
* @param field the numeric field to retrieve
|
|
|
|
*
|
|
|
|
* @return the field value, or -1 in case of error
|
|
|
|
*/
|
|
|
|
gint64 mu_msg_iter_get_field_numeric (MuMsgIter *iter,
|
2010-11-20 13:43:04 +01:00
|
|
|
MuMsgFieldId mfid);
|
2010-08-25 20:40:07 +02:00
|
|
|
G_END_DECLS
|
|
|
|
|
|
|
|
#endif /*__MU_MSG_ITER_H__*/
|