Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-search.h
index 104c8ae..c35c364 100644 (file)
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 #ifndef MODEST_SEARCH_H
 #define MODEST_SEARCH_H
 
+#include <glib.h>
+#include <tny-folder.h>
+
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE
+#endif
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#ifdef MODEST_HAVE_OGS
+#include <libogs/ogs-text-searcher.h>
+#endif
+
+G_BEGIN_DECLS
+
 typedef enum {
-       MODEST_SEARCH_SUBJECT = 0<<1,
-       MODEST_SEARCH_SENDER = 0<<2,
-       MODEST_SEARCH_RECIPIENT = 0<<3,
-       MODEST_SEARCH_SIZE = 0<<4,
-       MODEST_SEARCH_BEFORE = 0<<5,
-       MODEST_SEARCH_AFTER = 0<<6,
-       MODEST_SEARCH_BODY = 0<<7
+       MODEST_SEARCH_SUBJECT   = (1 << 0),
+       MODEST_SEARCH_SENDER    = (1 << 1),
+       MODEST_SEARCH_RECIPIENT = (1 << 2),
+       MODEST_SEARCH_SIZE      = (1 << 3),
+       MODEST_SEARCH_BEFORE    = (1 << 4),
+       MODEST_SEARCH_AFTER     = (1 << 5),
+       MODEST_SEARCH_BODY      = (1 << 6),
+       MODEST_SEARCH_USE_OGS   = (1 << 7),
 } ModestSearchFlags;
 
 typedef struct {
-       gchar *subject, *from, *recipient, *body;
-       time_t before, after;
-       guint minsize;
+       gchar     *msgid; /* E.g. the URI of the message. */
+       gchar     *subject;
+       gchar     *folder; /* The name, not the URI. */
+       gchar     *sender;
+       guint64    msize;
+       gboolean   has_attachment;
+       gboolean   is_unread;
+       gint64     timestamp;            
+} ModestSearchResultHit;
+
+typedef struct {
+       gchar *folder; /* The folder to search in */
+       
+       /* Text to search for in various parts: */
+       gchar *subject;
+       gchar *from;
+       gchar *recipient;
+       gchar *body;
+       
+       /* Other criteria: */
+       time_t start_date, end_date;
+       guint32 minsize;
        ModestSearchFlags flags;
+#ifdef MODEST_HAVE_OGS
+       gchar     *query; /* The text to search for. */
+       OgsTextSearcher *text_searcher; 
+#endif
 } ModestSearch;
 
-GList * modest_search (TnyFolder *folder, ModestSearch *search);
+typedef void (*ModestSearchCallback) (GList *hits, gpointer user_data);
+
+void modest_search_folder (TnyFolder *folder, ModestSearch *search, ModestSearchCallback callback, gpointer user_data);
+void modest_search_all_accounts (ModestSearch *search, ModestSearchCallback callback, gpointer user_data);
+void modest_search_account (TnyAccount *account, ModestSearch *search, ModestSearchCallback callback, gpointer user_data);
+void modest_search_free (ModestSearch *search);
+
+G_END_DECLS
 
 #endif