From f02a04374107c4a532db836f2db6aa8d9fd52b8a Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Thu, 19 May 2011 00:26:14 +0300 Subject: [PATCH] * mu-msg-iter.{cc,h}: clear-up api, update callers --- src/mu-msg-iter.cc | 103 +---------------------- src/mu-msg-iter.h | 154 ++-------------------------------- src/mu-output.c | 110 +++++++++++++++--------- src/tests/test-mu-query.c | 5 +- toys/mug/mug-msg-list-view.c | 27 +++--- toys/mug2/mug-msg-list-view.c | 28 +++---- 6 files changed, 104 insertions(+), 323 deletions(-) diff --git a/src/mu-msg-iter.cc b/src/mu-msg-iter.cc index fd9e86ce..0d271de6 100644 --- a/src/mu-msg-iter.cc +++ b/src/mu-msg-iter.cc @@ -85,7 +85,7 @@ mu_msg_iter_get_msg (MuMsgIter *iter, GError **err) g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); g_return_val_if_fail (iter->_msg, NULL); - return mu_msg_ref (iter->_msg); + return iter->_msg; } @@ -241,104 +241,3 @@ mu_msg_iter_get_docid (MuMsgIter *iter) } -const char* -mu_msg_iter_get_path (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_PATH); -} - -const char* -mu_msg_iter_get_maildir (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_MAILDIR); -} - -const char* -mu_msg_iter_get_msgid (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_MSGID); -} - -const char* -mu_msg_iter_get_from (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_FROM); -} - -const char* -mu_msg_iter_get_to (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_TO); -} - - -const char* -mu_msg_iter_get_cc (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_CC); -} - -const char* -mu_msg_iter_get_bcc (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_BCC); -} - - -const char* -mu_msg_iter_get_refs (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_REFS); -} - -const char* -mu_msg_iter_get_subject (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), NULL); - return get_field (iter, MU_MSG_FIELD_ID_SUBJECT); -} - - -size_t -mu_msg_iter_get_size (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), 0); - return static_cast( - get_field_numeric (iter,MU_MSG_FIELD_ID_SIZE)); -} - - -time_t -mu_msg_iter_get_date (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), 0); - return static_cast( - get_field_numeric (iter,MU_MSG_FIELD_ID_DATE)); -} - -MuMsgFlags -mu_msg_iter_get_flags (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), MU_MSG_FLAG_NONE); - return static_cast(get_field_numeric - (iter, MU_MSG_FIELD_ID_FLAGS)); -} - -MuMsgPrio -mu_msg_iter_get_prio (MuMsgIter *iter) -{ - g_return_val_if_fail (!mu_msg_iter_is_done(iter), - MU_MSG_PRIO_NONE); - return static_cast(get_field_numeric - (iter, MU_MSG_FIELD_ID_PRIO)); -} - - diff --git a/src/mu-msg-iter.h b/src/mu-msg-iter.h index b2c479e0..5cc25485 100644 --- a/src/mu-msg-iter.h +++ b/src/mu-msg-iter.h @@ -82,21 +82,18 @@ void mu_msg_iter_destroy (MuMsgIter *iter); /** - * get the corresponding MuMsg for this iter; this requires the actual - * message file to be present at the expected place in the maildir in - * the file system. Note, it's faster to use the database fields (the - * various mu_msg_iter_get_... functions), so MuMsg should use only - * when information is needed that is not provided from the iter). + * 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. * * @param iter a valid MuMsgIter instance * @param err which receives error info or NULL. err is only filled * when the function returns NULL * - * @return a MuMsg instance, or NULL in case of error. Use - * mu_msg_unref when the instance is no longer needed + * @return a MuMsg instance, or NULL in case of error */ MuMsg* mu_msg_iter_get_msg (MuMsgIter *iter, GError **err) - G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; + G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; @@ -123,147 +120,6 @@ unsigned int mu_msg_iter_get_docid (MuMsgIter *iter); */ unsigned int mu_msg_iter_get_index (MuMsgIter *iter); - -/** - * get the full path of the message file - * - * @param iter a valid MuMsgIter iterator - * - * @return the path, or NULL in case of error - */ -const char* mu_msg_iter_get_path (MuMsgIter *iter); - - -/** - * get the maildir of the message - e.g., a message file - * /home/user/Maildir/foo/bar/cur/abc123 would have maildir - * "/foo/bar" - * - * @param iter a valid MuMsgIter iterator - * * @return the path, or NULL in case of error - */ -const char* mu_msg_iter_get_maildir (MuMsgIter *iter); - - - -/** - * get the msgid of the message - * - * @param iter a valid MuMsgIter iterator - * - * @return the msgid or NULL in case of error - */ -const char* mu_msg_iter_get_msgid (MuMsgIter *iter); - - - -/** - * get the size of the message in Kb - * - * @param iter a valid MuMsgIter iterator - * - * @return the size, or 0 in case of error - */ -size_t mu_msg_iter_get_size (MuMsgIter *iter); - -/** - * get the timestamp (ctime) of the message file - * - * @param iter a valid MuMsgIter iterator - * - * @return the size, or 0 in case of error - */ -time_t mu_msg_iter_get_timestamp (MuMsgIter *iter); - -/** - * get the sent time of the message - * - * @param iter a valid MuMsgIter iterator - * - * @return the time, or 0 in case of error - */ -time_t mu_msg_iter_get_date (MuMsgIter *iter); - -/** - * get the message sender(s) of the message - * - * @param iter a valid MuMsgIter iterator - * - * @return the time, or 0 in case of error - */ -const char* mu_msg_iter_get_from (MuMsgIter *iter); - -/** - * get the message recipient (To:) of the message - * - * @param iter a valid MuMsgIter iterator - * - * @return the To-recipient(s), or NULL in case of error - */ -const char* mu_msg_iter_get_to (MuMsgIter *iter); - - -/** - * get the 'carbon-copy' recipient(s) (Cc:) of the message - * - * @param iter a valid MuMsgIter iterator - * - * @return the Cc-recipient(s), or NULL in case of error - */ -const char* mu_msg_iter_get_cc (MuMsgIter *iter); - - -/** - * get the 'blind carbon-copy' message recipient(s) (Bcc:) of the - * message - * - * @param iter a valid MuMsgIter iterator - * - * @return the Bcc-recipient(s), or NULL in case of error - */ -const char* mu_msg_iter_get_bcc (MuMsgIter *iter); - -/** - * get the subject of the message - * - * @param iter a valid MuMsgIter iterator - * - * @return the subject, or NULL in case of error - */ -const char* mu_msg_iter_get_subject (MuMsgIter *iter); - -/** - * get the message flags - * - * @param iter a valid MuMsgIter iterator - * - * @return the message flags, or MU_MSG_FLAG_UNKNOWN - */ -MuMsgFlags mu_msg_iter_get_flags (MuMsgIter *iter); - - -/** - * get the message priority - * - * @param iter a valid MuMsgIter iterator - * - * @return the message priority, or MU_MSG_PRIO_NONE - */ -MuMsgPrio mu_msg_iter_get_prio (MuMsgIter *iter); - - - -/** - * get the references (References: and Reply-To:) as a comma-separated - * string, with the last one pointing at the parent - * - * @param iter a valid MuMsgIter iterator - * - * @return the message references, or NULL in case of error or if - * there is none - */ -const char* mu_msg_iter_get_refs (MuMsgIter *iter); - /** * get some message field * diff --git a/src/mu-output.c b/src/mu-output.c index a9a97a62..9e07b4af 100644 --- a/src/mu-output.c +++ b/src/mu-output.c @@ -108,10 +108,15 @@ mu_output_links (MuMsgIter *iter, const char* linksdir, for (myiter = iter, errseen = FALSE, mycount = 0; !mu_msg_iter_is_done (myiter); mu_msg_iter_next (myiter), ++mycount) { - + + MuMsg *msg; const char* path; - - path = mu_msg_iter_get_field (myiter, MU_MSG_FIELD_ID_PATH); + + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + if (!msg) + return FALSE; + + path = mu_msg_get_field_string (msg, MU_MSG_FIELD_ID_PATH); if (!path) return FALSE; @@ -134,30 +139,36 @@ static const gchar* display_field (MuMsgIter *iter, MuMsgFieldId mfid) { gint64 val; + MuMsg *msg; + + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + if (!msg) + return FALSE; + switch (mu_msg_field_type(mfid)) { case MU_MSG_FIELD_TYPE_STRING: { const gchar *str; - str = mu_msg_iter_get_field (iter, mfid); + str = mu_msg_get_field_string (msg, mfid); return str ? str : ""; } case MU_MSG_FIELD_TYPE_INT: if (mfid == MU_MSG_FIELD_ID_PRIO) { - val = mu_msg_iter_get_field_numeric (iter, mfid); + val = mu_msg_get_field_numeric (msg, mfid); return mu_msg_prio_name ((MuMsgPrio)val); } else if (mfid == MU_MSG_FIELD_ID_FLAGS) { - val = mu_msg_iter_get_field_numeric (iter, mfid); + val = mu_msg_get_field_numeric (msg, mfid); return mu_str_flags_s ((MuMsgFlags)val); } else /* as string */ - return mu_msg_iter_get_field (iter, mfid); + return mu_msg_get_field_string (msg, mfid); case MU_MSG_FIELD_TYPE_TIME_T: - val = mu_msg_iter_get_field_numeric (iter, mfid); + val = mu_msg_get_field_numeric (msg, mfid); return mu_str_date_s ("%c", (time_t)val); case MU_MSG_FIELD_TYPE_BYTESIZE: - val = mu_msg_iter_get_field_numeric (iter, mfid); + val = mu_msg_get_field_numeric (msg, mfid); return mu_str_size_s ((unsigned)val); default: g_return_val_if_reached (NULL); @@ -176,7 +187,7 @@ print_summary (MuMsgIter *iter, size_t summary_len) return; /* nothing to do */ err = NULL; - msg = mu_msg_iter_get_msg (iter, &err); + msg = mu_msg_iter_get_msg (iter, &err); /* don't unref */ if (!msg) { g_warning ("error get message: %s", err->message); g_error_free (err); @@ -186,8 +197,6 @@ print_summary (MuMsgIter *iter, size_t summary_len) summ = mu_str_summarize (mu_msg_get_body_text(msg), summary_len); g_print ("Summary: %s\n", summ ? summ : ""); g_free (summ); - - mu_msg_unref (msg); } @@ -236,7 +245,7 @@ print_attr_xml (const char* elm, const char *str) { gchar *esc; - if (!str || strlen(str) == 0) + if (mu_str_is_empty(str)) return; /* empty: don't include */ esc = g_markup_escape_text (str, -1); @@ -257,18 +266,25 @@ mu_output_xml (MuMsgIter *iter, size_t *count) for (myiter = iter, mycount = 0; !mu_msg_iter_is_done (myiter); mu_msg_iter_next (myiter), ++mycount) { + + MuMsg *msg; + + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + if (!msg) + return FALSE; + g_print ("\t\n"); - print_attr_xml ("from", mu_msg_iter_get_from (iter)); - print_attr_xml ("to", mu_msg_iter_get_to (iter)); - print_attr_xml ("cc", mu_msg_iter_get_cc (iter)); - print_attr_xml ("subject", mu_msg_iter_get_subject (iter)); + print_attr_xml ("from", mu_msg_get_from (msg)); + print_attr_xml ("to", mu_msg_get_to (msg)); + print_attr_xml ("cc", mu_msg_get_cc (msg)); + print_attr_xml ("subject", mu_msg_get_subject (msg)); g_print ("\t\t%u\n", - (unsigned) mu_msg_iter_get_date (iter)); + (unsigned) mu_msg_get_date (msg)); g_print ("\t\t%u\n", - (unsigned) mu_msg_iter_get_size (iter)); - print_attr_xml ("msgid", mu_msg_iter_get_msgid (iter)); - print_attr_xml ("path", mu_msg_iter_get_path (iter)); - print_attr_xml ("maildir", mu_msg_iter_get_maildir (iter)); + (unsigned) mu_msg_get_size (msg)); + print_attr_xml ("msgid", mu_msg_get_msgid (msg)); + print_attr_xml ("path", mu_msg_get_path (msg)); + print_attr_xml ("maildir", mu_msg_get_maildir (msg)); g_print ("\t\n"); } @@ -308,22 +324,28 @@ mu_output_json (MuMsgIter *iter, size_t *count) for (myiter = iter, mycount = 0; !mu_msg_iter_is_done (myiter); mu_msg_iter_next (myiter), ++mycount) { + MuMsg *msg; + if (mycount != 0) g_print (",\n"); - + + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + if (!msg) + return FALSE; + g_print ("\t\t{\n"); - print_attr_json ("from", mu_msg_iter_get_from (iter), TRUE); - print_attr_json ("to", mu_msg_iter_get_to (iter),TRUE); - print_attr_json ("cc", mu_msg_iter_get_cc (iter),TRUE); - print_attr_json ("subject", mu_msg_iter_get_subject (iter), + print_attr_json ("from", mu_msg_get_from (msg), TRUE); + print_attr_json ("to", mu_msg_get_to (msg),TRUE); + print_attr_json ("cc", mu_msg_get_cc (msg),TRUE); + print_attr_json ("subject", mu_msg_get_subject (msg), TRUE); g_print ("\t\t\t\"date\":%u,\n", - (unsigned) mu_msg_iter_get_date (iter)); + (unsigned) mu_msg_get_date (msg)); g_print ("\t\t\t\"size\":%u,\n", - (unsigned) mu_msg_iter_get_size (iter)); - print_attr_json ("msgid", mu_msg_iter_get_msgid (iter),TRUE); - print_attr_json ("path", mu_msg_iter_get_path (iter),TRUE); - print_attr_json ("maildir", mu_msg_iter_get_maildir (iter), + (unsigned) mu_msg_get_size (msg)); + print_attr_json ("msgid", mu_msg_get_msgid (msg),TRUE); + print_attr_json ("path", mu_msg_get_path (msg),TRUE); + print_attr_json ("maildir", mu_msg_get_maildir (msg), FALSE); g_print ("\t\t}"); } @@ -364,21 +386,27 @@ mu_output_sexp (MuMsgIter *iter, size_t *count) for (myiter = iter, mycount = 0; !mu_msg_iter_is_done (myiter); mu_msg_iter_next (myiter), ++mycount) { + MuMsg *msg; + if (mycount != 0) g_print ("\n"); + + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + if (!msg) + return FALSE; g_print (" (:message\n"); - print_attr_sexp ("from", mu_msg_iter_get_from (iter),TRUE); - print_attr_sexp ("to", mu_msg_iter_get_to (iter),TRUE); - print_attr_sexp ("cc", mu_msg_iter_get_cc (iter),TRUE); - print_attr_sexp ("subject", mu_msg_iter_get_subject (iter),TRUE); + print_attr_sexp ("from", mu_msg_get_from (msg),TRUE); + print_attr_sexp ("to", mu_msg_get_to (msg),TRUE); + print_attr_sexp ("cc", mu_msg_get_cc (msg),TRUE); + print_attr_sexp ("subject", mu_msg_get_subject (msg),TRUE); g_print (" (:date %u)\n", - (unsigned) mu_msg_iter_get_date (iter)); + (unsigned) mu_msg_get_date (msg)); g_print (" (:size %u)\n", - (unsigned) mu_msg_iter_get_size (iter)); - print_attr_sexp ("msgid", mu_msg_iter_get_msgid (iter),TRUE); - print_attr_sexp ("path", mu_msg_iter_get_path (iter),TRUE); - print_attr_sexp ("maildir", mu_msg_iter_get_maildir (iter),FALSE); + (unsigned) mu_msg_get_size (msg)); + print_attr_sexp ("msgid", mu_msg_get_msgid (msg),TRUE); + print_attr_sexp ("path", mu_msg_get_path (msg),TRUE); + print_attr_sexp ("maildir", mu_msg_get_maildir (msg),FALSE); g_print (")"); } g_print (")\n"); diff --git a/src/tests/test-mu-query.c b/src/tests/test-mu-query.c index a501e00a..94fd850b 100644 --- a/src/tests/test-mu-query.c +++ b/src/tests/test-mu-query.c @@ -221,7 +221,7 @@ test_mu_query_05 (void) iter = mu_query_run (query, "fünkÿ", MU_MSG_FIELD_ID_NONE, FALSE, 1, NULL); err = NULL; - msg = mu_msg_iter_get_msg (iter, &err); + msg = mu_msg_iter_get_msg (iter, &err); /* don't unref */ if (!msg) { g_warning ("error getting message: %s", err->message); g_error_free (err); @@ -236,14 +236,11 @@ test_mu_query_05 (void) g_assert_cmpstr (summ,==, "Let's write some fünkÿ text using umlauts. Foo."); g_free (summ); - mu_msg_unref (msg); mu_msg_iter_destroy (iter); mu_query_destroy (query); g_free (xpath); } - - static void test_mu_query_06 (void) { diff --git a/toys/mug/mug-msg-list-view.c b/toys/mug/mug-msg-list-view.c index 9239e9ff..9296baec 100644 --- a/toys/mug/mug-msg-list-view.c +++ b/toys/mug/mug-msg-list-view.c @@ -350,30 +350,30 @@ run_query (const char *xpath, const char *query, MugMsgListView * self) } static void -add_row (GtkListStore * store, MuMsgIter * iter) +add_row (GtkListStore * store, MuMsg *msg) { GtkTreeIter treeiter; const gchar *datestr, *flagstr; gchar *from, *to; time_t timeval; - timeval = mu_msg_iter_get_date (iter); + timeval = mu_msg_get_date (msg); datestr = timeval == 0 ? "-" : mu_str_display_date_s (timeval); - from = empty_or_display_contact (mu_msg_iter_get_from (iter)); - to = empty_or_display_contact (mu_msg_iter_get_to (iter)); - flagstr = mu_msg_flags_str_s (mu_msg_iter_get_flags (iter)); + from = empty_or_display_contact (mu_msg_get_from (msg)); + to = empty_or_display_contact (mu_msg_get_to (msg)); + flagstr = mu_msg_flags_str_s (mu_msg_get_flags (msg)); gtk_list_store_append (store, &treeiter); gtk_list_store_set (store, &treeiter, MUG_COL_DATESTR, datestr, - MUG_COL_MAILDIR, mu_msg_iter_get_maildir (iter), + MUG_COL_MAILDIR, mu_msg_get_maildir (msg), MUG_COL_FLAGSSTR, flagstr, MUG_COL_FROM, from, MUG_COL_TO, to, - MUG_COL_SUBJECT, mu_msg_iter_get_subject (iter), - MUG_COL_PATH, mu_msg_iter_get_path (iter), - MUG_COL_PRIO, mu_msg_iter_get_prio (iter), - MUG_COL_FLAGS, mu_msg_iter_get_flags (iter), + MUG_COL_SUBJECT, mu_msg_get_subject (msg), + MUG_COL_PATH, mu_msg_get_path (msg), + MUG_COL_PRIO, mu_msg_get_prio (msg), + MUG_COL_FLAGS, mu_msg_get_flags (msg), MUG_COL_TIME, timeval, -1); g_free (from); g_free (to); @@ -393,8 +393,11 @@ update_model (GtkListStore * store, const char *xpath, const char *query, } for (count = 0; !mu_msg_iter_is_done (iter); - mu_msg_iter_next (iter), ++count) - add_row (store, iter); + mu_msg_iter_next (iter), ++count) { + MuMsg *msg; + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + add_row (store, msg); + } mu_msg_iter_destroy (iter); diff --git a/toys/mug2/mug-msg-list-view.c b/toys/mug2/mug-msg-list-view.c index 20c92ae7..f05e9b95 100644 --- a/toys/mug2/mug-msg-list-view.c +++ b/toys/mug2/mug-msg-list-view.c @@ -350,30 +350,30 @@ run_query (const char *xpath, const char *query, MugMsgListView * self) } static void -add_row (GtkListStore * store, MuMsgIter * iter) +add_row (GtkListStore * store, MuMsg *msg) { GtkTreeIter treeiter; const gchar *datestr, *flagstr; gchar *from, *to; time_t timeval; - timeval = mu_msg_iter_get_date (iter); + timeval = mu_msg_get_date (msg); datestr = timeval == 0 ? "-" : mu_str_display_date_s (timeval); - from = empty_or_display_contact (mu_msg_iter_get_from (iter)); - to = empty_or_display_contact (mu_msg_iter_get_to (iter)); - flagstr = mu_msg_flags_str_s (mu_msg_iter_get_flags (iter)); + from = empty_or_display_contact (mu_msg_get_from (msg)); + to = empty_or_display_contact (mu_msg_get_to (msg)); + flagstr = mu_msg_flags_str_s (mu_msg_get_flags (msg)); gtk_list_store_append (store, &treeiter); gtk_list_store_set (store, &treeiter, MUG_COL_DATESTR, datestr, - MUG_COL_MAILDIR, mu_msg_iter_get_maildir (iter), + MUG_COL_MAILDIR, mu_msg_get_maildir (msg), MUG_COL_FLAGSSTR, flagstr, MUG_COL_FROM, from, MUG_COL_TO, to, - MUG_COL_SUBJECT, mu_msg_iter_get_subject (iter), - MUG_COL_PATH, mu_msg_iter_get_path (iter), - MUG_COL_PRIO, mu_msg_iter_get_prio (iter), - MUG_COL_FLAGS, mu_msg_iter_get_flags (iter), + MUG_COL_SUBJECT, mu_msg_get_subject (msg), + MUG_COL_PATH, mu_msg_get_path (msg), + MUG_COL_PRIO, mu_msg_get_prio (msg), + MUG_COL_FLAGS, mu_msg_get_flags (msg), MUG_COL_TIME, timeval, -1); g_free (from); g_free (to); @@ -394,11 +394,9 @@ update_model (GtkListStore * store, const char *xpath, const char *query, for (count = 0; !mu_msg_iter_is_done (iter); mu_msg_iter_next (iter), ++count) { - - add_row (store, iter); - - if (count % 50 == 0) - gtk_main_iteration (); + MuMsg *msg; + msg = mu_msg_iter_get_msg (iter, NULL); /* don't unref */ + add_row (store, msg); } mu_msg_iter_destroy (iter);