Changeset 1299

Timestamp:

12/06/06 18:06:03

Author:

pvanhoof

Message:

Added an API

Files:

• trunk/ChangeLog (modified) (1 diff)
• trunk/bindings/python/tinymail.override (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-folder.c (modified) (3 diffs)
• trunk/libtinymail-camel/tny-camel-folder.h (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-mime-part.c (modified) (3 diffs)
• trunk/libtinymail/tny-folder.c (modified) (2 diffs)
• trunk/libtinymail/tny-folder.h (modified) (1 diff)
• trunk/libtinymail/tny-shared.h (modified) (1 diff)
• trunk/libtinymailui-gtk/tny-gtk-msg-view.c (modified) (2 diffs)

trunk/ChangeLog

@@ +1 @@
+2006-12-06  Philip Van Hoof <pvanhoof@gnome.org>
+
+        * Added the tny_folder_get_msg_async API
+
+        * This was a major API change in libtinymail
+
-2006-12-01  Philip Van Hoof <pvanhoof@gnome.org>
-

trunk/bindings/python/tinymail.override

@@ -93 +93 @@
-}
-%%
+override tny_folder_get_msg_async kwargs
+
+static void
+tny_get_msg_cb (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data)
+{
+    PyObject *callback, *args, *ret;
+    PyGILState_STATE state;
+
+    state = pyg_gil_state_ensure();
+    callback = PyTuple_GetItem((PyObject *)user_data, 1);
+    args = Py_BuildValue("(NO)",
+                         pygobject_new((GObject *)self),
+                         PyTuple_GetItem((PyObject *)user_data, 2));
+    ret = PyObject_CallObject(callback, args);
+    if (!ret)
+        PyErr_Print();
+
+    pyg_error_check(err);
+    Py_XDECREF(ret);
+    Py_DECREF(args);
+    Py_DECREF ((PyObject *)user_data);
+    pyg_gil_state_release(state);
+}
+
+static PyObject *
+_wrap_tny_folder_get_msg_async (PyGObject *self, PyObject *args, PyObject *kwargs)
+{
+    static char *kwlist[] = { "header", "get_msg_func", "user_data", NULL };
+    PyObject *get_msg_func, *user_data = Py_None;
+    TnyHeader *header;
+    PyObject *data;
+
+    if (!PyArg_ParseTupleAndKeywords(args, kwargs,
+                                     "OO|O:TnyFolder.get_msg_async",kwlist,
+                                     &header, &get_msg_func, &user_data))
+        return NULL;
+    if (!PyCallable_Check(get_msg_func)) {
+        PyErr_SetString(PyExc_TypeError, "get_msg_func must be callable");
+        return NULL;
+    }
+
+    data = Py_BuildValue("(OOO)", header, get_msg_func, user_data);
+
+    tny_folder_get_msg_async (TNY_FOLDER (self->obj), header,
+                                      tny_get_msg_cb, data);
+    return Py_None;
+}
+
+%%
-override tny_folder_refresh_async kwargs
-

trunk/libtinymail-camel/tny-camel-folder.c

@@ -911 +911 @@
-}
-
+
+static void
+tny_camel_folder_get_msg_async (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data)
+{
+        return TNY_CAMEL_FOLDER_GET_CLASS (self)->get_msg_async_func (self, header, callback, user_data);
+}
+
+static void
+tny_camel_folder_get_msg_async_default (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data)
+{
+        g_critical ("Not implemented!");
+}
-
-static TnyMsg*
@@ -1755 +1767 @@
-        klass->get_headers_func = tny_camel_folder_get_headers;
-        klass->get_msg_func = tny_camel_folder_get_msg;
+        klass->get_msg_async_func = tny_camel_folder_get_msg_async;
-        klass->get_id_func = tny_camel_folder_get_id;
-        klass->set_name_func = tny_camel_folder_set_name;
@@ -1799 +1812 @@
-        class->get_headers_func = tny_camel_folder_get_headers_default;
-        class->get_msg_func = tny_camel_folder_get_msg_default;
+        class->get_msg_async_func = tny_camel_folder_get_msg_async_default;
-        class->get_id_func = tny_camel_folder_get_id_default;
-        class->set_name_func = tny_camel_folder_set_name_default;

trunk/libtinymail-camel/tny-camel-folder.h

@@ -57 +57 @@
-        void (*set_msg_remove_strategy_func) (TnyFolder *self, TnyMsgRemoveStrategy *st);
-        TnyMsg* (*get_msg_func) (TnyFolder *self, TnyHeader *header, GError **err);
+        void (*get_msg_async_func) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data);
-        void (*get_headers_func) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
-        const gchar* (*get_name_func) (TnyFolder *self);

