X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=549bfbd03d26585f2c2170dbd0cfaf335f01fa69;hp=e29444268416a1d56d2071bf0d10af56ef7db363;hb=81d949c4ed42a31732c189d6274434b62251fba9;hpb=ef4b0de9684e73696469b8154adbfcb3605e620c diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index e294442..549bfbd 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -35,6 +35,10 @@ #include #include +#include + +#define _FM(str) dgettext("hildon-fm",str) +#define _CS(str) dgettext("hildon-common-strings",str) /** * modest_text_utils_derived_subject: @@ -56,7 +60,9 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, * @text: a non-NULL string which contains the message to quote * @from: a non-NULL sender of the original message * @content_type: the non-NULL content type for the quoting, e.g. "text/html" + * @signature: NULL or the signature to add * @sent_date: sent date/time of the original message + * @attachments: a #GList of the attachments * @limit: specifies the maximum characters per line in the quoted text * * quote an existing message @@ -65,8 +71,10 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, */ gchar* modest_text_utils_quote (const gchar *text, const gchar *content_type, + const gchar *signature, const gchar *from, const time_t sent_date, + GList *attachments, int limit); @@ -82,6 +90,7 @@ gchar* modest_text_utils_quote (const gchar *text, */ gchar* modest_text_utils_cite (const gchar *text, const gchar *content_type, + const gchar *signature, const gchar *from, time_t sent_date); @@ -100,6 +109,7 @@ gchar* modest_text_utils_cite (const gchar *text, */ gchar* modest_text_utils_inline (const gchar *text, const gchar *content_type, + const gchar *signature, const gchar *from, time_t sent_date, const gchar *to, @@ -120,8 +130,26 @@ gchar* modest_text_utils_remove_address (const gchar *address_list, const gchar *address); /** + * modest_text_utils_address_range_at_position: + * @address_list: utf8 string containing a list of addresses + * @position: a gint + * @start: a gint pointer + * @end: a gint pointer + * + * Finds the start and end positions of the address at @position, + * in @recipients_list, a list of addresses in the format of a + * recipient list in email. It stores the results in @start and + * @end + */ +void modest_text_utils_address_range_at_position (const gchar *recipients_list, + gint position, + gint *start, + gint *end); + + +/** * modest_text_utils_convert_to_html: - * @txt: a string which contains the message to quote + * @txt: a string * * convert plain text (utf8) into html * @@ -129,20 +157,30 @@ gchar* modest_text_utils_remove_address (const gchar *address_list, */ gchar* modest_text_utils_convert_to_html (const gchar *txt); +/** + * modest_text_utils_convert_to_html_body: + * @txt: a string + * + * convert plain text (utf8) into html without adding html headers. + * + * Returns: a newly allocated string containing the html + */ +gchar* modest_text_utils_convert_to_html_body (const gchar *data); + /** * modest_text_utils_strftime: * @s: * @max: * @fmt: - * @tm + * @timet: * * this is just an alias for strftime(3), so we can use that without * getting warning from gcc * * Returns: a formatted string of max length @max in @s */ -size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const struct tm *tm); +size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet); @@ -155,8 +193,11 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const * ie. removes "<...>" and "(...)" parts * the change is in-place; removes leading/trailing whitespace * - * Returns: the new address. The string is *not* newly allocated. - * NULL in case of error + * Returns: the new address of the string; this new string + * is _NOT_ newly allocated, so should not be freed. (remember + * the old address of the parameter if that one needs to be freed) + * + * NULL in case of error or if address == NULL */ gchar* modest_text_utils_get_display_address (gchar *address); @@ -193,22 +234,86 @@ gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean i * * get a string representation for a date. * + * Returns: the new display date, as a newly allocated string; + * free with g_free + */ +gchar* modest_text_utils_get_display_date (time_t date); + + +/** + * modest_text_utils_get_display_size: + * @size: size in bytes + * + * get a string representation for a size in bytes. * - * Returns: the new display date. The string is *not* newly allocated, - * but is a static buffer (for optimization reasons). Therefore, when - * you call this function, you will loose the data. + * Returns: the newly allocated display string for the + * size in bytes. must be freed. */ -const gchar* modest_text_utils_get_display_date (time_t date); +gchar * modest_text_utils_get_display_size (guint64 size); /** * modest_text_utils_validate_email_address: * @email_address: a string + * @invalid_char_position: pointer to the position of the invalid + * character in case validation failed because of this, or %NULL. * * validates the email address passed as argument * * Returns: TRUE if the address is valid, FALSE otherwise **/ -gboolean modest_text_utils_validate_email_address (const gchar *email_address); +gboolean modest_text_utils_validate_email_address (const gchar *email_address, + const gchar **invalid_char_position); + +/** + * modest_text_utils_validate_recipient: + * @recipient: a string + * @invalid_char_position: pointer to the position of the invalid char, + * if validation failed because there's an invalid char there, or %NULL. + * + * validates @recipient as a valid recipient field for header. + * It's different from modest_text_utils_validate_email_address() + * as it validates a whole recipient, and not only the part between + * the < and > symbols. + * + * Returns: %TRUE if the recipient is valid, FALSE otherwise + **/ +gboolean modest_text_utils_validate_recipient (const gchar *recipient, + const gchar **invalid_char_position); + +/** + * modest_text_utils_split_addresses_list: + * @addresses: a string + * + * obtains a GSList of addresses from a string of addresses + * in the format understood by email protocols + * + * Returns: a GSList of strings + **/ +GSList *modest_text_utils_split_addresses_list (const gchar *addresses); + +/** + * modest_text_utils_get_addresses_indexes: + * @addresses: a string + * @start_indexes: a #GSList pointer + * @end_indexes: a #GSList pointer + * + * obtains two #GSList of @addresses with the range offsets of the addresses in + * the string + * + * Returns: a GSList of strings + **/ +void modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes); + +/** + * modest_text_utils_get_color_string: + * @color: a #GdkColor + * + * Obtains a proper markup string for @color, in the format used + * by Pango and HTML. + * + * Returns: a newly allocated string + */ +gchar * modest_text_utils_get_color_string (GdkColor *color); #endif /* __MODEST_TEXT_UTILS_H__ */