trunk/libtinymail-camel/tny-camel-mime-part.c

@@ -64 +64 @@
-        int go = TRUE;
-
-
-
+/*     
+ */
-
-        containee = camel_medium_get_content_object (CAMEL_MEDIUM (part));
-
+
-        if (G_UNLIKELY (containee == NULL))
-                return go;
+
-
-        if (G_LIKELY (CAMEL_IS_MULTIPART (containee)))
@@ -77 +78 @@
-                for (i = 0; go && i < parts; i++) 
-                {
-
-
-
+t
+t
+t
-
-                        /* if (part)
@@ -88 +89 @@
-                
-        } else if (G_LIKELY (CAMEL_IS_MIME_MESSAGE (containee)))
-part
+(CamelMimePart*) containee
-
-        /* else if (G_LIKELY (CAMEL_IS_MIME_MESSAGE (containee)))

trunk/libtinymail/tny-folder.c

@@ -395 +395 @@
-/**
- * tny_folder_get_msg:
-
+#
- * @header: the header of the message to get
- * @err: a #GError object or NULL
@@ -426 +426 @@
-}
-
+
+
+
+/**
+ * tny_folder_get_msg_async:
+ * @self: a #TnyFolder object
+ * @header: a #TnyHeader object
+ * @callback: The callback handler
+ * @user_data: user data for the callback
+ *
+ * Get a message in @self identified by @header. You must unreference the
+ * return value after use.
+ *
+ * If you want to use this functionality, it's advised to let your application 
+ * use the #GMainLoop. All Gtk+ applications have this once gtk_main () is
+ * called.
+ * 
+ * When using a #GMainLoop this method will callback using g_idle_add_full.
+ * Without a #GMainLoop, which the libtinymail-camel implementation detects
+ * using (g_main_depth > 0), the callbacks will happen in a worker thread at an
+ * unknown moment in time (check your locking).
+ *
+ * When using Gtk+, the callback doesn't need the gdk_threads_enter and 
+ * gdk_threads_leave guards (because it happens in the #GMainLoop).
+ *
+ * Example:
+ * <informalexample><programlisting>
+ * static void
+ * folder_get_msg_cb (TnyFolder *folder, TnyMsg *msg, GError **err, gpointer user_data)
+ * {
+ *       TnyMsgView *message_view = user_data;
+ *       tny_msg_view_set_msg (message_view, message);
+ * }
+ * TnyMsgView *message_view = tny_platform_factory_new_msg_view (platfact);
+ * TnyFolder *folder = ...; TnyHeader *header = ...;
+ * tny_folder_get_msg_async (folder, header,
+ *          folder_get_msg_cb, message_view); 
+ * </programlisting></informalexample>
+ **/
+void
+tny_folder_get_msg_async (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data)
+{
+#ifdef DEBUG
+        if (!TNY_FOLDER_GET_IFACE (self)->get_msg_async_func)
+                g_critical ("You must implement tny_folder_get_msg_async\n");
+#endif
+
+        TNY_FOLDER_GET_IFACE (self)->get_msg_async_func (self, header, callback, user_data);
+        return;
+}
-
-/**

trunk/libtinymail/tny-folder.h

@@ -77 +77 @@
-        void (*set_msg_remove_strategy_func) (TnyFolder *self, TnyMsgRemoveStrategy *st);
-        TnyMsg* (*get_msg_func) (TnyFolder *self, TnyHeader *header, GError **err);
+        void (*get_msg_async_func) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data);
-        void (*get_headers_func) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
-        const gchar* (*get_name_func) (TnyFolder *self);

trunk/libtinymail/tny-shared.h

@@ -50 +50 @@
-typedef void (*TnyForgetPassFunc) (TnyAccount *self);
-typedef void (*TnyRefreshFolderCallback) (TnyFolder *self, gboolean cancelled, GError **err, gpointer user_data);
+typedef void (*TnyGetMsgCallback) (TnyFolder *folder, TnyMsg *msg, GError **err, gpointer user_data);
-typedef void (*TnyRefreshFolderStatusCallback) (TnyFolder *self, const gchar *what, gint status, gpointer user_data);
-typedef enum _TnyHeaderFlags TnyHeaderFlags;

trunk/libtinymailui-gtk/tny-gtk-msg-view.c

@@ -397 +397 @@
-tny_mime_part_view_proxy_func_set_part (TnyMimePartView *mpview, TnyMimePart *part)
-{
-rfc822
+*
-                {
-                        TnyMimePart *content_part = tny_mime_part_get_content_object (part);
@@ -511 +511 @@
-                }
-        } else if (!tny_mime_part_content_type_is (part, "multipart/*") &&
-rfc822
+*
-        {
-                g_warning (_("I don't have a mime part viewer for %s\n"),